Readonly configThe resolved configuration of IoTDataPlaneClient class. This is resolved and normalized from the constructor configuration interface.
Deletes the shadow for the specified thing.
Requires permission to access the DeleteThingShadow action.
For more information, see DeleteThingShadow in the IoT Developer Guide.
Optional options: HttpHandlerOptionsOptional data: DeleteThingShadowCommandOutputOptional data: DeleteThingShadowCommandOutputDestroy underlying resources, like sockets. It's usually not necessary to do this. However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed. Otherwise, sockets might stay open for quite a long time before the server terminates them.
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.
Optional options: HttpHandlerOptionsOptional data: GetRetainedMessageCommandOutputOptional data: GetRetainedMessageCommandOutputGets the shadow for the specified thing.
Requires permission to access the GetThingShadow action.
For more information, see GetThingShadow in the IoT Developer Guide.
Optional options: HttpHandlerOptionsOptional data: GetThingShadowCommandOutputOptional data: GetThingShadowCommandOutputLists the shadows for the specified thing.
Requires permission to access the ListNamedShadowsForThing action.
Optional options: HttpHandlerOptionsOptional data: ListNamedShadowsForThingCommandOutputOptional data: ListNamedShadowsForThingCommandOutputLists 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.
Optional options: HttpHandlerOptionsOptional data: ListRetainedMessagesCommandOutputOptional data: ListRetainedMessagesCommandOutputPublishes 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.
Optional options: HttpHandlerOptionsOptional data: PublishCommandOutputOptional data: PublishCommandOutputOptional options: HttpHandlerOptionsOptional data: OutputTypeOptional data: OutputTypeUpdates the shadow for the specified thing.
Requires permission to access the UpdateThingShadow action.
For more information, see UpdateThingShadow in the IoT Developer Guide.
Optional options: HttpHandlerOptionsOptional data: UpdateThingShadowCommandOutputOptional data: UpdateThingShadowCommandOutput
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-ATSThe service name used by Amazon Web ServicesSignature Version 4 to sign requests is: iotdevicegateway.