CognitoIdentityProvider / Client / admin_add_user_to_group
admin_add_user_to_group#
- CognitoIdentityProvider.Client.admin_add_user_to_group(**kwargs)#
Adds a user to a group. A user who is in a group can present a preferred-role claim to an identity pool, and populates a
cognito:groups
claim to their access and identity tokens.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_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 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 theirsub
in this request.GroupName (string) –
[REQUIRED]
The name of the group that you want to add your user to.
- 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