libZSservicesZSamazonka-cognito-idpZSamazonka-cognito-idp
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.CognitoIdentityProvider.AdminDisableUser

Description

Disables the specified user.

Calling this action requires developer credentials.

Synopsis

Creating a Request

data AdminDisableUser Source #

Represents the request to disable the user as an administrator.

See: newAdminDisableUser smart constructor.

Constructors

AdminDisableUser' 

Fields

Instances

Instances details
Eq AdminDisableUser Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.AdminDisableUser

Show AdminDisableUser Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.AdminDisableUser

Generic AdminDisableUser Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.AdminDisableUser

Associated Types

type Rep AdminDisableUser :: Type -> Type #

NFData AdminDisableUser Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.AdminDisableUser

Methods

rnf :: AdminDisableUser -> () #

Hashable AdminDisableUser Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.AdminDisableUser

ToJSON AdminDisableUser Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.AdminDisableUser

AWSRequest AdminDisableUser Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.AdminDisableUser

Associated Types

type AWSResponse AdminDisableUser #

ToHeaders AdminDisableUser Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.AdminDisableUser

ToPath AdminDisableUser Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.AdminDisableUser

ToQuery AdminDisableUser Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.AdminDisableUser

type Rep AdminDisableUser Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.AdminDisableUser

type Rep AdminDisableUser = D1 ('MetaData "AdminDisableUser" "Amazonka.CognitoIdentityProvider.AdminDisableUser" "libZSservicesZSamazonka-cognito-idpZSamazonka-cognito-idp" 'False) (C1 ('MetaCons "AdminDisableUser'" 'PrefixI 'True) (S1 ('MetaSel ('Just "userPoolId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "username") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive Text))))
type AWSResponse AdminDisableUser Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.AdminDisableUser

newAdminDisableUser Source #

Create a value of AdminDisableUser 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:AdminDisableUser', adminDisableUser_userPoolId - The user pool ID for the user pool where you want to disable the user.

$sel:username:AdminDisableUser', adminDisableUser_username - The user name of the user you wish to disable.

Request Lenses

adminDisableUser_userPoolId :: Lens' AdminDisableUser Text Source #

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

adminDisableUser_username :: Lens' AdminDisableUser Text Source #

The user name of the user you wish to disable.

Destructuring the Response

data AdminDisableUserResponse Source #

Represents the response received from the server to disable the user as an administrator.

See: newAdminDisableUserResponse smart constructor.

Constructors

AdminDisableUserResponse' 

Fields

Instances

Instances details
Eq AdminDisableUserResponse Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.AdminDisableUser

Read AdminDisableUserResponse Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.AdminDisableUser

Show AdminDisableUserResponse Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.AdminDisableUser

Generic AdminDisableUserResponse Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.AdminDisableUser

Associated Types

type Rep AdminDisableUserResponse :: Type -> Type #

NFData AdminDisableUserResponse Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.AdminDisableUser

type Rep AdminDisableUserResponse Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.AdminDisableUser

type Rep AdminDisableUserResponse = D1 ('MetaData "AdminDisableUserResponse" "Amazonka.CognitoIdentityProvider.AdminDisableUser" "libZSservicesZSamazonka-cognito-idpZSamazonka-cognito-idp" 'False) (C1 ('MetaCons "AdminDisableUserResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newAdminDisableUserResponse Source #

Create a value of AdminDisableUserResponse 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:AdminDisableUserResponse', adminDisableUserResponse_httpStatus - The response's http status code.

Response Lenses