Amazonka.WorkMail.DeleteUser

Deletes a user from WorkMail and all subsequent systems. Before you can delete a user, the user state must be DISABLED. Use the DescribeUser action to confirm the user state.

Deleting a user is permanent and cannot be undone. WorkMail archives user mailboxes for 30 days before they are permanently removed.

Creating a Request

data DeleteUser

See: newDeleteUser smart constructor.

Constructors

DeleteUser'

Fields

• organizationId :: Text

  The organization that contains the user to be deleted.

• userId :: Text

  The identifier of the user to be deleted.

Instances

ToJSON DeleteUser

Defined in Amazonka.WorkMail.DeleteUser

Methods

toJSON :: DeleteUser -> Value

toEncoding :: DeleteUser -> Encoding

toJSONList :: [DeleteUser] -> Value

toEncodingList :: [DeleteUser] -> Encoding

ToHeaders DeleteUser

Defined in Amazonka.WorkMail.DeleteUser

Methods

toHeaders :: DeleteUser -> [Header]

ToPath DeleteUser

Defined in Amazonka.WorkMail.DeleteUser

Methods

toPath :: DeleteUser -> ByteString

ToQuery DeleteUser

Defined in Amazonka.WorkMail.DeleteUser

Methods

toQuery :: DeleteUser -> QueryString

AWSRequest DeleteUser

Defined in Amazonka.WorkMail.DeleteUser

Associated Types

type AWSResponse DeleteUser

Methods

request :: (Service -> Service) -> DeleteUser -> Request DeleteUser

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DeleteUser -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DeleteUser)))

Generic DeleteUser

Defined in Amazonka.WorkMail.DeleteUser

Associated Types

type Rep DeleteUser :: Type -> Type

Methods

from :: DeleteUser -> Rep DeleteUser x

to :: Rep DeleteUser x -> DeleteUser

Read DeleteUser

Defined in Amazonka.WorkMail.DeleteUser

Methods

readsPrec :: Int -> ReadS DeleteUser

readList :: ReadS [DeleteUser]

readPrec :: ReadPrec DeleteUser

readListPrec :: ReadPrec [DeleteUser]

Show DeleteUser

Defined in Amazonka.WorkMail.DeleteUser

Methods

showsPrec :: Int -> DeleteUser -> ShowS

show :: DeleteUser -> String

showList :: [DeleteUser] -> ShowS

NFData DeleteUser

Defined in Amazonka.WorkMail.DeleteUser

Methods

rnf :: DeleteUser -> ()

Eq DeleteUser

Defined in Amazonka.WorkMail.DeleteUser

Methods

(==) :: DeleteUser -> DeleteUser -> Bool

(/=) :: DeleteUser -> DeleteUser -> Bool

Hashable DeleteUser

Defined in Amazonka.WorkMail.DeleteUser

Methods

hashWithSalt :: Int -> DeleteUser -> Int

hash :: DeleteUser -> Int

type AWSResponse DeleteUser

Defined in Amazonka.WorkMail.DeleteUser

type AWSResponse DeleteUser = DeleteUserResponse

type Rep DeleteUser

Defined in Amazonka.WorkMail.DeleteUser

type Rep DeleteUser = D1 ('MetaData "DeleteUser" "Amazonka.WorkMail.DeleteUser" "amazonka-workmail-2.0-6w5uOhF45UX4mlfLHLnG5b" 'False) (C1 ('MetaCons "DeleteUser'" 'PrefixI 'True) (S1 ('MetaSel ('Just "organizationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "userId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDeleteUser

Arguments

:: Text

DeleteUser

-> Text

DeleteUser

-> DeleteUser

Create a value of DeleteUser with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

DeleteUser, deleteUser_organizationId - The organization that contains the user to be deleted.

DeleteUser, deleteUser_userId - The identifier of the user to be deleted.

Request Lenses

deleteUser_organizationId :: Lens' DeleteUser Text

The organization that contains the user to be deleted.

deleteUser_userId :: Lens' DeleteUser Text

The identifier of the user to be deleted.

Destructuring the Response

data DeleteUserResponse

See: newDeleteUserResponse smart constructor.

Constructors

DeleteUserResponse'

Fields

• httpStatus :: Int

  The response's http status code.

Instances

Generic DeleteUserResponse

Defined in Amazonka.WorkMail.DeleteUser

Associated Types

type Rep DeleteUserResponse :: Type -> Type

Methods

from :: DeleteUserResponse -> Rep DeleteUserResponse x

to :: Rep DeleteUserResponse x -> DeleteUserResponse

Read DeleteUserResponse

Defined in Amazonka.WorkMail.DeleteUser

Methods

readsPrec :: Int -> ReadS DeleteUserResponse

readList :: ReadS [DeleteUserResponse]

readPrec :: ReadPrec DeleteUserResponse

readListPrec :: ReadPrec [DeleteUserResponse]

Show DeleteUserResponse

Defined in Amazonka.WorkMail.DeleteUser

Methods

showsPrec :: Int -> DeleteUserResponse -> ShowS

show :: DeleteUserResponse -> String

showList :: [DeleteUserResponse] -> ShowS

NFData DeleteUserResponse

Defined in Amazonka.WorkMail.DeleteUser

Methods

rnf :: DeleteUserResponse -> ()

Eq DeleteUserResponse

Defined in Amazonka.WorkMail.DeleteUser

Methods

(==) :: DeleteUserResponse -> DeleteUserResponse -> Bool

(/=) :: DeleteUserResponse -> DeleteUserResponse -> Bool

type Rep DeleteUserResponse

Defined in Amazonka.WorkMail.DeleteUser

type Rep DeleteUserResponse = D1 ('MetaData "DeleteUserResponse" "Amazonka.WorkMail.DeleteUser" "amazonka-workmail-2.0-6w5uOhF45UX4mlfLHLnG5b" 'False) (C1 ('MetaCons "DeleteUserResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newDeleteUserResponse

Arguments

:: Int

$sel:httpStatus:DeleteUserResponse'

-> DeleteUserResponse

Create a value of DeleteUserResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:httpStatus:DeleteUserResponse', deleteUserResponse_httpStatus - The response's http status code.

Response Lenses

deleteUserResponse_httpStatus :: Lens' DeleteUserResponse Int

The response's http status code.