Amazon Web Services - API AWS IoT Data Plane

Amazon Web Services / AWS IoT Data Plane

AWS IoT Data Plane

AWS IoT

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.

License: Apache 2.0 License

Resources

DELETE

/things/{thingName}/shadow

Deletes the thing shadow for the specified thing.

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

Request

Path

Name	Data Type	Description
`thingName`	string Pattern: `[a-zA-Z0-9_-]+` Minimum: 1 Maximum: 128	The name of the thing.

Header

Name	Data Type	Description
`X-Amz-Content-Sha256`	string
`X-Amz-Date`	string
`X-Amz-Algorithm`	string
`X-Amz-Credential`	string
`X-Amz-Security-Token`	string
`X-Amz-Signature`	string
`X-Amz-SignedHeaders`	string

Responses

200Success

Body

Name	Data Type	Description
`DeleteThingShadowResponse`	object	The output from the DeleteThingShadow operation.

Properties


                        payload

JsonDocument

The state information, in JSON format.

JsonDocument string

480ResourceNotFoundException

Body

Name	Data Type	Description
`ResourceNotFoundException`	object	The specified resource does not exist.

Properties


                        message

errorMessage

The message for the exception.

errorMessage string

481InvalidRequestException

Body

Name	Data Type	Description
`InvalidRequestException`	object	The request is not valid.

Properties


                        message

errorMessage

The message for the exception.

errorMessage string

482ThrottlingException

Body

Name	Data Type	Description
`ThrottlingException`	object	The rate exceeds the limit.

Properties


                        message

errorMessage

The message for the exception.

errorMessage string

483UnauthorizedException

Body

Name	Data Type	Description
`UnauthorizedException`	object	You are not authorized to perform this operation.

Properties


                        message

errorMessage

The message for the exception.

errorMessage string

484ServiceUnavailableException

Body

Name	Data Type	Description
`ServiceUnavailableException`	object	The service is temporarily unavailable.

Properties


                        message

errorMessage

The message for the exception.

errorMessage string

485InternalFailureException

Body

Name	Data Type	Description
`InternalFailureException`	object	An unexpected error has occurred.

Properties


                        message

errorMessage

The message for the exception.

errorMessage string

486MethodNotAllowedException

Body

Name	Data Type	Description
`MethodNotAllowedException`	object	The specified combination of HTTP verb and URI is not supported.

Properties


                        message

ErrorMessage

The message for the exception.

ErrorMessage string

487UnsupportedDocumentEncodingException

Body

Name	Data Type	Description
`UnsupportedDocumentEncodingException`	object	The document encoding is not supported.

Properties


                        message

errorMessage

The message for the exception.

errorMessage string

GET

/things/{thingName}/shadow

Gets the thing shadow for the specified thing.

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

Request

Path

Name	Data Type	Description
`thingName`	string Pattern: `[a-zA-Z0-9_-]+` Minimum: 1 Maximum: 128	The name of the thing.

Header

Name	Data Type	Description
`X-Amz-Content-Sha256`	string
`X-Amz-Date`	string
`X-Amz-Algorithm`	string
`X-Amz-Credential`	string
`X-Amz-Security-Token`	string
`X-Amz-Signature`	string
`X-Amz-SignedHeaders`	string

Responses

200Success

Body

Name	Data Type	Description
`GetThingShadowResponse`	object	The output from the GetThingShadow operation.

Properties


                        payload

JsonDocument

The state information, in JSON format.

JsonDocument string

480InvalidRequestException

Body

Name	Data Type	Description
`InvalidRequestException`	object	The request is not valid.

Properties


                        message

errorMessage

The message for the exception.

errorMessage string

481ResourceNotFoundException

Body

Name	Data Type	Description
`ResourceNotFoundException`	object	The specified resource does not exist.

Properties


                        message

errorMessage

The message for the exception.

errorMessage string

482ThrottlingException

Body

Name	Data Type	Description
`ThrottlingException`	object	The rate exceeds the limit.

Properties


                        message

errorMessage

The message for the exception.

errorMessage string

483UnauthorizedException

Body

Name	Data Type	Description
`UnauthorizedException`	object	You are not authorized to perform this operation.

Properties


                        message

errorMessage

The message for the exception.

errorMessage string

484ServiceUnavailableException

Body

Name	Data Type	Description
`ServiceUnavailableException`	object	The service is temporarily unavailable.

Properties


                        message

errorMessage

The message for the exception.

errorMessage string

485InternalFailureException

Body

Name	Data Type	Description
`InternalFailureException`	object	An unexpected error has occurred.

Properties


                        message

errorMessage

The message for the exception.

errorMessage string

486MethodNotAllowedException

Body

Name	Data Type	Description
`MethodNotAllowedException`	object	The specified combination of HTTP verb and URI is not supported.

Properties


                        message

ErrorMessage

The message for the exception.

ErrorMessage string

487UnsupportedDocumentEncodingException

Body

Name	Data Type	Description
`UnsupportedDocumentEncodingException`	object	The document encoding is not supported.

Properties


                        message

errorMessage

The message for the exception.

errorMessage string

POST

/things/{thingName}/shadow

Updates the thing shadow for the specified thing.

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

Request

Path

Name	Data Type	Description
`thingName`	string Pattern: `[a-zA-Z0-9_-]+` Minimum: 1 Maximum: 128	The name of the thing.

Header

Name	Data Type	Description
`X-Amz-Content-Sha256`	string
`X-Amz-Date`	string
`X-Amz-Algorithm`	string
`X-Amz-Credential`	string
`X-Amz-Security-Token`	string
`X-Amz-Signature`	string
`X-Amz-SignedHeaders`	string

Body

Name	Data Type	Description
`body`	object

Properties


                        payload

string

The state information, in JSON format.

Responses

200Success

Body

Name	Data Type	Description
`UpdateThingShadowResponse`	object	The output from the UpdateThingShadow operation.

Properties


                        payload

JsonDocument

The state information, in JSON format.

JsonDocument string

480ConflictException

Body

Name	Data Type	Description
`ConflictException`	object	The specified version does not match the version of the document.

Properties


                        message

ErrorMessage

The message for the exception.

ErrorMessage string

481RequestEntityTooLargeException

Body

Name	Data Type	Description
`RequestEntityTooLargeException`	object	The payload exceeds the maximum size allowed.

Properties


                        message

ErrorMessage

The message for the exception.

ErrorMessage string

482InvalidRequestException

Body

Name	Data Type	Description
`InvalidRequestException`	object	The request is not valid.

Properties


                        message

errorMessage

The message for the exception.

errorMessage string

483ThrottlingException

Body

Name	Data Type	Description
`ThrottlingException`	object	The rate exceeds the limit.

Properties


                        message

errorMessage

The message for the exception.

errorMessage string

484UnauthorizedException

Body

Name	Data Type	Description
`UnauthorizedException`	object	You are not authorized to perform this operation.

Properties


                        message

errorMessage

The message for the exception.

errorMessage string

485ServiceUnavailableException

Body

Name	Data Type	Description
`ServiceUnavailableException`	object	The service is temporarily unavailable.

Properties


                        message

errorMessage

The message for the exception.

errorMessage string

486InternalFailureException

Body

Name	Data Type	Description
`InternalFailureException`	object	An unexpected error has occurred.

Properties


                        message

errorMessage

The message for the exception.

errorMessage string

487MethodNotAllowedException

Body

Name	Data Type	Description
`MethodNotAllowedException`	object	The specified combination of HTTP verb and URI is not supported.

Properties


                        message

ErrorMessage

The message for the exception.

ErrorMessage string

488UnsupportedDocumentEncodingException

Body

Name	Data Type	Description
`UnsupportedDocumentEncodingException`	object	The document encoding is not supported.

Properties


                        message

errorMessage

The message for the exception.

errorMessage string

POST

/topics/{topic}

Publishes state information.

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

Request

Path

Name	Data Type	Description
`topic`	string	The name of the MQTT topic.

Query

Name	Data Type	Description
`qos`	integer Minimum: 0 Maximum: 1	The Quality of Service (QoS) level.

Header

Name	Data Type	Description
`X-Amz-Content-Sha256`	string
`X-Amz-Date`	string
`X-Amz-Algorithm`	string
`X-Amz-Credential`	string
`X-Amz-Security-Token`	string
`X-Amz-Signature`	string
`X-Amz-SignedHeaders`	string

Body

Name	Data Type	Description
`body`	object

Properties


                        payload

string

The state information, in JSON format.

Responses

200Success

480InternalFailureException

Body

Name	Data Type	Description
`InternalFailureException`	object	An unexpected error has occurred.

Properties


                        message

errorMessage

The message for the exception.

errorMessage string

481InvalidRequestException

Body

Name	Data Type	Description
`InvalidRequestException`	object	The request is not valid.

Properties


                        message

errorMessage

The message for the exception.

errorMessage string

482UnauthorizedException

Body

Name	Data Type	Description
`UnauthorizedException`	object	You are not authorized to perform this operation.

Properties


                        message

errorMessage

The message for the exception.

errorMessage string

483MethodNotAllowedException

Body

Name	Data Type	Description
`MethodNotAllowedException`	object	The specified combination of HTTP verb and URI is not supported.

Properties


                        message

ErrorMessage

The message for the exception.

ErrorMessage string

Models

ConflictException

DeleteThingShadowRequest

DeleteThingShadowResponse

ErrorMessage

GetThingShadowRequest

GetThingShadowResponse

InternalFailureException

InvalidRequestException

JsonDocument

MethodNotAllowedException

Payload

PublishRequest

Qos

RequestEntityTooLargeException

ResourceNotFoundException

ServiceUnavailableException

ThingName

ThrottlingException

Topic

UnauthorizedException

UnsupportedDocumentEncodingException

UpdateThingShadowRequest

UpdateThingShadowResponse

errorMessage

Authentication

Api Key

Amazon Signature authorization v4

Location: header
Header Name: Authorization
Amazon-apigateway-authtype: awsSigv4

Contact

Name	`AWS`
External URL	`https://docs.aws.amazon.com/iot/index.html`
Twitter	`@PermittedSoc`

Metadata (Technical Details)

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	[ { "url": "http://data.iot.{region}.amazonaws.com", "variables": { "region": { "description": "The AWS region", "enum": [ "us-east-1", "us-east-2", "us-west-1", "us-west-2", "us-gov-west-1", "us-gov-east-1", "ca-central-1", "eu-north-1", "eu-west-1", "eu-west-2", "eu-west-3", "eu-central-1", "ap-northeast-1", "ap-northeast-2", "ap-northeast-3", "ap-southeast-1", "ap-southeast-2", "ap-south-1", "sa-east-1" ], "default": "us-east-1" } }, "description": "The AWS IoT Data Plane multi-region endpoint" }, { "url": "https://data.iot.{region}.amazonaws.com", "variables": { "region": { "description": "The AWS region", "enum": [ "us-east-1", "us-east-2", "us-west-1", "us-west-2", "us-gov-west-1", "us-gov-east-1", "ca-central-1", "eu-north-1", "eu-west-1", "eu-west-2", "eu-west-3", "eu-central-1", "ap-northeast-1", "ap-northeast-2", "ap-northeast-3", "ap-southeast-1", "ap-southeast-2", "ap-south-1", "sa-east-1" ], "default": "us-east-1" } }, "description": "The AWS IoT Data Plane multi-region endpoint" }, { "url": "http://data.iot.{region}.amazonaws.com.cn", "variables": { "region": { "description": "The AWS region", "enum": [ "cn-north-1", "cn-northwest-1" ], "default": "cn-north-1" } }, "description": "The AWS IoT Data Plane endpoint for China (Beijing) and China (Ningxia)" }, { "url": "https://data.iot.{region}.amazonaws.com.cn", "variables": { "region": { "description": "The AWS region", "enum": [ "cn-north-1", "cn-northwest-1" ], "default": "cn-north-1" } }, "description": "The AWS IoT Data Plane endpoint for China (Beijing) and China (Ningxia)" } ]

Comments

Loading comments ...