Menu
AWS IoT
Developer Guide

DescribeThing

Gets information about the specified thing.

Request syntax:

GET /things/thingName

URI Request Parameters:

Name

Type

Req?

Description

thingName

ThingName

yes

The name of the thing.

Response syntax:

Content-type: application/json { "defaultClientId": "string", "thingName": "string", "thingId": "string", "thingArn": "string", "thingTypeName": "string", "attributes": { "string": "string" }, "version": "long" }

Response Body Parameters:

Name

Type

Req?

Description

defaultClientId

ClientId

no

The default client ID.

thingName

ThingName

no

The name of the thing.

thingId

ThingId

no

The ID of the thing to describe.

thingArn

ThingArn

no

The ARN of the thing to describe.

thingTypeName

ThingTypeName

no

The thing type name.

attributes

Attributes

no

The thing attributes.

version

Version

no

The current version of the thing record in the registry.

Note

To avoid unintentional changes to the information in the registry, you can pass the version information in the expectedVersion parameter of the UpdateThing and DeleteThing calls.

Errors:

ResourceNotFoundException

The specified resource does not exist.

HTTP response code: 404

InvalidRequestException

The contents of the request were invalid. For example, this code is returned when an UpdateJobExecution request contains invalid status details. The message contains details about the error.

HTTP response code: 400

ThrottlingException

The rate exceeds the limit.

HTTP response code: 429

UnauthorizedException

You are not authorized to perform this operation.

HTTP response code: 401

ServiceUnavailableException

The service is temporarily unavailable.

HTTP response code: 503

InternalFailureException

An unexpected error has occurred.

HTTP response code: 500

CLI

Synopsis:

aws iot describe-thing \ --thing-name <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

cli-input-json format:

{ "thingName": "string" }

cli-input-json fields:

Name

Type

Description

thingName

string

length max:128 min:1

pattern: [a-zA-Z0-9:_-]+

The name of the thing.

Output:

{ "defaultClientId": "string", "thingName": "string", "thingId": "string", "thingArn": "string", "thingTypeName": "string", "attributes": { "string": "string" }, "version": "long" }

cli output fields:

Name

Type

Description

defaultClientId

string

The default client ID.

thingName

string

length max:128 min:1

pattern: [a-zA-Z0-9:_-]+

The name of the thing.

thingId

string

The ID of the thing to describe.

thingArn

string

The ARN of the thing to describe.

thingTypeName

string

length max:128 min:1

pattern: [a-zA-Z0-9:_-]+

The thing type name.

attributes

map

key: AttributeName

value: AttributeValue

The thing attributes.

AttributeName

string

length max:128

pattern: [a-zA-Z0-9_.,@/:#-]+

AttributeValue

string

length max:800

pattern: [a-zA-Z0-9_.,@/:#-]*

version

long

The current version of the thing record in the registry.

Note

To avoid unintentional changes to the information in the registry, you can pass the version information in the expectedVersion parameter of the UpdateThing and DeleteThing calls.

On this page: