Amazon Cognito · JSON Structure

User Pools Get Device Request Structure

Represents the request to get the device.

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

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

Properties

DeviceKey AccessToken

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-get-device-request-structure.json",
  "name": "GetDeviceRequest",
  "description": "Represents the request to get the device.",
  "type": "object",
  "properties": {
    "DeviceKey": {
      "allOf": [
        {
          "$ref": "#/components/schemas/DeviceKeyType"
        },
        {
          "description": "The device key."
        }
      ]
    },
    "AccessToken": {
      "allOf": [
        {
          "$ref": "#/components/schemas/TokenModelType"
        },
        {
          "description": "A valid access token that Amazon Cognito issued to the user whose device information you want to request."
        }
      ]
    }
  },
  "required": [
    "DeviceKey"
  ]
}