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.AdminDeleteUserAttributes

Description

Deletes the user attributes in a user pool as an administrator. Works on any user.

Calling this action requires developer credentials.

Synopsis

Creating a Request

data AdminDeleteUserAttributes Source #

Represents the request to delete user attributes as an administrator.

See: newAdminDeleteUserAttributes smart constructor.

Constructors

AdminDeleteUserAttributes' 

Fields

  • userPoolId :: Text

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

  • username :: Sensitive Text

    The user name of the user from which you would like to delete attributes.

  • userAttributeNames :: [Text]

    An array of strings representing the user attribute names you wish to delete.

    For custom attributes, you must prepend the custom: prefix to the attribute name.

Instances

Instances details
Eq AdminDeleteUserAttributes Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.AdminDeleteUserAttributes

Show AdminDeleteUserAttributes Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.AdminDeleteUserAttributes

Generic AdminDeleteUserAttributes Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.AdminDeleteUserAttributes

Associated Types

type Rep AdminDeleteUserAttributes :: Type -> Type #

NFData AdminDeleteUserAttributes Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.AdminDeleteUserAttributes

Hashable AdminDeleteUserAttributes Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.AdminDeleteUserAttributes

ToJSON AdminDeleteUserAttributes Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.AdminDeleteUserAttributes

AWSRequest AdminDeleteUserAttributes Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.AdminDeleteUserAttributes

ToHeaders AdminDeleteUserAttributes Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.AdminDeleteUserAttributes

ToPath AdminDeleteUserAttributes Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.AdminDeleteUserAttributes

ToQuery AdminDeleteUserAttributes Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.AdminDeleteUserAttributes

type Rep AdminDeleteUserAttributes Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.AdminDeleteUserAttributes

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

Defined in Amazonka.CognitoIdentityProvider.AdminDeleteUserAttributes

newAdminDeleteUserAttributes Source #

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

$sel:username:AdminDeleteUserAttributes', adminDeleteUserAttributes_username - The user name of the user from which you would like to delete attributes.

$sel:userAttributeNames:AdminDeleteUserAttributes', adminDeleteUserAttributes_userAttributeNames - An array of strings representing the user attribute names you wish to delete.

For custom attributes, you must prepend the custom: prefix to the attribute name.

Request Lenses

adminDeleteUserAttributes_userPoolId :: Lens' AdminDeleteUserAttributes Text Source #

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

adminDeleteUserAttributes_username :: Lens' AdminDeleteUserAttributes Text Source #

The user name of the user from which you would like to delete attributes.

adminDeleteUserAttributes_userAttributeNames :: Lens' AdminDeleteUserAttributes [Text] Source #

An array of strings representing the user attribute names you wish to delete.

For custom attributes, you must prepend the custom: prefix to the attribute name.

Destructuring the Response

data AdminDeleteUserAttributesResponse Source #

Represents the response received from the server for a request to delete user attributes.

See: newAdminDeleteUserAttributesResponse smart constructor.

Constructors

AdminDeleteUserAttributesResponse' 

Fields

Instances

Instances details
Eq AdminDeleteUserAttributesResponse Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.AdminDeleteUserAttributes

Read AdminDeleteUserAttributesResponse Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.AdminDeleteUserAttributes

Show AdminDeleteUserAttributesResponse Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.AdminDeleteUserAttributes

Generic AdminDeleteUserAttributesResponse Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.AdminDeleteUserAttributes

Associated Types

type Rep AdminDeleteUserAttributesResponse :: Type -> Type #

NFData AdminDeleteUserAttributesResponse Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.AdminDeleteUserAttributes

type Rep AdminDeleteUserAttributesResponse Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.AdminDeleteUserAttributes

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

newAdminDeleteUserAttributesResponse Source #

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

Response Lenses