{ "version": "2.0", "service": "IoT data

IoT data enables secure, bi-directional communication between Internet-connected things (such as sensors, actuators, embedded devices, or smart appliances) and the Amazon Web Services cloud. It implements a broker for applications and things to publish messages over HTTP (Publish) and retrieve, update, and delete shadows. A shadow is a persistent representation of your things and their state in the Amazon Web Services cloud.

Find the endpoint address for actions in IoT data by running this CLI command:

aws iot describe-endpoint --endpoint-type iot:Data-ATS

The service name used by Amazon Web ServicesSignature Version 4 to sign requests is: iotdevicegateway.

", "operations": { "DeleteThingShadow": "

Deletes the shadow for the specified thing.

Requires permission to access the DeleteThingShadow action.

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

", "GetRetainedMessage": "

Gets the details of a single retained message for the specified topic.

This action returns the message payload of the retained message, which can incur messaging costs. To list only the topic names of the retained messages, call ListRetainedMessages.

Requires permission to access the GetRetainedMessage action.

For more information about messaging costs, see IoT Core pricing - Messaging.

", "GetThingShadow": "

Gets the shadow for the specified thing.

Requires permission to access the GetThingShadow action.

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

", "ListNamedShadowsForThing": "

Lists the shadows for the specified thing.

Requires permission to access the ListNamedShadowsForThing action.

", "ListRetainedMessages": "

Lists summary information about the retained messages stored for the account.

This action returns only the topic names of the retained messages. It doesn't return any message payloads. Although this action doesn't return a message payload, it can still incur messaging costs.

To get the message payload of a retained message, call GetRetainedMessage with the topic name of the retained message.

Requires permission to access the ListRetainedMessages action.

For more information about messaging costs, see IoT Core pricing - Messaging.

", "Publish": "

Publishes an MQTT message.

Requires permission to access the Publish action.

For more information about MQTT messages, see MQTT Protocol in the IoT Developer Guide.

For more information about messaging costs, see IoT Core pricing - Messaging.

", "UpdateThingShadow": "

Updates the shadow for the specified thing.

Requires permission to access the UpdateThingShadow action.

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

" }, "shapes": { "ConflictException": { "base": "

The specified version does not match the version of the document.

", "refs": { } }, "DeleteThingShadowRequest": { "base": "

The input for the DeleteThingShadow operation.

", "refs": { } }, "DeleteThingShadowResponse": { "base": "

The output from the DeleteThingShadow operation.

", "refs": { } }, "GetRetainedMessageRequest": { "base": "

The input for the GetRetainedMessage operation.

", "refs": { } }, "GetRetainedMessageResponse": { "base": "

The output from the GetRetainedMessage operation.

", "refs": { } }, "GetThingShadowRequest": { "base": "

The input for the GetThingShadow operation.

", "refs": { } }, "GetThingShadowResponse": { "base": "

The output from the GetThingShadow operation.

", "refs": { } }, "InternalFailureException": { "base": "

An unexpected error has occurred.

", "refs": { } }, "InvalidRequestException": { "base": "

The request is not valid.

", "refs": { } }, "JsonDocument": { "base": null, "refs": { "DeleteThingShadowResponse$payload": "

The state information, in JSON format.

", "GetThingShadowResponse$payload": "

The state information, in JSON format.

", "UpdateThingShadowRequest$payload": "

The state information, in JSON format.

", "UpdateThingShadowResponse$payload": "

The state information, in JSON format.

" } }, "ListNamedShadowsForThingRequest": { "base": null, "refs": { } }, "ListNamedShadowsForThingResponse": { "base": null, "refs": { } }, "ListRetainedMessagesRequest": { "base": null, "refs": { } }, "ListRetainedMessagesResponse": { "base": null, "refs": { } }, "MaxResults": { "base": null, "refs": { "ListRetainedMessagesRequest$maxResults": "

The maximum number of results to return at one time.

" } }, "MethodNotAllowedException": { "base": "

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

", "refs": { } }, "NamedShadowList": { "base": null, "refs": { "ListNamedShadowsForThingResponse$results": "

The list of shadows for the specified thing.

" } }, "NextToken": { "base": null, "refs": { "ListNamedShadowsForThingRequest$nextToken": "

The token to retrieve the next set of results.

", "ListNamedShadowsForThingResponse$nextToken": "

The token to use to get the next set of results, or null if there are no additional results.

", "ListRetainedMessagesRequest$nextToken": "

To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

", "ListRetainedMessagesResponse$nextToken": "

The token for the next set of results, or null if there are no additional results.

" } }, "PageSize": { "base": null, "refs": { "ListNamedShadowsForThingRequest$pageSize": "

The result page size.

" } }, "Payload": { "base": null, "refs": { "GetRetainedMessageResponse$payload": "

The Base64-encoded message payload of the retained message body.

", "PublishRequest$payload": "

The message body. MQTT accepts text, binary, and empty (null) message payloads.

Publishing an empty (null) payload with retain = true deletes the retained message identified by topic from IoT Core.

" } }, "PayloadSize": { "base": null, "refs": { "RetainedMessageSummary$payloadSize": "

The size of the retained message's payload in bytes.

" } }, "PublishRequest": { "base": "

The input for the Publish operation.

", "refs": { } }, "Qos": { "base": null, "refs": { "GetRetainedMessageResponse$qos": "

The quality of service (QoS) level used to publish the retained message.

", "PublishRequest$qos": "

The Quality of Service (QoS) level.

", "RetainedMessageSummary$qos": "

The quality of service (QoS) level used to publish the retained message.

" } }, "RequestEntityTooLargeException": { "base": "

The payload exceeds the maximum size allowed.

", "refs": { } }, "ResourceNotFoundException": { "base": "

The specified resource does not exist.

", "refs": { } }, "Retain": { "base": null, "refs": { "PublishRequest$retain": "

A Boolean value that determines whether to set the RETAIN flag when the message is published.

Setting the RETAIN flag causes the message to be retained and sent to new subscribers to the topic.

Valid values: true | false

Default value: false

" } }, "RetainedMessageList": { "base": null, "refs": { "ListRetainedMessagesResponse$retainedTopics": "

A summary list the account's retained messages. The information returned doesn't include the message payloads of the retained messages.

" } }, "RetainedMessageSummary": { "base": "

Information about a single retained message.

", "refs": { "RetainedMessageList$member": null } }, "ServiceUnavailableException": { "base": "

The service is temporarily unavailable.

", "refs": { } }, "ShadowName": { "base": null, "refs": { "DeleteThingShadowRequest$shadowName": "

The name of the shadow.

", "GetThingShadowRequest$shadowName": "

The name of the shadow.

", "NamedShadowList$member": null, "UpdateThingShadowRequest$shadowName": "

The name of the shadow.

" } }, "ThingName": { "base": null, "refs": { "DeleteThingShadowRequest$thingName": "

The name of the thing.

", "GetThingShadowRequest$thingName": "

The name of the thing.

", "ListNamedShadowsForThingRequest$thingName": "

The name of the thing.

", "UpdateThingShadowRequest$thingName": "

The name of the thing.

" } }, "ThrottlingException": { "base": "

The rate exceeds the limit.

", "refs": { } }, "Timestamp": { "base": null, "refs": { "GetRetainedMessageResponse$lastModifiedTime": "

The Epoch date and time, in milliseconds, when the retained message was stored by IoT.

", "ListNamedShadowsForThingResponse$timestamp": "

The Epoch date and time the response was generated by IoT.

", "RetainedMessageSummary$lastModifiedTime": "

The Epoch date and time, in milliseconds, when the retained message was stored by IoT.

" } }, "Topic": { "base": null, "refs": { "GetRetainedMessageRequest$topic": "

The topic name of the retained message to retrieve.

", "GetRetainedMessageResponse$topic": "

The topic name to which the retained message was published.

", "PublishRequest$topic": "

The name of the MQTT topic.

", "RetainedMessageSummary$topic": "

The topic name to which the retained message was published.

" } }, "UnauthorizedException": { "base": "

You are not authorized to perform this operation.

", "refs": { } }, "UnsupportedDocumentEncodingException": { "base": "

The document encoding is not supported.

", "refs": { } }, "UpdateThingShadowRequest": { "base": "

The input for the UpdateThingShadow operation.

", "refs": { } }, "UpdateThingShadowResponse": { "base": "

The output from the UpdateThingShadow operation.

", "refs": { } }, "errorMessage": { "base": null, "refs": { "ConflictException$message": "

The message for the exception.

", "InternalFailureException$message": "

The message for the exception.

", "InvalidRequestException$message": "

The message for the exception.

", "MethodNotAllowedException$message": "

The message for the exception.

", "RequestEntityTooLargeException$message": "

The message for the exception.

", "ResourceNotFoundException$message": "

The message for the exception.

", "ServiceUnavailableException$message": "

The message for the exception.

", "ThrottlingException$message": "

The message for the exception.

", "UnauthorizedException$message": "

The message for the exception.

", "UnsupportedDocumentEncodingException$message": "

The message for the exception.

" } } } }