CognitoIdentityProvider / Client / admin_remove_user_from_group

admin_remove_user_from_group

CognitoIdentityProvider.Client.admin_remove_user_from_group(**kwargs)

Removes the specified user from the specified group.

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

• Signing Amazon Web Services API Requests

• Using the Amazon Cognito user pools API and user pool endpoints

See also: AWS API Documentation

Request Syntax

response = client.admin_remove_user_from_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, this value must be the sub of a local user or the username of a user from a third-party IdP.

• 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