Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.WorkMail.DeleteUser

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Deletes a user from Amazon 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.

Synopsis

data DeleteUser = DeleteUser' {
- organizationId :: Text
- userId :: Text
}
newDeleteUser :: Text -> Text -> DeleteUser
deleteUser_organizationId :: Lens' DeleteUser Text
deleteUser_userId :: Lens' DeleteUser Text
data DeleteUserResponse = DeleteUserResponse' {
- httpStatus :: Int
}
newDeleteUserResponse :: Int -> DeleteUserResponse
deleteUserResponse_httpStatus :: Lens' DeleteUserResponse Int

Creating a Request

data DeleteUser Source #

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

Instances details

Eq DeleteUser Source #
Instance details Defined in Amazonka.WorkMail.DeleteUser Methods (==) :: DeleteUser -> DeleteUser -> Bool # (/=) :: DeleteUser -> DeleteUser -> Bool #
Read DeleteUser Source #
Instance details Defined in Amazonka.WorkMail.DeleteUser Methods readsPrec :: Int -> ReadS DeleteUser # readList :: ReadS [DeleteUser] # readPrec :: ReadPrec DeleteUser # readListPrec :: ReadPrec [DeleteUser] #
Show DeleteUser Source #
Instance details Defined in Amazonka.WorkMail.DeleteUser Methods showsPrec :: Int -> DeleteUser -> ShowS # show :: DeleteUser -> String # showList :: [DeleteUser] -> ShowS #
Generic DeleteUser Source #
Instance details Defined in Amazonka.WorkMail.DeleteUser Associated Types type Rep DeleteUser :: Type -> Type # Methods from :: DeleteUser -> Rep DeleteUser x # to :: Rep DeleteUser x -> DeleteUser #
NFData DeleteUser Source #
Instance details Defined in Amazonka.WorkMail.DeleteUser Methods rnf :: DeleteUser -> () #
Hashable DeleteUser Source #
Instance details Defined in Amazonka.WorkMail.DeleteUser Methods hashWithSalt :: Int -> DeleteUser -> Int # hash :: DeleteUser -> Int #
ToJSON DeleteUser Source #
Instance details Defined in Amazonka.WorkMail.DeleteUser Methods toJSON :: DeleteUser -> Value # toEncoding :: DeleteUser -> Encoding # toJSONList :: [DeleteUser] -> Value # toEncodingList :: [DeleteUser] -> Encoding #
AWSRequest DeleteUser Source #
Instance details Defined in Amazonka.WorkMail.DeleteUser Associated Types type AWSResponse DeleteUser # Methods request :: DeleteUser -> Request DeleteUser # response :: MonadResource m => Logger -> Service -> Proxy DeleteUser -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DeleteUser))) #
ToHeaders DeleteUser Source #
Instance details Defined in Amazonka.WorkMail.DeleteUser Methods toHeaders :: DeleteUser -> [Header] #
ToPath DeleteUser Source #
Instance details Defined in Amazonka.WorkMail.DeleteUser Methods toPath :: DeleteUser -> ByteString #
ToQuery DeleteUser Source #
Instance details Defined in Amazonka.WorkMail.DeleteUser Methods toQuery :: DeleteUser -> QueryString #
type Rep DeleteUser Source #
Instance details Defined in Amazonka.WorkMail.DeleteUser type Rep DeleteUser = D1 ('MetaData "DeleteUser" "Amazonka.WorkMail.DeleteUser" "libZSservicesZSamazonka-workmailZSamazonka-workmail" 'False) (C1 ('MetaCons "DeleteUser'" 'PrefixI 'True) (S1 ('MetaSel ('Just "organizationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "userId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse DeleteUser Source #
Instance details Defined in Amazonka.WorkMail.DeleteUser type AWSResponse DeleteUser = DeleteUserResponse

newDeleteUser Source #

Arguments

:: Text	`$sel:organizationId:DeleteUser'`
-> Text	`$sel:userId: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:

$sel:organizationId:DeleteUser', deleteUser_organizationId - The organization that contains the user to be deleted.

$sel:userId:DeleteUser', deleteUser_userId - The identifier of the user to be deleted.

Request Lenses

deleteUser_organizationId :: Lens' DeleteUser Text Source #

The organization that contains the user to be deleted.

deleteUser_userId :: Lens' DeleteUser Text Source #

The identifier of the user to be deleted.

Destructuring the Response

data DeleteUserResponse Source #

See: newDeleteUserResponse smart constructor.

Constructors

DeleteUserResponse'
Fields httpStatus :: Int The response's http status code.

Instances

Instances details

Eq DeleteUserResponse Source #
Instance details Defined in Amazonka.WorkMail.DeleteUser Methods (==) :: DeleteUserResponse -> DeleteUserResponse -> Bool # (/=) :: DeleteUserResponse -> DeleteUserResponse -> Bool #
Read DeleteUserResponse Source #
Instance details Defined in Amazonka.WorkMail.DeleteUser Methods readsPrec :: Int -> ReadS DeleteUserResponse # readList :: ReadS [DeleteUserResponse] # readPrec :: ReadPrec DeleteUserResponse # readListPrec :: ReadPrec [DeleteUserResponse] #
Show DeleteUserResponse Source #
Instance details Defined in Amazonka.WorkMail.DeleteUser Methods showsPrec :: Int -> DeleteUserResponse -> ShowS # show :: DeleteUserResponse -> String # showList :: [DeleteUserResponse] -> ShowS #
Generic DeleteUserResponse Source #
Instance details Defined in Amazonka.WorkMail.DeleteUser Associated Types type Rep DeleteUserResponse :: Type -> Type # Methods from :: DeleteUserResponse -> Rep DeleteUserResponse x # to :: Rep DeleteUserResponse x -> DeleteUserResponse #
NFData DeleteUserResponse Source #
Instance details Defined in Amazonka.WorkMail.DeleteUser Methods rnf :: DeleteUserResponse -> () #
type Rep DeleteUserResponse Source #
Instance details Defined in Amazonka.WorkMail.DeleteUser type Rep DeleteUserResponse = D1 ('MetaData "DeleteUserResponse" "Amazonka.WorkMail.DeleteUser" "libZSservicesZSamazonka-workmailZSamazonka-workmail" 'False) (C1 ('MetaCons "DeleteUserResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newDeleteUserResponse Source #

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 Source #

The response's http status code.