UpdateGroupRequest is a JSON Structure definition published by Amazon Cognito, describing 5 properties, of which 2 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.
{
"$schema": "https://json-structure.org/meta/core/v0/#",
"$id": "https://raw.githubusercontent.com/api-evangelist/amazon-cognito/refs/heads/main/json-structure/user-pools-update-group-request-structure.json",
"name": "UpdateGroupRequest",
"description": "UpdateGroupRequest schema from Amazon Cognito API",
"type": "object",
"properties": {
"GroupName": {
"allOf": [
{
"$ref": "#/components/schemas/GroupNameType"
},
{
"description": "The name of the group."
}
]
},
"UserPoolId": {
"allOf": [
{
"$ref": "#/components/schemas/UserPoolIdType"
},
{
"description": "The user pool ID for the user pool."
}
]
},
"Description": {
"allOf": [
{
"$ref": "#/components/schemas/DescriptionType"
},
{
"description": "A string containing the new description of the group."
}
]
},
"RoleArn": {
"allOf": [
{
"$ref": "#/components/schemas/ArnType"
},
{
"description": "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."
}
]
},
"Precedence": {
"allOf": [
{
"$ref": "#/components/schemas/PrecedenceType"
},
{
"description": "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>."
}
]
}
},
"required": [
"GroupName",
"UserPoolId"
]
}
Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.