IoTDataPlaneClient

Suggest an Edit
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.

Installation

NPM
npm install @aws-sdk/client-iot-data-plane
Yarn
yarn add @aws-sdk/client-iot-data-plane
pnpm
pnpm add @aws-sdk/client-iot-data-plane

IoTDataPlaneClient Operations

Command
Summary
DeleteThingShadowCommand

Deletes the shadow for the specified thing.

Requires permission to access the DeleteThingShadow  action.

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

GetRetainedMessageCommand

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 .

GetThingShadowCommand

Gets the shadow for the specified thing.

Requires permission to access the GetThingShadow  action.

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

ListNamedShadowsForThingCommand

Lists the shadows for the specified thing.

Requires permission to access the ListNamedShadowsForThing  action.

ListRetainedMessagesCommand

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 .

PublishCommand

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 .

UpdateThingShadowCommand

Updates the shadow for the specified thing.

Requires permission to access the UpdateThingShadow  action.

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

IoTDataPlaneClient Configuration

Parameter
Type
Description
defaultsMode
Optional
DefaultsMode | Provider<DefaultsMode>
The @smithy/smithy-client#DefaultsMode that will be used to determine how certain default configuration options are resolved in the SDK.
disableHostPrefix
Optional
boolean
Disable dynamically changing the endpoint of the client based on the hostPrefix trait of an operation.
extensions
Optional
RuntimeExtension[]
Optional extensions
logger
Optional
Logger
Optional logger for logging debug/info/warn/error.
maxAttempts
Optional
number | Provider<number>
Value for how many times a request will be made at most in case of retry.
profile
Optional
string
Setting a client profile is similar to setting a value for the AWS_PROFILE environment variable. Setting a profile on a client in code only affects the single client instance, unlike AWS_PROFILE.When set, and only for environments where an AWS configuration file exists, fields configurable by this file will be retrieved from the specified profile within that file. Conflicting code configuration and environment variables will still have higher priority.For client credential resolution that involves checking the AWS configuration file, the client's profile (this value) will be used unless a different profile is set in the credential provider options.
region
Optional
string | Provider<string>
The AWS region to which this client will send requests
requestHandler
Optional
__HttpHandlerUserInput
The HTTP handler to use or its constructor options. Fetch in browser and Https in Nodejs.
retryMode
Optional
string | Provider<string>
Specifies which retry algorithm to use.
useDualstackEndpoint
Optional
boolean | Provider<boolean>
Enables IPv6/IPv4 dualstack endpoint.
useFipsEndpoint
Optional
boolean | Provider<boolean>
Enables FIPS compatible endpoints.
Additional config fields are described in the full configuration type: IoTDataPlaneClientConfig