Amazon Cognito · Schema

AdminListDevicesRequest

Represents the request to list devices, as an administrator.

AuthenticationIdentityOAuthOIDCSAMLUser ManagementFederated Identity

Properties

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

JSON Schema

user-pools-admin-list-devices-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-admin-list-devices-request-schema.json",
  "title": "AdminListDevicesRequest",
  "description": "Represents the request to list devices, as an administrator.",
  "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"
  ]
}