CognitoIdentityProvider / Client / delete_group

delete_group

CognitoIdentityProvider.Client.delete_group(**kwargs)

Deletes a group.

Calling this action requires developer credentials.

See also: AWS API Documentation

Request Syntax

response = client.delete_group(
    GroupName='string',
    UserPoolId='string'
)

Parameters:

• GroupName (string) –

  [REQUIRED]

  The name of the group.

• UserPoolId (string) –

  [REQUIRED]

  The user pool ID for the user pool.

Returns:

None

Exceptions

• CognitoIdentityProvider.Client.exceptions.ResourceNotFoundException

• CognitoIdentityProvider.Client.exceptions.InvalidParameterException

• CognitoIdentityProvider.Client.exceptions.TooManyRequestsException

• CognitoIdentityProvider.Client.exceptions.NotAuthorizedException

• CognitoIdentityProvider.Client.exceptions.InternalErrorException