Amazon Cognito · JSON Structure

User Pools List User Pools Request Structure

Represents the request to list user pools.

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

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

Properties

NextToken MaxResults

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-list-user-pools-request-structure.json",
  "name": "ListUserPoolsRequest",
  "description": "Represents the request to list user pools.",
  "type": "object",
  "properties": {
    "NextToken": {
      "allOf": [
        {
          "$ref": "#/components/schemas/PaginationKeyType"
        },
        {
          "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."
        }
      ]
    },
    "MaxResults": {
      "allOf": [
        {
          "$ref": "#/components/schemas/PoolQueryLimitType"
        },
        {
          "description": "The maximum number of results you want the request to return when listing the user pools."
        }
      ]
    }
  },
  "required": [
    "MaxResults"
  ]
}