v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-142381,278956.3 KB

Gets information about the specified thing.

Requires permission to access the DescribeThing action.

get/things/{thingName}

Path parameters

thingNamestring required

The name of the thing.

Response

Success

defaultClientIdstring
<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’t 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>
thingNamestring

The name of the thing.

thingIdstring

The ID of the thing to describe.

thingArnstring

The ARN of the thing to describe.

thingTypeNamestring

The thing type name.

attributesobject

The thing attributes.

versioninteger
<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>
billingGroupNamestring

The name of the billing group the thing belongs to.