Amazon Cognito · JSON Structure

Identity Pools List Identities Input Structure

Input to the ListIdentities action.

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

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

Properties

IdentityPoolId MaxResults NextToken HideDisabled

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/identity-pools-list-identities-input-structure.json",
  "name": "ListIdentitiesInput",
  "description": "Input to the ListIdentities action.",
  "type": "object",
  "properties": {
    "IdentityPoolId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/IdentityPoolId"
        },
        {
          "description": "An identity pool ID in the format REGION:GUID."
        }
      ]
    },
    "MaxResults": {
      "allOf": [
        {
          "$ref": "#/components/schemas/QueryLimit"
        },
        {
          "description": "The maximum number of identities to return."
        }
      ]
    },
    "NextToken": {
      "allOf": [
        {
          "$ref": "#/components/schemas/PaginationKey"
        },
        {
          "description": "A pagination token."
        }
      ]
    },
    "HideDisabled": {
      "allOf": [
        {
          "$ref": "#/components/schemas/HideDisabled"
        },
        {
          "description": "An optional boolean parameter that allows you to hide disabled identities. If omitted, the ListIdentities API will include disabled identities in the response."
        }
      ]
    }
  },
  "required": [
    "IdentityPoolId",
    "MaxResults"
  ]
}