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

Description

Deletes the attributes for a user.

Synopsis

Creating a Request

data DeleteUserAttributes Source #

Represents the request to delete user attributes.

See: newDeleteUserAttributes smart constructor.

Constructors

DeleteUserAttributes' 

Fields

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

  • accessToken :: Sensitive Text

    The access token used in the request to delete user attributes.

Instances

Instances details
Eq DeleteUserAttributes Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.DeleteUserAttributes

Show DeleteUserAttributes Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.DeleteUserAttributes

Generic DeleteUserAttributes Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.DeleteUserAttributes

Associated Types

type Rep DeleteUserAttributes :: Type -> Type #

NFData DeleteUserAttributes Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.DeleteUserAttributes

Methods

rnf :: DeleteUserAttributes -> () #

Hashable DeleteUserAttributes Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.DeleteUserAttributes

ToJSON DeleteUserAttributes Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.DeleteUserAttributes

AWSRequest DeleteUserAttributes Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.DeleteUserAttributes

Associated Types

type AWSResponse DeleteUserAttributes #

ToHeaders DeleteUserAttributes Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.DeleteUserAttributes

ToPath DeleteUserAttributes Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.DeleteUserAttributes

ToQuery DeleteUserAttributes Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.DeleteUserAttributes

type Rep DeleteUserAttributes Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.DeleteUserAttributes

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

Defined in Amazonka.CognitoIdentityProvider.DeleteUserAttributes

newDeleteUserAttributes Source #

Create a value of DeleteUserAttributes 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:userAttributeNames:DeleteUserAttributes', deleteUserAttributes_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.

$sel:accessToken:DeleteUserAttributes', deleteUserAttributes_accessToken - The access token used in the request to delete user attributes.

Request Lenses

deleteUserAttributes_userAttributeNames :: Lens' DeleteUserAttributes [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.

deleteUserAttributes_accessToken :: Lens' DeleteUserAttributes Text Source #

The access token used in the request to delete user attributes.

Destructuring the Response

data DeleteUserAttributesResponse Source #

Represents the response from the server to delete user attributes.

See: newDeleteUserAttributesResponse smart constructor.

Constructors

DeleteUserAttributesResponse' 

Fields

Instances

Instances details
Eq DeleteUserAttributesResponse Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.DeleteUserAttributes

Read DeleteUserAttributesResponse Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.DeleteUserAttributes

Show DeleteUserAttributesResponse Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.DeleteUserAttributes

Generic DeleteUserAttributesResponse Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.DeleteUserAttributes

Associated Types

type Rep DeleteUserAttributesResponse :: Type -> Type #

NFData DeleteUserAttributesResponse Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.DeleteUserAttributes

type Rep DeleteUserAttributesResponse Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.DeleteUserAttributes

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

newDeleteUserAttributesResponse Source #

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

Response Lenses