Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14101465558.4 KB

Updates the specified group with the specified attributes.

Calling this action requires developer credentials.

post/#X-Amz-Target=AWSCognitoIdentityProviderService.UpdateGroup

Headers

X-Amz-Target'AWSCognitoIdentityProviderService.UpdateGroup' required

Request body

GroupNamestring required

The name of the group.

UserPoolIdstring required

The user pool ID for the user pool.

Descriptionstring

A string containing the new description of the group.

RoleArnstring

The new role Amazon Resource Name (ARN) for the group. This is used for setting the <code>cognito:roles</code> and <code>cognito:preferred_role</code> claims in the token.

Precedenceinteger

The new precedence value for the group. For more information about this parameter, see <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateGroup.html">CreateGroup</a>.

Response

Success