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.CognitoIdentityProvider.AdminDeleteUser

Contents

Creating a Request
Request Lenses
Destructuring the Response

Description

Deletes a user as an administrator. Works on any user.

Calling this action requires developer credentials.

Synopsis

Creating a Request

data AdminDeleteUser Source #

Represents the request to delete a user as an administrator.

See: newAdminDeleteUser smart constructor.

Constructors

AdminDeleteUser'
Fields userPoolId :: Text The user pool ID for the user pool where you want to delete the user. username :: Sensitive Text The user name of the user you wish to delete.

Instances

Instances details

Eq AdminDeleteUser Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.AdminDeleteUser Methods (==) :: AdminDeleteUser -> AdminDeleteUser -> Bool # (/=) :: AdminDeleteUser -> AdminDeleteUser -> Bool #
Show AdminDeleteUser Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.AdminDeleteUser Methods showsPrec :: Int -> AdminDeleteUser -> ShowS # show :: AdminDeleteUser -> String # showList :: [AdminDeleteUser] -> ShowS #
Generic AdminDeleteUser Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.AdminDeleteUser Associated Types type Rep AdminDeleteUser :: Type -> Type # Methods from :: AdminDeleteUser -> Rep AdminDeleteUser x # to :: Rep AdminDeleteUser x -> AdminDeleteUser #
NFData AdminDeleteUser Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.AdminDeleteUser Methods rnf :: AdminDeleteUser -> () #
Hashable AdminDeleteUser Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.AdminDeleteUser Methods hashWithSalt :: Int -> AdminDeleteUser -> Int # hash :: AdminDeleteUser -> Int #
ToJSON AdminDeleteUser Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.AdminDeleteUser Methods toJSON :: AdminDeleteUser -> Value # toEncoding :: AdminDeleteUser -> Encoding # toJSONList :: [AdminDeleteUser] -> Value # toEncodingList :: [AdminDeleteUser] -> Encoding #
AWSRequest AdminDeleteUser Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.AdminDeleteUser Associated Types type AWSResponse AdminDeleteUser # Methods request :: AdminDeleteUser -> Request AdminDeleteUser # response :: MonadResource m => Logger -> Service -> Proxy AdminDeleteUser -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse AdminDeleteUser))) #
ToHeaders AdminDeleteUser Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.AdminDeleteUser Methods toHeaders :: AdminDeleteUser -> [Header] #
ToPath AdminDeleteUser Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.AdminDeleteUser Methods toPath :: AdminDeleteUser -> ByteString #
ToQuery AdminDeleteUser Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.AdminDeleteUser Methods toQuery :: AdminDeleteUser -> QueryString #
type Rep AdminDeleteUser Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.AdminDeleteUser type Rep AdminDeleteUser = D1 ('MetaData "AdminDeleteUser" "Amazonka.CognitoIdentityProvider.AdminDeleteUser" "libZSservicesZSamazonka-cognito-idpZSamazonka-cognito-idp" 'False) (C1 ('MetaCons "AdminDeleteUser'" 'PrefixI 'True) (S1 ('MetaSel ('Just "userPoolId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "username") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive Text))))
type AWSResponse AdminDeleteUser Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.AdminDeleteUser type AWSResponse AdminDeleteUser = AdminDeleteUserResponse

newAdminDeleteUser Source #

Arguments

:: Text	`$sel:userPoolId:AdminDeleteUser'`
-> Text	`$sel:username:AdminDeleteUser'`
-> AdminDeleteUser

Create a value of AdminDeleteUser 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:userPoolId:AdminDeleteUser', adminDeleteUser_userPoolId - The user pool ID for the user pool where you want to delete the user.

$sel:username:AdminDeleteUser', adminDeleteUser_username - The user name of the user you wish to delete.

Request Lenses

adminDeleteUser_userPoolId :: Lens' AdminDeleteUser Text Source #

The user pool ID for the user pool where you want to delete the user.

adminDeleteUser_username :: Lens' AdminDeleteUser Text Source #

The user name of the user you wish to delete.

Destructuring the Response

data AdminDeleteUserResponse Source #

See: newAdminDeleteUserResponse smart constructor.

Constructors

AdminDeleteUserResponse'

Instances

Instances details

Eq AdminDeleteUserResponse Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.AdminDeleteUser Methods (==) :: AdminDeleteUserResponse -> AdminDeleteUserResponse -> Bool # (/=) :: AdminDeleteUserResponse -> AdminDeleteUserResponse -> Bool #
Read AdminDeleteUserResponse Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.AdminDeleteUser Methods readsPrec :: Int -> ReadS AdminDeleteUserResponse # readList :: ReadS [AdminDeleteUserResponse] # readPrec :: ReadPrec AdminDeleteUserResponse # readListPrec :: ReadPrec [AdminDeleteUserResponse] #
Show AdminDeleteUserResponse Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.AdminDeleteUser Methods showsPrec :: Int -> AdminDeleteUserResponse -> ShowS # show :: AdminDeleteUserResponse -> String # showList :: [AdminDeleteUserResponse] -> ShowS #
Generic AdminDeleteUserResponse Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.AdminDeleteUser Associated Types type Rep AdminDeleteUserResponse :: Type -> Type # Methods from :: AdminDeleteUserResponse -> Rep AdminDeleteUserResponse x # to :: Rep AdminDeleteUserResponse x -> AdminDeleteUserResponse #
NFData AdminDeleteUserResponse Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.AdminDeleteUser Methods rnf :: AdminDeleteUserResponse -> () #
type Rep AdminDeleteUserResponse Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.AdminDeleteUser type Rep AdminDeleteUserResponse = D1 ('MetaData "AdminDeleteUserResponse" "Amazonka.CognitoIdentityProvider.AdminDeleteUser" "libZSservicesZSamazonka-cognito-idpZSamazonka-cognito-idp" 'False) (C1 ('MetaCons "AdminDeleteUserResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newAdminDeleteUserResponse :: AdminDeleteUserResponse Source #

Create a value of AdminDeleteUserResponse with all optional fields omitted.

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