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": { "DeleteConnection": "Disconnects a connected MQTT client from Amazon Web Services IoT Core. When you disconnect a client, Amazon Web Services IoT Core closes the client's network connection and optionally cleans the session state.
Requires permission to access the DeleteConnection action.
", "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.
", "GetConnection": "Retrieves connection information for the specified MQTT client.
Requires permission to access the GetConnection action.
", "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 Amazon Web Services 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 Amazon Web Services IoT Core pricing - Messaging.
", "ListSubscriptions": "Returns a list of all subscriptions for MQTT clients with active sessions, including offline clients with persistent sessions.
Requires permission to access the ListSubscriptions action.
", "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 Amazon Web Services IoT Core pricing - Messaging.
", "SendDirectMessage": "Sends an MQTT message directly to a specific client identified by its client ID.
SendDirectMessage targets a single client ID. The receiving client does not need to subscribe to the topic, but the receiver's policy must allow iot:Receive on the specified topic.
Requires permission to access the SendDirectMessage action.
For more information about messaging costs, see Amazon Web Services IoT Core pricing.
", "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": { "CleanSession": { "base": null, "refs": { "DeleteConnectionRequest$cleanSession": "Specifies whether to remove the client's persistent session state when disconnecting. Set to TRUE to delete all session information, including subscriptions and queued messages. Set to FALSE to preserve the session state for persistent sessions. For clean sessions this parameter will be ignored. By default, this is set to FALSE (preserves the session state).
Indicates whether the client is using a clean session. Returns true for clean sessions or false for persistent sessions.
The unique identifier of the MQTT client to disconnect. The client ID can't start with a dollar sign ($).
MQTT client IDs must be URL encoded (percent-encoded) when they contain characters that are not valid in HTTP requests, such as spaces, forward slashes (/), and UTF-8 characters.
", "GetConnectionRequest$clientId": "The unique identifier of the MQTT client to retrieve connection information. The client ID can't start with a dollar sign ($).
MQTT client IDs must be URL encoded (percent-encoded) when they contain characters that are not valid in HTTP requests, such as spaces, forward slashes (/), and UTF-8 characters.
", "GetConnectionResponse$clientId": "The unique identifier of the MQTT client. This is the same client ID that was used when the client established the connection.
", "ListSubscriptionsRequest$clientId": "The unique identifier of the MQTT client to list subscriptions for. The client ID can't start with a dollar sign ($).
MQTT client IDs must be URL encoded (percent-encoded) when they contain characters that are not valid in HTTP requests, such as spaces, forward slashes (/), and UTF-8 characters.
", "SendDirectMessageRequest$clientId": "The unique identifier of the MQTT client to send the message to.
Client IDs must not exceed 128 characters and can't start with a dollar sign ($). MQTT client IDs must be URL encoded (percent-encoded) when they contain characters that are not valid in HTTP requests, such as spaces, forward slashes (/), and UTF-8 characters. For more information, see Amazon Web Services IoT Core message broker and protocol limits and quotas.
" } }, "Confirmation": { "base": null, "refs": { "SendDirectMessageRequest$confirmation": "A Boolean value that specifies whether to wait for delivery confirmation from the receiving client.
When set to true, the API delivers the message at QoS 1 and waits for the client to send a delivery confirmation (PUBACK) before returning a successful response. If delivery confirmation is not received within the specified timeout period, the API returns HTTP 504.
When set to false, the API delivers the message at QoS 0 and returns after Amazon Web Services IoT Core attempts to deliver the message.
Valid values: true | false
Default value: false
The specified version does not match the version of the document.
", "refs": {} }, "Connected": { "base": null, "refs": { "GetConnectionResponse$connected": "The connection state of the client. Returns true if the client is currently connected, or false if the client is not connected.
A UTF-8 encoded string that describes the content of the publishing message.
", "SendDirectMessageRequest$contentType": "The MQTT5 content type property forwarded to the receiving client (for example, application/json).
The base64-encoded binary data used by the sender of the request message to identify which request the response message is for when it's received. correlationData is an HTTP header value in the API.
The base64-encoded binary data used by the sender of the request message to identify which request the response message is for when it's received. correlationData is an HTTP header value in the API.
The input for the DeleteThingShadow operation.
", "refs": {} }, "DeleteThingShadowResponse": { "base": "The output from the DeleteThingShadow operation.
", "refs": {} }, "DisconnectReason": { "base": null, "refs": { "GetConnectionResponse$disconnectReason": "The reason for the last disconnection, if the client is currently disconnected. See the developer guide for valid disconnect reasons.
" } }, "ForbiddenException": { "base": "The caller isn't authorized to make the request.
", "refs": {} }, "GatewayTimeoutException": { "base": "The delivery confirmation was not received from the client within the specified timeout period.
", "refs": {} }, "GetConnectionRequest": { "base": null, "refs": {} }, "GetConnectionResponse": { "base": null, "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": {} }, "IncludeSocketInformation": { "base": null, "refs": { "GetConnectionRequest$includeSocketInformation": "Specifies if socket information (sourcePort, targetPort, sourceIp, targetIp) should be included in the GetConnection response. Set to TRUE to include socket information. Set to FALSE to omit socket information. By default, this is set to FALSE. See the developer guide for how to authorize this parameter.
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.
" } }, "KeepAliveDuration": { "base": null, "refs": { "GetConnectionResponse$keepAliveDuration": "The keep-alive interval in seconds that the client specified when establishing the connection.
" } }, "ListNamedShadowsForThingRequest": { "base": null, "refs": {} }, "ListNamedShadowsForThingResponse": { "base": null, "refs": {} }, "ListRetainedMessagesRequest": { "base": null, "refs": {} }, "ListRetainedMessagesResponse": { "base": null, "refs": {} }, "ListSubscriptionsRequest": { "base": null, "refs": {} }, "ListSubscriptionsResponse": { "base": null, "refs": {} }, "MaxResults": { "base": null, "refs": { "ListRetainedMessagesRequest$maxResults": "The maximum number of results to return at one time.
", "ListSubscriptionsRequest$maxResults": "The maximum number of subscriptions to return in a single request. By default, this is set to 20.
" } }, "MessageExpiry": { "base": null, "refs": { "PublishRequest$messageExpiry": "A user-defined integer value that represents the message expiry interval in seconds. If absent, the message doesn't expire. For more information about the limits of messageExpiry, see Amazon Web Services IoT Core message broker and protocol limits and quotas from the Amazon Web Services Reference Guide.
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.
The token for the next set of results, or null if there are no additional results.
", "ListSubscriptionsRequest$nextToken": "To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.
The token to use to get 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 Amazon Web Services IoT Core.
The message body. MQTT accepts text, binary, and empty (null) message payloads.
" } }, "PayloadFormatIndicator": { "base": null, "refs": { "PublishRequest$payloadFormatIndicator": "An Enum string value that indicates whether the payload is formatted as UTF-8. payloadFormatIndicator is an HTTP header value in the API.
An Enum string value that indicates whether the payload is formatted as UTF-8. payloadFormatIndicator is an HTTP header value in the API.
The size of the retained message's payload in bytes.
" } }, "PreventWillMessage": { "base": null, "refs": { "DeleteConnectionRequest$preventWillMessage": "Controls if Amazon Web Services IoT Core publishes the client's Last Will and Testament (LWT) message upon disconnection. Set to TRUE to prevent publishing the LWT message. Set to FALSE to ensure that LWT is published. By default, this is set to FALSE (LWT message is published).
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. The default QoS level is 0.
", "RetainedMessageSummary$qos": "The quality of service (QoS) level used to publish the retained message.
", "SubscriptionSummary$qos": "The Quality of Service (QoS) level for the subscription. Valid values are 0 (at most once) and 1 (at least once).
" } }, "RequestEntityTooLargeException": { "base": "The payload exceeds the maximum size allowed.
", "refs": {} }, "ResourceNotFoundException": { "base": "The specified resource does not exist.
", "refs": {} }, "ResponseMessage": { "base": null, "refs": { "SendDirectMessageResponse$message": "The status message indicating the result of the operation.
" } }, "ResponseTopic": { "base": null, "refs": { "PublishRequest$responseTopic": "A UTF-8 encoded string that's used as the topic name for a response message. The response topic is used to describe the topic which the receiver should publish to as part of the request-response flow. The topic must not contain wildcard characters.
", "SendDirectMessageRequest$responseTopic": "A UTF-8 encoded string that's used as the topic name for a response message. The response topic describes the topic which the receiver should publish to as part of the request-response flow. The topic must not contain wildcard characters. For more information, see Amazon Web Services IoT Core message broker and protocol limits and quotas.
" } }, "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
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 } }, "SendDirectMessageRequest": { "base": null, "refs": {} }, "SendDirectMessageResponse": { "base": "The output from the SendDirectMessage operation.
", "refs": {} }, "ServiceUnavailableException": { "base": "The service is temporarily unavailable.
", "refs": {} }, "SessionExpiry": { "base": null, "refs": { "GetConnectionResponse$sessionExpiry": "The session expiry interval in seconds for the MQTT client connection. This is configured by the user. This value indicates how long the session will remain active after the client disconnects.
" } }, "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.
" } }, "SourceIp": { "base": null, "refs": { "GetConnectionResponse$sourceIp": "The IP address of the client that initiated the connection.
" } }, "SourcePort": { "base": null, "refs": { "GetConnectionResponse$sourcePort": "The client's source port.
" } }, "SubscriptionList": { "base": null, "refs": { "ListSubscriptionsResponse$subscriptions": "A list of topic filters and their associated Quality of Service (QoS) levels that the client is subscribed to.
" } }, "SubscriptionSummary": { "base": "Contains information about a subscription for an MQTT client, including the topic filter and Quality of Service (QoS) level.
", "refs": { "SubscriptionList$member": null } }, "TargetIp": { "base": null, "refs": { "GetConnectionResponse$targetIp": "The IP address of the Amazon Web Services IoT Core endpoint that the client connected to. For clients connected to VPC endpoints, this is the private IP address of the network interface the client is connected to.
" } }, "TargetPort": { "base": null, "refs": { "GetConnectionResponse$targetPort": "The port number of the Amazon Web Services IoT Core endpoint that the client connected to.
" } }, "ThingName": { "base": null, "refs": { "DeleteThingShadowRequest$thingName": "The name of the thing.
", "GetConnectionResponse$thingName": "The name of the thing associated with the principal of the MQTT client, if applicable.
", "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": {} }, "TimeoutInSeconds": { "base": null, "refs": { "SendDirectMessageRequest$timeout": "An integer that represents the maximum time, in seconds, to wait for a delivery confirmation (PUBACK) from the receiving client after the message has been delivered. This parameter is only used when confirmation is set to true. If confirmation is false, this parameter is ignored.
The total API response time may be higher than this value due to internal processing. Set your HTTP client timeout to a value greater than this parameter.
Valid range: 1 to 15 seconds.
Default value: 5 seconds.
Unix timestamp (in milliseconds) indicating when the client connected. Present only when connected is true.
", "GetConnectionResponse$disconnectedSince": "Unix timestamp (in milliseconds) indicating when the client disconnected. Present only when connected is false. This information is available for 30 minutes after the client disconnects.
", "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.
", "SendDirectMessageRequest$topic": "The topic of the outbound MQTT Publish message to the receiving client. For more information, see Amazon Web Services IoT Core message broker and protocol limits and quotas.
" } }, "TopicFilter": { "base": null, "refs": { "SubscriptionSummary$topicFilter": "The topic filter pattern that the client is subscribed to. May include MQTT wildcards such as + (single-level) and # (multi-level).
" } }, "TraceId": { "base": null, "refs": { "SendDirectMessageResponse$traceId": "A unique identifier for the request. Include this value when contacting Amazon Web Services Support for troubleshooting.
" } }, "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": {} }, "UserProperties": { "base": null, "refs": { "PublishRequest$userProperties": "A JSON string that contains an array of JSON objects. If you don’t use Amazon Web Services SDK or CLI, you must encode the JSON string to base64 format before adding it to the HTTP header. userProperties is an HTTP header value in the API.
The following example userProperties parameter is a JSON string which represents two User Properties. Note that it needs to be base64-encoded:
[{\"deviceName\": \"alpha\"}, {\"deviceCnt\": \"45\"}]
A JSON string that contains an array of JSON objects. If you don't use Amazon Web Services SDK or CLI, you must encode the JSON string to base64 format before adding it to the HTTP header. userProperties is an HTTP header value in the API.
For MQTT 3.1.1 clients, user properties are silently dropped.
The following example userProperties parameter is a JSON string which represents two User Properties. Note that it needs to be base64-encoded:
[{\"deviceName\": \"alpha\"}, {\"deviceCnt\": \"45\"}]
A base64-encoded JSON string that includes an array of JSON objects, or null if the retained message doesn't include any user properties.
The following example userProperties parameter is a JSON string that represents two user properties. Note that it will be base64-encoded:
[{\"deviceName\": \"alpha\"}, {\"deviceCnt\": \"45\"}]
The ID of the VPC endpoint. Present for clients connected to IoT Core via a VPC endpoint.
" } }, "errorMessage": { "base": null, "refs": { "ConflictException$message": "The message for the exception.
", "ForbiddenException$message": null, "GatewayTimeoutException$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.
" } } } }