CognitoIdentityProvider / Client / admin_add_user_to_group

admin_add_user_to_group#

CognitoIdentityProvider.Client.admin_add_user_to_group(**kwargs)#

Adds the specified user to the specified group.

Calling this action requires developer credentials.

See also: AWS API Documentation

Request Syntax

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

  • UserPoolId (string) –

    [REQUIRED]

    The user pool ID for the user pool.

  • Username (string) –

    [REQUIRED]

    The username for the user.

  • GroupName (string) –

    [REQUIRED]

    The group name.

Returns:

None

Exceptions

  • CognitoIdentityProvider.Client.exceptions.InvalidParameterException

  • CognitoIdentityProvider.Client.exceptions.ResourceNotFoundException

  • CognitoIdentityProvider.Client.exceptions.TooManyRequestsException

  • CognitoIdentityProvider.Client.exceptions.NotAuthorizedException

  • CognitoIdentityProvider.Client.exceptions.UserNotFoundException

  • CognitoIdentityProvider.Client.exceptions.InternalErrorException