Amazon Cognito · JSON Structure

User Pools Admin Update Device Status Request Structure

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

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

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

Properties

UserPoolId Username DeviceKey DeviceRememberedStatus

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-admin-update-device-status-request-structure.json",
  "name": "AdminUpdateDeviceStatusRequest",
  "description": "The request to update the device status, 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."
        }
      ]
    },
    "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"
  ]
}