CognitoIdentityProvider / Client / admin_enable_user

admin_enable_user#

CognitoIdentityProvider.Client.admin_enable_user(**kwargs)#

Enables the specified user as an administrator. Works on any user.

Note

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

Learn more

See also: AWS API Documentation

Request Syntax

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

  • UserPoolId (string) –

    [REQUIRED]

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

  • Username (string) –

    [REQUIRED]

    The username of the user that you want to query or modify. The value of this parameter is typically your user’s username, but it can be any of their alias attributes. If username isn’t an alias attribute in your user pool, you can also use their sub in this request.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

    Represents the response from the server for the request to enable a user as an administrator.

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