CognitoIdentityProvider / Client / admin_delete_user_attributes

admin_delete_user_attributes#

CognitoIdentityProvider.Client.admin_delete_user_attributes(**kwargs)#

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

Calling this action requires developer credentials.

Request Syntax

response = client.admin_delete_user_attributes(
    UserPoolId='string',
    Username='string',
    UserAttributeNames=[
        'string',
    ]
)

Parameters:

UserPoolId (string) –
[REQUIRED]

The user pool ID for the user pool where you want to delete user attributes.
Username (string) –
[REQUIRED]

The user name of the user from which you would like to delete attributes.
UserAttributeNames (list) –
[REQUIRED]

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

For custom attributes, you must prepend the custom: prefix to the attribute name.
- (string) –

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

(dict) –

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

Exceptions