AWS IoT-Data enables secure, bi-directional communication between Internet-connected things (such as sensors, actuators, embedded devices, or smart appliances) and the AWS cloud. It implements a broker for applications and things to publish messages over HTTP (Publish) and retrieve, update, and delete thing shadows. A thing shadow is a persistent representation of your things and their state in the AWS cloud.
Deletes the thing shadow for the specified thing.
For more information, see DeleteThingShadow in the AWS IoT Developer Guide.
Name | Data Type | Description |
---|---|---|
thingName
|
string Pattern: [a-zA-Z0-9_-]+ Minimum: 1 Maximum: 128 |
The name of the thing. |
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Name | Data Type | Description |
---|---|---|
DeleteThingShadowResponse
|
object |
The output from the DeleteThingShadow operation. |
payload
|
JsonDocument |
The state information, in JSON format. |
||||
|
Name | Data Type | Description |
---|---|---|
ResourceNotFoundException
|
object |
The specified resource does not exist. |
message
|
errorMessage |
The message for the exception. |
||||
|
Name | Data Type | Description |
---|---|---|
InvalidRequestException
|
object |
The request is not valid. |
message
|
errorMessage |
The message for the exception. |
||||
|
Name | Data Type | Description |
---|---|---|
ThrottlingException
|
object |
The rate exceeds the limit. |
message
|
errorMessage |
The message for the exception. |
||||
|
Name | Data Type | Description |
---|---|---|
UnauthorizedException
|
object |
You are not authorized to perform this operation. |
message
|
errorMessage |
The message for the exception. |
||||
|
Name | Data Type | Description |
---|---|---|
ServiceUnavailableException
|
object |
The service is temporarily unavailable. |
message
|
errorMessage |
The message for the exception. |
||||
|
Name | Data Type | Description |
---|---|---|
InternalFailureException
|
object |
An unexpected error has occurred. |
message
|
errorMessage |
The message for the exception. |
||||
|
Name | Data Type | Description |
---|---|---|
MethodNotAllowedException
|
object |
The specified combination of HTTP verb and URI is not supported. |
message
|
ErrorMessage |
The message for the exception. |
||||
|
Name | Data Type | Description |
---|---|---|
UnsupportedDocumentEncodingException
|
object |
The document encoding is not supported. |
message
|
errorMessage |
The message for the exception. |
||||
|
Gets the thing shadow for the specified thing.
For more information, see GetThingShadow in the AWS IoT Developer Guide.
Name | Data Type | Description |
---|---|---|
thingName
|
string Pattern: [a-zA-Z0-9_-]+ Minimum: 1 Maximum: 128 |
The name of the thing. |
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Name | Data Type | Description |
---|---|---|
GetThingShadowResponse
|
object |
The output from the GetThingShadow operation. |
payload
|
JsonDocument |
The state information, in JSON format. |
||||
|
Name | Data Type | Description |
---|---|---|
InvalidRequestException
|
object |
The request is not valid. |
message
|
errorMessage |
The message for the exception. |
||||
|
Name | Data Type | Description |
---|---|---|
ResourceNotFoundException
|
object |
The specified resource does not exist. |
message
|
errorMessage |
The message for the exception. |
||||
|
Name | Data Type | Description |
---|---|---|
ThrottlingException
|
object |
The rate exceeds the limit. |
message
|
errorMessage |
The message for the exception. |
||||
|
Name | Data Type | Description |
---|---|---|
UnauthorizedException
|
object |
You are not authorized to perform this operation. |
message
|
errorMessage |
The message for the exception. |
||||
|
Name | Data Type | Description |
---|---|---|
ServiceUnavailableException
|
object |
The service is temporarily unavailable. |
message
|
errorMessage |
The message for the exception. |
||||
|
Name | Data Type | Description |
---|---|---|
InternalFailureException
|
object |
An unexpected error has occurred. |
message
|
errorMessage |
The message for the exception. |
||||
|
Name | Data Type | Description |
---|---|---|
MethodNotAllowedException
|
object |
The specified combination of HTTP verb and URI is not supported. |
message
|
ErrorMessage |
The message for the exception. |
||||
|
Name | Data Type | Description |
---|---|---|
UnsupportedDocumentEncodingException
|
object |
The document encoding is not supported. |
message
|
errorMessage |
The message for the exception. |
||||
|
Updates the thing shadow for the specified thing.
For more information, see UpdateThingShadow in the AWS IoT Developer Guide.
Name | Data Type | Description |
---|---|---|
thingName
|
string Pattern: [a-zA-Z0-9_-]+ Minimum: 1 Maximum: 128 |
The name of the thing. |
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Name | Data Type | Description |
---|---|---|
body
|
object |
payload
|
string |
The state information, in JSON format. |
Name | Data Type | Description |
---|---|---|
UpdateThingShadowResponse
|
object |
The output from the UpdateThingShadow operation. |
payload
|
JsonDocument |
The state information, in JSON format. |
||||
|
Name | Data Type | Description |
---|---|---|
ConflictException
|
object |
The specified version does not match the version of the document. |
message
|
ErrorMessage |
The message for the exception. |
||||
|
Name | Data Type | Description |
---|---|---|
RequestEntityTooLargeException
|
object |
The payload exceeds the maximum size allowed. |
message
|
ErrorMessage |
The message for the exception. |
||||
|
Name | Data Type | Description |
---|---|---|
InvalidRequestException
|
object |
The request is not valid. |
message
|
errorMessage |
The message for the exception. |
||||
|
Name | Data Type | Description |
---|---|---|
ThrottlingException
|
object |
The rate exceeds the limit. |
message
|
errorMessage |
The message for the exception. |
||||
|
Name | Data Type | Description |
---|---|---|
UnauthorizedException
|
object |
You are not authorized to perform this operation. |
message
|
errorMessage |
The message for the exception. |
||||
|
Name | Data Type | Description |
---|---|---|
ServiceUnavailableException
|
object |
The service is temporarily unavailable. |
message
|
errorMessage |
The message for the exception. |
||||
|
Name | Data Type | Description |
---|---|---|
InternalFailureException
|
object |
An unexpected error has occurred. |
message
|
errorMessage |
The message for the exception. |
||||
|
Name | Data Type | Description |
---|---|---|
MethodNotAllowedException
|
object |
The specified combination of HTTP verb and URI is not supported. |
message
|
ErrorMessage |
The message for the exception. |
||||
|
Name | Data Type | Description |
---|---|---|
UnsupportedDocumentEncodingException
|
object |
The document encoding is not supported. |
message
|
errorMessage |
The message for the exception. |
||||
|
Publishes state information.
For more information, see HTTP Protocol in the AWS IoT Developer Guide.
Name | Data Type | Description |
---|---|---|
topic
|
string |
The name of the MQTT topic. |
Name | Data Type | Description |
---|---|---|
qos
|
integer Minimum: 0 Maximum: 1 |
The Quality of Service (QoS) level. |
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Name | Data Type | Description |
---|---|---|
body
|
object |
payload
|
string |
The state information, in JSON format. |
Name | Data Type | Description |
---|---|---|
InternalFailureException
|
object |
An unexpected error has occurred. |
message
|
errorMessage |
The message for the exception. |
||||
|
Name | Data Type | Description |
---|---|---|
InvalidRequestException
|
object |
The request is not valid. |
message
|
errorMessage |
The message for the exception. |
||||
|
Name | Data Type | Description |
---|---|---|
UnauthorizedException
|
object |
You are not authorized to perform this operation. |
message
|
errorMessage |
The message for the exception. |
||||
|
Name | Data Type | Description |
---|---|---|
MethodNotAllowedException
|
object |
The specified combination of HTTP verb and URI is not supported. |
message
|
ErrorMessage |
The message for the exception. |
||||
|
The specified version does not match the version of the document.
Name | Data Type | Description | ||||
---|---|---|---|---|---|---|
message
|
ErrorMessage |
The message for the exception. |
||||
|
The input for the DeleteThingShadow operation.
Name | Data Type | Description |
---|---|---|
DeleteThingShadowRequest
|
object |
The input for the DeleteThingShadow operation. |
The output from the DeleteThingShadow operation.
Name | Data Type | Description | ||||
---|---|---|---|---|---|---|
payload
|
JsonDocument |
The state information, in JSON format. |
||||
|
Name | Data Type | Description |
---|---|---|
ErrorMessage
|
string |
The input for the GetThingShadow operation.
Name | Data Type | Description |
---|---|---|
GetThingShadowRequest
|
object |
The input for the GetThingShadow operation. |
The output from the GetThingShadow operation.
Name | Data Type | Description | ||||
---|---|---|---|---|---|---|
payload
|
JsonDocument |
The state information, in JSON format. |
||||
|
An unexpected error has occurred.
Name | Data Type | Description | ||||
---|---|---|---|---|---|---|
message
|
errorMessage |
The message for the exception. |
||||
|
The request is not valid.
Name | Data Type | Description | ||||
---|---|---|---|---|---|---|
message
|
errorMessage |
The message for the exception. |
||||
|
Name | Data Type | Description |
---|---|---|
JsonDocument
|
string |
The specified combination of HTTP verb and URI is not supported.
Name | Data Type | Description | ||||
---|---|---|---|---|---|---|
message
|
ErrorMessage |
The message for the exception. |
||||
|
Name | Data Type | Description |
---|---|---|
Payload
|
string |
The input for the Publish operation.
Name | Data Type | Description | ||||
---|---|---|---|---|---|---|
payload
|
Payload |
The state information, in JSON format. |
||||
|
Name | Data Type | Description |
---|---|---|
Qos
|
integer Minimum: 0 Maximum: 1 |
The payload exceeds the maximum size allowed.
Name | Data Type | Description | ||||
---|---|---|---|---|---|---|
message
|
ErrorMessage |
The message for the exception. |
||||
|
The specified resource does not exist.
Name | Data Type | Description | ||||
---|---|---|---|---|---|---|
message
|
errorMessage |
The message for the exception. |
||||
|
The service is temporarily unavailable.
Name | Data Type | Description | ||||
---|---|---|---|---|---|---|
message
|
errorMessage |
The message for the exception. |
||||
|
Name | Data Type | Description |
---|---|---|
ThingName
|
string Pattern: [a-zA-Z0-9_-]+ Minimum: 1 Maximum: 128 |
The rate exceeds the limit.
Name | Data Type | Description | ||||
---|---|---|---|---|---|---|
message
|
errorMessage |
The message for the exception. |
||||
|
Name | Data Type | Description |
---|---|---|
Topic
|
string |
You are not authorized to perform this operation.
Name | Data Type | Description | ||||
---|---|---|---|---|---|---|
message
|
errorMessage |
The message for the exception. |
||||
|
The document encoding is not supported.
Name | Data Type | Description | ||||
---|---|---|---|---|---|---|
message
|
errorMessage |
The message for the exception. |
||||
|
The input for the UpdateThingShadow operation.
Name | Data Type | Description | ||||
---|---|---|---|---|---|---|
payload
|
JsonDocument |
The state information, in JSON format. |
||||
|
The output from the UpdateThingShadow operation.
Name | Data Type | Description | ||||
---|---|---|---|---|---|---|
payload
|
JsonDocument |
The state information, in JSON format. |
||||
|
Name | Data Type | Description |
---|---|---|
errorMessage
|
string |
Amazon Signature authorization v4
header
Authorization
awsSigv4
Name | AWS |
External URL | https://docs.aws.amazon.com/iot/index.html |
@PermittedSoc |
Release | v4 |
Provider Name | amazonaws.com |
Service Name | iot-data |
Origin - ContentType | application/json |
Origin - Url | https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/iot-data-2015-05-28.normal.json |
Origin - X-apisguru-driver | external |
Api Client Registration | https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct |
Preferred | Yes |
API Version | 2015-05-28 |
Servers |
|