Menu
AWS IoT
Developer Guide

GetThingShadow

GetThingShadow

Gets the shadow for the specified thing.

For more information, see GetThingShadow in the AWS IoT Developer Guide.

https

Request syntax:

GET /things/thingName/shadow

URI Request Parameters:

Name

Type

Req?

Description

thingName

ThingName

yes

The name of the thing.

Response syntax:

Content-type: application/json { "payload": "blob" }

Response Body Parameters:

Name

Type

Req?

Description

payload

JsonDocument

no

The state information, in JSON format.

Errors:

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

ResourceNotFoundException

The specified resource does not exist.

HTTP response code: 404

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

MethodNotAllowedException

The specified combination of HTTP verb and URI is not supported.

HTTP response code: 405

UnsupportedDocumentEncodingException

The encoding is not supported.

HTTP response code: 415

cli

Synopsis:

aws iot-data get-thing-shadow \ --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:

{ "payload": "blob" }

cli output fields:

Name

Type

Description

payload

blob

The state information, in JSON format.

Errors:

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.

ResourceNotFoundException

The specified resource does not exist.

ThrottlingException

The rate exceeds the limit.

UnauthorizedException

You are not authorized to perform this operation.

ServiceUnavailableException

The service is temporarily unavailable.

InternalFailureException

An unexpected error has occurred.

MethodNotAllowedException

The specified combination of HTTP verb and URI is not supported.

UnsupportedDocumentEncodingException

The encoding is not supported.