Amazon Cognito · JSON Structure

User Pools Get Group Request Structure

GetGroupRequest schema from Amazon Cognito API

Type: object Properties: 2 Required: 2
AuthenticationIdentityOAuthOIDCSAMLUser ManagementFederated Identity

GetGroupRequest is a JSON Structure definition published by Amazon Cognito, describing 2 properties, of which 2 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

GroupName UserPoolId

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-cognito/refs/heads/main/json-structure/user-pools-get-group-request-structure.json",
  "name": "GetGroupRequest",
  "description": "GetGroupRequest 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."
        }
      ]
    }
  },
  "required": [
    "GroupName",
    "UserPoolId"
  ]
}