Amazonka.CognitoIdentityProvider.AdminDeleteUser

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

Calling this action requires developer credentials.

Creating a Request

data AdminDeleteUser

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 want to delete.

Instances

ToJSON AdminDeleteUser

Defined in Amazonka.CognitoIdentityProvider.AdminDeleteUser

Methods

toJSON :: AdminDeleteUser -> Value

toEncoding :: AdminDeleteUser -> Encoding

toJSONList :: [AdminDeleteUser] -> Value

toEncodingList :: [AdminDeleteUser] -> Encoding

ToHeaders AdminDeleteUser

Defined in Amazonka.CognitoIdentityProvider.AdminDeleteUser

Methods

toHeaders :: AdminDeleteUser -> [Header]

ToPath AdminDeleteUser

Defined in Amazonka.CognitoIdentityProvider.AdminDeleteUser

Methods

toPath :: AdminDeleteUser -> ByteString

ToQuery AdminDeleteUser

Defined in Amazonka.CognitoIdentityProvider.AdminDeleteUser

Methods

toQuery :: AdminDeleteUser -> QueryString

AWSRequest AdminDeleteUser

Defined in Amazonka.CognitoIdentityProvider.AdminDeleteUser

Associated Types

type AWSResponse AdminDeleteUser

Methods

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

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

Generic AdminDeleteUser

Defined in Amazonka.CognitoIdentityProvider.AdminDeleteUser

Associated Types

type Rep AdminDeleteUser :: Type -> Type

Methods

from :: AdminDeleteUser -> Rep AdminDeleteUser x

to :: Rep AdminDeleteUser x -> AdminDeleteUser

Show AdminDeleteUser

Defined in Amazonka.CognitoIdentityProvider.AdminDeleteUser

Methods

showsPrec :: Int -> AdminDeleteUser -> ShowS

show :: AdminDeleteUser -> String

showList :: [AdminDeleteUser] -> ShowS

NFData AdminDeleteUser

Defined in Amazonka.CognitoIdentityProvider.AdminDeleteUser

Methods

rnf :: AdminDeleteUser -> ()

Eq AdminDeleteUser

Defined in Amazonka.CognitoIdentityProvider.AdminDeleteUser

Methods

(==) :: AdminDeleteUser -> AdminDeleteUser -> Bool

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

Hashable AdminDeleteUser

Defined in Amazonka.CognitoIdentityProvider.AdminDeleteUser

Methods

hashWithSalt :: Int -> AdminDeleteUser -> Int

hash :: AdminDeleteUser -> Int

type AWSResponse AdminDeleteUser

Defined in Amazonka.CognitoIdentityProvider.AdminDeleteUser

type AWSResponse AdminDeleteUser = AdminDeleteUserResponse

type Rep AdminDeleteUser

Defined in Amazonka.CognitoIdentityProvider.AdminDeleteUser

type Rep AdminDeleteUser = D1 ('MetaData "AdminDeleteUser" "Amazonka.CognitoIdentityProvider.AdminDeleteUser" "amazonka-cognito-idp-2.0-D1ERgMvEVPG9z8cOLXdU2" '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))))

newAdminDeleteUser

Arguments

:: Text

AdminDeleteUser

-> Text

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:

AdminDeleteUser, adminDeleteUser_userPoolId - The user pool ID for the user pool where you want to delete the user.

AdminDeleteUser, adminDeleteUser_username - The user name of the user you want to delete.

Request Lenses

adminDeleteUser_userPoolId :: Lens' AdminDeleteUser Text

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

adminDeleteUser_username :: Lens' AdminDeleteUser Text

The user name of the user you want to delete.

Destructuring the Response

data AdminDeleteUserResponse

See: newAdminDeleteUserResponse smart constructor.

Constructors

AdminDeleteUserResponse'

Instances

Generic AdminDeleteUserResponse

Defined in Amazonka.CognitoIdentityProvider.AdminDeleteUser

Associated Types

type Rep AdminDeleteUserResponse :: Type -> Type

Methods

from :: AdminDeleteUserResponse -> Rep AdminDeleteUserResponse x

to :: Rep AdminDeleteUserResponse x -> AdminDeleteUserResponse

Read AdminDeleteUserResponse

Defined in Amazonka.CognitoIdentityProvider.AdminDeleteUser

Methods

readsPrec :: Int -> ReadS AdminDeleteUserResponse

readList :: ReadS [AdminDeleteUserResponse]

readPrec :: ReadPrec AdminDeleteUserResponse

readListPrec :: ReadPrec [AdminDeleteUserResponse]

Show AdminDeleteUserResponse

Defined in Amazonka.CognitoIdentityProvider.AdminDeleteUser

Methods

showsPrec :: Int -> AdminDeleteUserResponse -> ShowS

show :: AdminDeleteUserResponse -> String

showList :: [AdminDeleteUserResponse] -> ShowS

NFData AdminDeleteUserResponse

Defined in Amazonka.CognitoIdentityProvider.AdminDeleteUser

Methods

rnf :: AdminDeleteUserResponse -> ()

Eq AdminDeleteUserResponse

Defined in Amazonka.CognitoIdentityProvider.AdminDeleteUser

Methods

(==) :: AdminDeleteUserResponse -> AdminDeleteUserResponse -> Bool

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

type Rep AdminDeleteUserResponse

Defined in Amazonka.CognitoIdentityProvider.AdminDeleteUser

type Rep AdminDeleteUserResponse = D1 ('MetaData "AdminDeleteUserResponse" "Amazonka.CognitoIdentityProvider.AdminDeleteUser" "amazonka-cognito-idp-2.0-D1ERgMvEVPG9z8cOLXdU2" 'False) (C1 ('MetaCons "AdminDeleteUserResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newAdminDeleteUserResponse :: AdminDeleteUserResponse

Create a value of AdminDeleteUserResponse with all optional fields omitted.

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