GetThingShadow
Gets the shadow for the specified thing.
Requires permission to access the GetThingShadow action.
For more information, see GetThingShadow in the AWS IoT Developer Guide.
Request Syntax
GET /things/thingName/shadow?name=shadowName HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- shadowName
-
The name of the shadow.
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
[$a-zA-Z0-9:_-]+ - thingName
-
The name of the thing.
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
[a-zA-Z0-9:_-]+Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
payloadResponse Elements
If the action is successful, the service sends back an HTTP 200 response.
The response returns the following as the HTTP body.
- payload
-
The state information, in JSON format.
Errors
- InternalFailureException
-
An unexpected error has occurred.
HTTP Status Code: 500
- InvalidRequestException
-
The request is not valid.
HTTP Status Code: 400
- MethodNotAllowedException
-
The specified combination of HTTP verb and URI is not supported.
HTTP Status Code: 405
- ResourceNotFoundException
-
The specified resource does not exist.
HTTP Status Code: 404
- ServiceUnavailableException
-
The service is temporarily unavailable.
HTTP Status Code: 503
- ThrottlingException
-
The rate exceeds the limit.
HTTP Status Code: 429
- UnauthorizedException
-
You are not authorized to perform this operation.
HTTP Status Code: 401
- UnsupportedDocumentEncodingException
-
The document encoding is not supported.
HTTP Status Code: 415
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
