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":{ "name":"GetRetainedMessage", "http":{ "method":"GET", "requestUri":"/retainedMessage/{topic}" }, "input":{"shape":"GetRetainedMessageRequest"}, "output":{"shape":"GetRetainedMessageResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"UnauthorizedException"}, {"shape":"ServiceUnavailableException"}, {"shape":"InternalFailureException"}, {"shape":"MethodNotAllowedException"} ], "documentation":"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":{ "name":"GetThingShadow", "http":{ "method":"GET", "requestUri":"/things/{thingName}/shadow" }, "input":{"shape":"GetThingShadowRequest"}, "output":{"shape":"GetThingShadowResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"UnauthorizedException"}, {"shape":"ServiceUnavailableException"}, {"shape":"InternalFailureException"}, {"shape":"MethodNotAllowedException"}, {"shape":"UnsupportedDocumentEncodingException"} ], "documentation":"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":{ "name":"ListNamedShadowsForThing", "http":{ "method":"GET", "requestUri":"/api/things/shadow/ListNamedShadowsForThing/{thingName}" }, "input":{"shape":"ListNamedShadowsForThingRequest"}, "output":{"shape":"ListNamedShadowsForThingResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InvalidRequestException"}, {"shape":"ThrottlingException"}, {"shape":"UnauthorizedException"}, {"shape":"ServiceUnavailableException"}, {"shape":"InternalFailureException"}, {"shape":"MethodNotAllowedException"} ], "documentation":"Lists the shadows for the specified thing.
Requires permission to access the ListNamedShadowsForThing action.
" }, "ListRetainedMessages":{ "name":"ListRetainedMessages", "http":{ "method":"GET", "requestUri":"/retainedMessage" }, "input":{"shape":"ListRetainedMessagesRequest"}, "output":{"shape":"ListRetainedMessagesResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"ThrottlingException"}, {"shape":"UnauthorizedException"}, {"shape":"ServiceUnavailableException"}, {"shape":"InternalFailureException"}, {"shape":"MethodNotAllowedException"} ], "documentation":"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.
" }, "Publish":{ "name":"Publish", "http":{ "method":"POST", "requestUri":"/topics/{topic}" }, "input":{"shape":"PublishRequest"}, "errors":[ {"shape":"InternalFailureException"}, {"shape":"InvalidRequestException"}, {"shape":"UnauthorizedException"}, {"shape":"MethodNotAllowedException"}, {"shape":"ThrottlingException"} ], "documentation":"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.
" }, "UpdateThingShadow":{ "name":"UpdateThingShadow", "http":{ "method":"POST", "requestUri":"/things/{thingName}/shadow" }, "input":{"shape":"UpdateThingShadowRequest"}, "output":{"shape":"UpdateThingShadowResponse"}, "errors":[ {"shape":"ConflictException"}, {"shape":"RequestEntityTooLargeException"}, {"shape":"InvalidRequestException"}, {"shape":"ThrottlingException"}, {"shape":"UnauthorizedException"}, {"shape":"ServiceUnavailableException"}, {"shape":"InternalFailureException"}, {"shape":"MethodNotAllowedException"}, {"shape":"UnsupportedDocumentEncodingException"} ], "documentation":"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":{ "type":"structure", "members":{ "message":{ "shape":"errorMessage", "documentation":"The message for the exception.
" } }, "documentation":"The specified version does not match the version of the document.
", "error":{"httpStatusCode":409}, "exception":true }, "ContentType":{"type":"string"}, "CorrelationData":{"type":"string"}, "DeleteThingShadowRequest":{ "type":"structure", "required":["thingName"], "members":{ "thingName":{ "shape":"ThingName", "documentation":"The name of the thing.
", "location":"uri", "locationName":"thingName" }, "shadowName":{ "shape":"ShadowName", "documentation":"The name of the shadow.
", "location":"querystring", "locationName":"name" } }, "documentation":"The input for the DeleteThingShadow operation.
" }, "DeleteThingShadowResponse":{ "type":"structure", "required":["payload"], "members":{ "payload":{ "shape":"JsonDocument", "documentation":"The state information, in JSON format.
" } }, "documentation":"The output from the DeleteThingShadow operation.
", "payload":"payload" }, "GetRetainedMessageRequest":{ "type":"structure", "required":["topic"], "members":{ "topic":{ "shape":"Topic", "documentation":"The topic name of the retained message to retrieve.
", "location":"uri", "locationName":"topic" } }, "documentation":"The input for the GetRetainedMessage operation.
" }, "GetRetainedMessageResponse":{ "type":"structure", "members":{ "topic":{ "shape":"Topic", "documentation":"The topic name to which the retained message was published.
" }, "payload":{ "shape":"Payload", "documentation":"The Base64-encoded message payload of the retained message body.
" }, "qos":{ "shape":"Qos", "documentation":"The quality of service (QoS) level used to publish the retained message.
" }, "lastModifiedTime":{ "shape":"Timestamp", "documentation":"The Epoch date and time, in milliseconds, when the retained message was stored by IoT.
" }, "userProperties":{ "shape":"UserPropertiesBlob", "documentation":"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 output from the GetRetainedMessage operation.
" }, "GetThingShadowRequest":{ "type":"structure", "required":["thingName"], "members":{ "thingName":{ "shape":"ThingName", "documentation":"The name of the thing.
", "location":"uri", "locationName":"thingName" }, "shadowName":{ "shape":"ShadowName", "documentation":"The name of the shadow.
", "location":"querystring", "locationName":"name" } }, "documentation":"The input for the GetThingShadow operation.
" }, "GetThingShadowResponse":{ "type":"structure", "members":{ "payload":{ "shape":"JsonDocument", "documentation":"The state information, in JSON format.
" } }, "documentation":"The output from the GetThingShadow operation.
", "payload":"payload" }, "InternalFailureException":{ "type":"structure", "members":{ "message":{ "shape":"errorMessage", "documentation":"The message for the exception.
" } }, "documentation":"An unexpected error has occurred.
", "error":{"httpStatusCode":500}, "exception":true, "fault":true }, "InvalidRequestException":{ "type":"structure", "members":{ "message":{ "shape":"errorMessage", "documentation":"The message for the exception.
" } }, "documentation":"The request is not valid.
", "error":{"httpStatusCode":400}, "exception":true }, "JsonDocument":{"type":"blob"}, "ListNamedShadowsForThingRequest":{ "type":"structure", "required":["thingName"], "members":{ "thingName":{ "shape":"ThingName", "documentation":"The name of the thing.
", "location":"uri", "locationName":"thingName" }, "nextToken":{ "shape":"NextToken", "documentation":"The token to retrieve the next set of results.
", "location":"querystring", "locationName":"nextToken" }, "pageSize":{ "shape":"PageSize", "documentation":"The result page size.
", "location":"querystring", "locationName":"pageSize" } } }, "ListNamedShadowsForThingResponse":{ "type":"structure", "members":{ "results":{ "shape":"NamedShadowList", "documentation":"The list of shadows for the specified thing.
" }, "nextToken":{ "shape":"NextToken", "documentation":"The token to use to get the next set of results, or null if there are no additional results.
" }, "timestamp":{ "shape":"Timestamp", "documentation":"The Epoch date and time the response was generated by IoT.
" } } }, "ListRetainedMessagesRequest":{ "type":"structure", "members":{ "nextToken":{ "shape":"NextToken", "documentation":"To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.
The maximum number of results to return at one time.
", "location":"querystring", "locationName":"maxResults" } } }, "ListRetainedMessagesResponse":{ "type":"structure", "members":{ "retainedTopics":{ "shape":"RetainedMessageList", "documentation":"A summary list the account's retained messages. The information returned doesn't include the message payloads of the retained messages.
" }, "nextToken":{ "shape":"NextToken", "documentation":"The token for the next set of results, or null if there are no additional results.
" } } }, "MaxResults":{ "type":"integer", "max":200, "min":1 }, "MessageExpiry":{"type":"long"}, "MethodNotAllowedException":{ "type":"structure", "members":{ "message":{ "shape":"errorMessage", "documentation":"The message for the exception.
" } }, "documentation":"The specified combination of HTTP verb and URI is not supported.
", "error":{"httpStatusCode":405}, "exception":true }, "NamedShadowList":{ "type":"list", "member":{"shape":"ShadowName"} }, "NextToken":{"type":"string"}, "PageSize":{ "type":"integer", "max":100, "min":1 }, "Payload":{"type":"blob"}, "PayloadFormatIndicator":{ "type":"string", "enum":[ "UNSPECIFIED_BYTES", "UTF8_DATA" ] }, "PayloadSize":{"type":"long"}, "PublishRequest":{ "type":"structure", "required":["topic"], "members":{ "topic":{ "shape":"Topic", "documentation":"The name of the MQTT topic.
", "location":"uri", "locationName":"topic" }, "qos":{ "shape":"Qos", "documentation":"The Quality of Service (QoS) level. The default QoS level is 0.
", "location":"querystring", "locationName":"qos" }, "retain":{ "shape":"Retain", "documentation":"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
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.
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\"}]
An Enum string value that indicates whether the payload is formatted as UTF-8. payloadFormatIndicator is an HTTP header value in the API.
A UTF-8 encoded string that describes the content of the publishing message.
", "location":"querystring", "locationName":"contentType" }, "responseTopic":{ "shape":"ResponseTopic", "documentation":"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.
", "location":"querystring", "locationName":"responseTopic" }, "correlationData":{ "shape":"CorrelationData", "documentation":"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.
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 input for the Publish operation.
", "payload":"payload" }, "Qos":{ "type":"integer", "max":1, "min":0 }, "RequestEntityTooLargeException":{ "type":"structure", "members":{ "message":{ "shape":"errorMessage", "documentation":"The message for the exception.
" } }, "documentation":"The payload exceeds the maximum size allowed.
", "error":{"httpStatusCode":413}, "exception":true }, "ResourceNotFoundException":{ "type":"structure", "members":{ "message":{ "shape":"errorMessage", "documentation":"The message for the exception.
" } }, "documentation":"The specified resource does not exist.
", "error":{"httpStatusCode":404}, "exception":true }, "ResponseTopic":{"type":"string"}, "Retain":{"type":"boolean"}, "RetainedMessageList":{ "type":"list", "member":{"shape":"RetainedMessageSummary"} }, "RetainedMessageSummary":{ "type":"structure", "members":{ "topic":{ "shape":"Topic", "documentation":"The topic name to which the retained message was published.
" }, "payloadSize":{ "shape":"PayloadSize", "documentation":"The size of the retained message's payload in bytes.
" }, "qos":{ "shape":"Qos", "documentation":"The quality of service (QoS) level used to publish the retained message.
" }, "lastModifiedTime":{ "shape":"Timestamp", "documentation":"The Epoch date and time, in milliseconds, when the retained message was stored by IoT.
" } }, "documentation":"Information about a single retained message.
" }, "ServiceUnavailableException":{ "type":"structure", "members":{ "message":{ "shape":"errorMessage", "documentation":"The message for the exception.
" } }, "documentation":"The service is temporarily unavailable.
", "error":{"httpStatusCode":503}, "exception":true, "fault":true }, "ShadowName":{ "type":"string", "max":64, "min":1, "pattern":"[$a-zA-Z0-9:_-]+" }, "ThingName":{ "type":"string", "max":128, "min":1, "pattern":"[a-zA-Z0-9:_-]+" }, "ThrottlingException":{ "type":"structure", "members":{ "message":{ "shape":"errorMessage", "documentation":"The message for the exception.
" } }, "documentation":"The rate exceeds the limit.
", "error":{"httpStatusCode":429}, "exception":true }, "Timestamp":{"type":"long"}, "Topic":{"type":"string"}, "UnauthorizedException":{ "type":"structure", "members":{ "message":{ "shape":"errorMessage", "documentation":"The message for the exception.
" } }, "documentation":"You are not authorized to perform this operation.
", "error":{"httpStatusCode":401}, "exception":true }, "UnsupportedDocumentEncodingException":{ "type":"structure", "members":{ "message":{ "shape":"errorMessage", "documentation":"The message for the exception.
" } }, "documentation":"The document encoding is not supported.
", "error":{"httpStatusCode":415}, "exception":true }, "UpdateThingShadowRequest":{ "type":"structure", "required":[ "thingName", "payload" ], "members":{ "thingName":{ "shape":"ThingName", "documentation":"The name of the thing.
", "location":"uri", "locationName":"thingName" }, "shadowName":{ "shape":"ShadowName", "documentation":"The name of the shadow.
", "location":"querystring", "locationName":"name" }, "payload":{ "shape":"JsonDocument", "documentation":"The state information, in JSON format.
" } }, "documentation":"The input for the UpdateThingShadow operation.
", "payload":"payload" }, "UpdateThingShadowResponse":{ "type":"structure", "members":{ "payload":{ "shape":"JsonDocument", "documentation":"The state information, in JSON format.
" } }, "documentation":"The output from the UpdateThingShadow operation.
", "payload":"payload" }, "UserProperties":{"type":"string"}, "UserPropertiesBlob":{"type":"blob"}, "errorMessage":{"type":"string"} }, "documentation":"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.
" } endpoint-rule-set-1.json 0000644 00000063014 15244212353 0011160 0 ustar 00 { "version": "1.0", "parameters": { "Region": { "builtIn": "AWS::Region", "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "String" }, "UseDualStack": { "builtIn": "AWS::UseDualStack", "required": true, "default": false, "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", "type": "Boolean" }, "UseFIPS": { "builtIn": "AWS::UseFIPS", "required": true, "default": false, "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", "type": "Boolean" }, "Endpoint": { "builtIn": "SDK::Endpoint", "required": false, "documentation": "Override the endpoint used to send this request", "type": "String" } }, "rules": [ { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] } ], "type": "tree", "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "error": "Invalid Configuration: FIPS and custom endpoint are not supported", "type": "error" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", "type": "error" }, { "conditions": [], "endpoint": { "url": { "ref": "Endpoint" }, "properties": {}, "headers": {} }, "type": "endpoint" } ] }, { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Region" } ] } ], "type": "tree", "rules": [ { "conditions": [ { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" } ], "type": "tree", "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "type": "tree", "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] } ] }, { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] } ] } ], "type": "tree", "rules": [ { "conditions": [], "endpoint": { "url": "https://data-ats.iot-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ] }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" } ] }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "type": "tree", "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] } ] } ], "type": "tree", "rules": [ { "conditions": [ { "fn": "stringEquals", "argv": [ { "ref": "Region" }, "ca-central-1" ] } ], "endpoint": { "url": "https://data.iot-fips.ca-central-1.amazonaws.com", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [ { "fn": "stringEquals", "argv": [ { "ref": "Region" }, "us-east-1" ] } ], "endpoint": { "url": "https://data.iot-fips.us-east-1.amazonaws.com", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [ { "fn": "stringEquals", "argv": [ { "ref": "Region" }, "us-east-2" ] } ], "endpoint": { "url": "https://data.iot-fips.us-east-2.amazonaws.com", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [ { "fn": "stringEquals", "argv": [ { "ref": "Region" }, "us-west-1" ] } ], "endpoint": { "url": "https://data.iot-fips.us-west-1.amazonaws.com", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [ { "fn": "stringEquals", "argv": [ { "ref": "Region" }, "us-west-2" ] } ], "endpoint": { "url": "https://data.iot-fips.us-west-2.amazonaws.com", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [ { "fn": "stringEquals", "argv": [ { "ref": "Region" }, "us-gov-east-1" ] } ], "endpoint": { "url": "https://data.iot-fips.us-gov-east-1.amazonaws.com", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [ { "fn": "stringEquals", "argv": [ { "ref": "Region" }, "us-gov-west-1" ] } ], "endpoint": { "url": "https://data.iot-fips.us-gov-west-1.amazonaws.com", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://data-ats.iot-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ] }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" } ] }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "type": "tree", "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] } ] } ], "type": "tree", "rules": [ { "conditions": [], "endpoint": { "url": "https://data-ats.iot.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ] }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" } ] }, { "conditions": [ { "fn": "stringEquals", "argv": [ { "ref": "Region" }, "cn-north-1" ] } ], "endpoint": { "url": "https://data.ats.iot.cn-north-1.amazonaws.com.cn", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [ { "fn": "stringEquals", "argv": [ "aws", { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] } ] } ], "endpoint": { "url": "https://data-ats.iot.{Region}.amazonaws.com", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [ { "fn": "stringEquals", "argv": [ "aws-cn", { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] } ] } ], "endpoint": { "url": "https://data-ats.iot.{Region}.amazonaws.com.cn", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [ { "fn": "stringEquals", "argv": [ "aws-us-gov", { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] } ] } ], "endpoint": { "url": "https://data-ats.iot.{Region}.amazonaws.com", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://data-ats.iot.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ] } ] }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } ] }