Amazonka.CognitoIdentityProvider.DeleteUserAttributes

Deletes the attributes for a user.

Creating a Request

data DeleteUserAttributes

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

  For custom attributes, you must prependattach the custom: prefix to the front of the attribute name.

• accessToken :: Sensitive Text

  A valid access token that Amazon Cognito issued to the user whose attributes you want to delete.

Instances

ToJSON DeleteUserAttributes

Defined in Amazonka.CognitoIdentityProvider.DeleteUserAttributes

Methods

toJSON :: DeleteUserAttributes -> Value

toEncoding :: DeleteUserAttributes -> Encoding

toJSONList :: [DeleteUserAttributes] -> Value

toEncodingList :: [DeleteUserAttributes] -> Encoding

ToHeaders DeleteUserAttributes

Defined in Amazonka.CognitoIdentityProvider.DeleteUserAttributes

Methods

toHeaders :: DeleteUserAttributes -> [Header]

ToPath DeleteUserAttributes

Defined in Amazonka.CognitoIdentityProvider.DeleteUserAttributes

Methods

toPath :: DeleteUserAttributes -> ByteString

ToQuery DeleteUserAttributes

Defined in Amazonka.CognitoIdentityProvider.DeleteUserAttributes

Methods

toQuery :: DeleteUserAttributes -> QueryString

AWSRequest DeleteUserAttributes

Defined in Amazonka.CognitoIdentityProvider.DeleteUserAttributes

Associated Types

type AWSResponse DeleteUserAttributes

Methods

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

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

Generic DeleteUserAttributes

Defined in Amazonka.CognitoIdentityProvider.DeleteUserAttributes

Associated Types

type Rep DeleteUserAttributes :: Type -> Type

Methods

from :: DeleteUserAttributes -> Rep DeleteUserAttributes x

to :: Rep DeleteUserAttributes x -> DeleteUserAttributes

Show DeleteUserAttributes

Defined in Amazonka.CognitoIdentityProvider.DeleteUserAttributes

Methods

showsPrec :: Int -> DeleteUserAttributes -> ShowS

show :: DeleteUserAttributes -> String

showList :: [DeleteUserAttributes] -> ShowS

NFData DeleteUserAttributes

Defined in Amazonka.CognitoIdentityProvider.DeleteUserAttributes

Methods

rnf :: DeleteUserAttributes -> ()

Eq DeleteUserAttributes

Defined in Amazonka.CognitoIdentityProvider.DeleteUserAttributes

Methods

(==) :: DeleteUserAttributes -> DeleteUserAttributes -> Bool

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

Hashable DeleteUserAttributes

Defined in Amazonka.CognitoIdentityProvider.DeleteUserAttributes

Methods

hashWithSalt :: Int -> DeleteUserAttributes -> Int

hash :: DeleteUserAttributes -> Int

type AWSResponse DeleteUserAttributes

Defined in Amazonka.CognitoIdentityProvider.DeleteUserAttributes

type AWSResponse DeleteUserAttributes = DeleteUserAttributesResponse

type Rep DeleteUserAttributes

Defined in Amazonka.CognitoIdentityProvider.DeleteUserAttributes

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

newDeleteUserAttributes

Arguments

:: Text

DeleteUserAttributes

-> DeleteUserAttributes

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

For custom attributes, you must prependattach the custom: prefix to the front of the attribute name.

DeleteUserAttributes, deleteUserAttributes_accessToken - A valid access token that Amazon Cognito issued to the user whose attributes you want to delete.

Request Lenses

deleteUserAttributes_userAttributeNames :: Lens' DeleteUserAttributes [Text]

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

For custom attributes, you must prependattach the custom: prefix to the front of the attribute name.

deleteUserAttributes_accessToken :: Lens' DeleteUserAttributes Text

A valid access token that Amazon Cognito issued to the user whose attributes you want to delete.

Destructuring the Response

data DeleteUserAttributesResponse

Represents the response from the server to delete user attributes.

See: newDeleteUserAttributesResponse smart constructor.

Constructors

DeleteUserAttributesResponse'

Fields

• httpStatus :: Int

  The response's http status code.

Instances

Generic DeleteUserAttributesResponse

Defined in Amazonka.CognitoIdentityProvider.DeleteUserAttributes

Associated Types

type Rep DeleteUserAttributesResponse :: Type -> Type

Methods

from :: DeleteUserAttributesResponse -> Rep DeleteUserAttributesResponse x

to :: Rep DeleteUserAttributesResponse x -> DeleteUserAttributesResponse

Read DeleteUserAttributesResponse

Defined in Amazonka.CognitoIdentityProvider.DeleteUserAttributes

Methods

readsPrec :: Int -> ReadS DeleteUserAttributesResponse

readList :: ReadS [DeleteUserAttributesResponse]

readPrec :: ReadPrec DeleteUserAttributesResponse

readListPrec :: ReadPrec [DeleteUserAttributesResponse]

Show DeleteUserAttributesResponse

Defined in Amazonka.CognitoIdentityProvider.DeleteUserAttributes

Methods

showsPrec :: Int -> DeleteUserAttributesResponse -> ShowS

show :: DeleteUserAttributesResponse -> String

showList :: [DeleteUserAttributesResponse] -> ShowS

NFData DeleteUserAttributesResponse

Defined in Amazonka.CognitoIdentityProvider.DeleteUserAttributes

Methods

rnf :: DeleteUserAttributesResponse -> ()

Eq DeleteUserAttributesResponse

Defined in Amazonka.CognitoIdentityProvider.DeleteUserAttributes

Methods

(==) :: DeleteUserAttributesResponse -> DeleteUserAttributesResponse -> Bool

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

type Rep DeleteUserAttributesResponse

Defined in Amazonka.CognitoIdentityProvider.DeleteUserAttributes

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

newDeleteUserAttributesResponse

Arguments

:: Int

$sel:httpStatus:DeleteUserAttributesResponse'

-> DeleteUserAttributesResponse

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

deleteUserAttributesResponse_httpStatus :: Lens' DeleteUserAttributesResponse Int

The response's http status code.