CognitoIdentityProvider / Client / delete_user_attributes

delete_user_attributes#

CognitoIdentityProvider.Client.delete_user_attributes(**kwargs)#

Deletes the attributes for a user.

Request Syntax

response = client.delete_user_attributes(
    UserAttributeNames=[
        'string',
    ],
    AccessToken='string'
)

Parameters:

UserAttributeNames (list) –
[REQUIRED]

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.
- (string) –
AccessToken (string) –
[REQUIRED]

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

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

Exceptions