Amazon Cognito · Schema

AdminUpdateDeviceStatusRequest

The request to update the device status, as an administrator.

AuthenticationAuthorizationIdentityIdentity ProviderOAuth2OIDC

Properties

Name Type Description
UserPoolId object
Username object
DeviceKey object
DeviceRememberedStatus object
View JSON Schema on GitHub

JSON Schema

cognito-idp-admin-update-device-status-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."
        }
      ]
    },
    "DeviceKey": {
      "allOf": [
        {
          "$ref": "#/components/schemas/DeviceKeyType"
        },
        {
          "description": "The device key."
        }
      ]
    },
    "DeviceRememberedStatus": {
      "allOf": [
        {
          "$ref": "#/components/schemas/DeviceRememberedStatusType"
        },
        {
          "description": "The status indicating whether a device has been remembered or not."
        }
      ]
    }
  },
  "required": [
    "UserPoolId",
    "Username",
    "DeviceKey"
  ],
  "description": "The request to update the device status, 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-update-device-status-request-schema.json",
  "title": "AdminUpdateDeviceStatusRequest"
}