CognitoIdentityProvider / Client / delete_group

delete_group#

CognitoIdentityProvider.Client.delete_group(**kwargs)#

Deletes a group from the specified user pool. When you delete a group, that group no longer contributes to users’ cognito:preferred_group or cognito:groups claims, and no longer influence access-control decision that are based on group membership. For more information about user pool groups, see Adding groups to a user pool.

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.delete_group(
    GroupName='string',
    UserPoolId='string'
)
Parameters:

  • GroupName (string) –

    [REQUIRED]

    The name of the group that you want to delete.

  • UserPoolId (string) –

    [REQUIRED]

    The ID of the user pool where you want to delete the group.

Returns:

None

Exceptions

  • CognitoIdentityProvider.Client.exceptions.ResourceNotFoundException

  • CognitoIdentityProvider.Client.exceptions.InvalidParameterException

  • CognitoIdentityProvider.Client.exceptions.TooManyRequestsException

  • CognitoIdentityProvider.Client.exceptions.NotAuthorizedException

  • CognitoIdentityProvider.Client.exceptions.InternalErrorException