CognitoIdentityProvider / Client / admin_delete_user

admin_delete_user#

CognitoIdentityProvider.Client.admin_delete_user(**kwargs)#

Deletes a user as an administrator. Works on any user.

Calling this action requires developer credentials.

See also: AWS API Documentation

Request Syntax

response = client.admin_delete_user(
    UserPoolId='string',
    Username='string'
)
Parameters:

  • UserPoolId (string) –

    [REQUIRED]

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

  • Username (string) –

    [REQUIRED]

    The user name of the user you want to delete.

Returns:

None

Exceptions

  • CognitoIdentityProvider.Client.exceptions.ResourceNotFoundException

  • CognitoIdentityProvider.Client.exceptions.InvalidParameterException

  • CognitoIdentityProvider.Client.exceptions.TooManyRequestsException

  • CognitoIdentityProvider.Client.exceptions.NotAuthorizedException

  • CognitoIdentityProvider.Client.exceptions.UserNotFoundException

  • CognitoIdentityProvider.Client.exceptions.InternalErrorException