Amazon IoT Device Management · JSON Structure

Iot Device Management Describe Thing Response Structure

The output from the DescribeThing operation.

Type: object Properties: 8
Device ManagementFleet ManagementIoTOTA Updates

DescribeThingResponse is a JSON Structure definition published by Amazon IoT Device Management, describing 8 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

defaultClientId thingName thingId thingArn thingTypeName attributes version billingGroupName

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-iot-device-management/refs/heads/main/json-structure/iot-device-management-describe-thing-response-structure.json",
  "name": "DescribeThingResponse",
  "description": "The output from the DescribeThing operation.",
  "type": "object",
  "properties": {
    "defaultClientId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ClientId"
        },
        {
          "description": "<p>The default MQTT client ID. For a typical device, the thing name is also used as the default MQTT client ID. Although we don\u2019t require a mapping between a thing's registry name and its use of MQTT client IDs, certificates, or shadow state, we recommend that you choose a thing name and use it as the MQTT client ID for the registry and the Device Shadow service.</p> <p>This lets you better organize your IoT fleet without removing the flexibility of the underlying device certificate model or shadows.</p>"
        }
      ]
    },
    "thingName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ThingName"
        },
        {
          "description": "The name of the thing."
        }
      ]
    },
    "thingId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ThingId"
        },
        {
          "description": "The ID of the thing to describe."
        }
      ]
    },
    "thingArn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ThingArn"
        },
        {
          "description": "The ARN of the thing to describe."
        }
      ]
    },
    "thingTypeName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ThingTypeName"
        },
        {
          "description": "The thing type name."
        }
      ]
    },
    "attributes": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Attributes"
        },
        {
          "description": "The thing attributes."
        }
      ]
    },
    "version": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Version"
        },
        {
          "description": "<p>The current version of the thing record in the registry.</p> <note> <p>To avoid unintentional changes to the information in the registry, you can pass the version information in the <code>expectedVersion</code> parameter of the <code>UpdateThing</code> and <code>DeleteThing</code> calls.</p> </note>"
        }
      ]
    },
    "billingGroupName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/BillingGroupName"
        },
        {
          "description": "The name of the billing group the thing belongs to."
        }
      ]
    }
  }
}