AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
Deletes a group from the specified user pool. When you delete a group, that group
no longer contributes to users'
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 morecognito: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.
For .NET Core this operation is only available in asynchronous form. Please refer to DeleteGroupAsync.
Namespace: Amazon.CognitoIdentityProvider
Assembly: AWSSDK.CognitoIdentityProvider.dll
Version: 3.x.y.z
public virtual DeleteGroupResponse DeleteGroup( DeleteGroupRequest request )
Container for the necessary parameters to execute the DeleteGroup service method.
| Exception | Condition |
|---|---|
| InternalErrorException | This exception is thrown when Amazon Cognito encounters an internal error. |
| InvalidParameterException | This exception is thrown when the Amazon Cognito service encounters an invalid parameter. |
| NotAuthorizedException | This exception is thrown when a user isn't authorized. |
| ResourceNotFoundException | This exception is thrown when the Amazon Cognito service can't find the requested resource. |
| TooManyRequestsException | This exception is thrown when the user has made too many requests for a given operation. |
.NET Framework:
Supported in: 4.5 and newer, 3.5