Amazon Cognito · Schema

AdminListDevicesRequest

Represents the request to list devices, as an administrator.

AuthenticationAuthorizationIdentityIdentity ProviderOAuth2OIDC

Properties

Name Type Description
UserPoolId object
Username object
Limit object
PaginationToken object
View JSON Schema on GitHub

JSON Schema

cognito-idp-admin-list-devices-request-schema.json Raw ↑
{
  "type": "object",
  "properties": {
    "UserPoolId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/UserPoolIdType"
        },
        {
          "description": "The user pool ID."
        }
      ]
    },
    "Username": {
      "allOf": [
        {
          "$ref": "#/components/schemas/UsernameType"
        },
        {
          "description": "The user name."
        }
      ]
    },
    "Limit": {
      "allOf": [
        {
          "$ref": "#/components/schemas/QueryLimitType"
        },
        {
          "description": "The limit of the devices request."
        }
      ]
    },
    "PaginationToken": {
      "allOf": [
        {
          "$ref": "#/components/schemas/SearchPaginationTokenType"
        },
        {
          "description": "The pagination token."
        }
      ]
    }
  },
  "required": [
    "UserPoolId",
    "Username"
  ],
  "description": "Represents the request to list devices, as an administrator.",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/aws-cognito/refs/heads/main/json-schema/cognito-idp-admin-list-devices-request-schema.json",
  "title": "AdminListDevicesRequest"
}