Amazon Cognito · Schema

ListGroupsRequest

ListGroupsRequest schema from Amazon Cognito API

AuthenticationIdentityOAuthOIDCSAMLUser ManagementFederated Identity

Properties

Name Type Description
UserPoolId object
Limit object
NextToken object
View JSON Schema on GitHub

JSON Schema

user-pools-list-groups-request-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-cognito/refs/heads/main/json-schema/user-pools-list-groups-request-schema.json",
  "title": "ListGroupsRequest",
  "description": "ListGroupsRequest schema from Amazon Cognito API",
  "type": "object",
  "properties": {
    "UserPoolId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/UserPoolIdType"
        },
        {
          "description": "The user pool ID for the user pool."
        }
      ]
    },
    "Limit": {
      "allOf": [
        {
          "$ref": "#/components/schemas/QueryLimitType"
        },
        {
          "description": "The limit of the request to list groups."
        }
      ]
    },
    "NextToken": {
      "allOf": [
        {
          "$ref": "#/components/schemas/PaginationKey"
        },
        {
          "description": "An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list."
        }
      ]
    }
  },
  "required": [
    "UserPoolId"
  ]
}