@aws-sdk/client-iot-data-plane
Advanced tools
AWS SDK for JavaScript Iot Data Plane Client for Node.js, Browser and React Native
@aws-sdk/client-iot-data-plane is an AWS SDK for JavaScript package that allows developers to interact with the AWS IoT Data Plane. This package provides methods to publish messages to IoT topics, retrieve the current state of a device shadow, update a device shadow, and delete a device shadow.
Publish to IoT Topic
This feature allows you to publish a message to a specified IoT topic. The code sample demonstrates how to create a client, construct a PublishCommand with a topic and payload, and send the command.
{"import":"import { IoTDataPlaneClient, PublishCommand } from '@aws-sdk/client-iot-data-plane';","client":"const client = new IoTDataPlaneClient({ region: 'us-west-2' });","command":"const command = new PublishCommand({ topic: 'my/topic', payload: Buffer.from('Hello, world!') });","send":"await client.send(command);"}Get Device Shadow
This feature allows you to retrieve the current state of a device shadow. The code sample demonstrates how to create a client, construct a GetThingShadowCommand with a device name, send the command, and log the response.
{"import":"import { IoTDataPlaneClient, GetThingShadowCommand } from '@aws-sdk/client-iot-data-plane';","client":"const client = new IoTDataPlaneClient({ region: 'us-west-2' });","command":"const command = new GetThingShadowCommand({ thingName: 'MyDevice' });","send":"const response = await client.send(command);","response":"console.log(new TextDecoder('utf-8').decode(response.payload));"}Update Device Shadow
This feature allows you to update the state of a device shadow. The code sample demonstrates how to create a client, construct an UpdateThingShadowCommand with a device name and payload, send the command, and log the response.
{"import":"import { IoTDataPlaneClient, UpdateThingShadowCommand } from '@aws-sdk/client-iot-data-plane';","client":"const client = new IoTDataPlaneClient({ region: 'us-west-2' });","command":"const command = new UpdateThingShadowCommand({ thingName: 'MyDevice', payload: Buffer.from(JSON.stringify({ state: { desired: { key: 'value' } } })) });","send":"const response = await client.send(command);","response":"console.log(new TextDecoder('utf-8').decode(response.payload));"}Delete Device Shadow
This feature allows you to delete a device shadow. The code sample demonstrates how to create a client, construct a DeleteThingShadowCommand with a device name, send the command, and log the response.
{"import":"import { IoTDataPlaneClient, DeleteThingShadowCommand } from '@aws-sdk/client-iot-data-plane';","client":"const client = new IoTDataPlaneClient({ region: 'us-west-2' });","command":"const command = new DeleteThingShadowCommand({ thingName: 'MyDevice' });","send":"const response = await client.send(command);","response":"console.log(new TextDecoder('utf-8').decode(response.payload));"}The 'mqtt' package is a client library for the MQTT protocol, which is commonly used for IoT communication. It allows you to connect to an MQTT broker, publish messages to topics, and subscribe to topics. Unlike @aws-sdk/client-iot-data-plane, it does not provide direct integration with AWS IoT services but can be used to communicate with any MQTT broker.
The 'aws-iot-device-sdk' package is an AWS SDK for JavaScript that provides a client for AWS IoT. It allows you to connect to the AWS IoT platform, publish and subscribe to MQTT topics, and interact with device shadows. It offers similar functionalities to @aws-sdk/client-iot-data-plane but is more focused on device-side operations.
The 'azure-iot-device' package is a client library for Microsoft Azure IoT Hub. It allows you to connect devices to Azure IoT Hub, send telemetry data, and receive cloud-to-device messages. While it provides similar IoT functionalities, it is specific to the Azure cloud platform, unlike @aws-sdk/client-iot-data-plane which is specific to AWS.
AWS SDK for JavaScript IoTDataPlane Client for Node.js, Browser and React Native.
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.
To install this package, simply type add or install @aws-sdk/client-iot-data-plane using your favorite package manager:
npm install @aws-sdk/client-iot-data-planeyarn add @aws-sdk/client-iot-data-planepnpm add @aws-sdk/client-iot-data-planeThe AWS SDK is modulized by clients and commands.
To send a request, you only need to import the IoTDataPlaneClient and
the commands you need, for example ListRetainedMessagesCommand:
// ES5 example
const { IoTDataPlaneClient, ListRetainedMessagesCommand } = require("@aws-sdk/client-iot-data-plane");
// ES6+ example
import { IoTDataPlaneClient, ListRetainedMessagesCommand } from "@aws-sdk/client-iot-data-plane";
To send a request, you:
send operation on client with command object as input.destroy() to close open connections.// a client can be shared by different commands.
const client = new IoTDataPlaneClient({ region: "REGION" });
const params = {
/** input parameters */
};
const command = new ListRetainedMessagesCommand(params);
We recommend using await operator to wait for the promise returned by send operation as follows:
// async/await.
try {
const data = await client.send(command);
// process data.
} catch (error) {
// error handling.
} finally {
// finally.
}
Async-await is clean, concise, intuitive, easy to debug and has better error handling as compared to using Promise chains or callbacks.
You can also use Promise chaining to execute send operation.
client.send(command).then(
(data) => {
// process data.
},
(error) => {
// error handling.
}
);
Promises can also be called using .catch() and .finally() as follows:
client
.send(command)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
})
.finally(() => {
// finally.
});
We do not recommend using callbacks because of callback hell, but they are supported by the send operation.
// callbacks.
client.send(command, (err, data) => {
// process err and data.
});
The client can also send requests using v2 compatible style. However, it results in a bigger bundle size and may be dropped in next major version. More details in the blog post on modular packages in AWS SDK for JavaScript
import * as AWS from "@aws-sdk/client-iot-data-plane";
const client = new AWS.IoTDataPlane({ region: "REGION" });
// async/await.
try {
const data = await client.listRetainedMessages(params);
// process data.
} catch (error) {
// error handling.
}
// Promises.
client
.listRetainedMessages(params)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
});
// callbacks.
client.listRetainedMessages(params, (err, data) => {
// process err and data.
});
When the service returns an exception, the error will include the exception information, as well as response metadata (e.g. request id).
try {
const data = await client.send(command);
// process data.
} catch (error) {
const { requestId, cfId, extendedRequestId } = error.$metadata;
console.log({ requestId, cfId, extendedRequestId });
/**
* The keys within exceptions are also parsed.
* You can access them by specifying exception names:
* if (error.name === 'SomeServiceException') {
* const value = error.specialKeyInException;
* }
*/
}
Please use these community resources for getting help. We use the GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.
aws-sdk-js
on AWS Developer Blog.aws-sdk-js.To test your universal JavaScript code in Node.js, browser and react-native environments, visit our code samples repo.
This client code is generated automatically. Any modifications will be overwritten the next time the @aws-sdk/client-iot-data-plane package is updated.
To contribute to client you can check our generate clients scripts.
This SDK is distributed under the Apache License, Version 2.0, see LICENSE for more information.
3.758.0 (2025-02-27)
FAQs
AWS SDK for JavaScript Iot Data Plane Client for Node.js, Browser and React Native
The npm package @aws-sdk/client-iot-data-plane receives a total of 108,862 weekly downloads. As such, @aws-sdk/client-iot-data-plane popularity was classified as popular.
We found that @aws-sdk/client-iot-data-plane demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
OpenSSF has published OSPS Baseline, an initiative designed to establish a minimum set of security-related best practices for open source software projects.
Security News
Michigan TypeScript founder Dimitri Mitropoulos implements WebAssembly runtime in TypeScript types, enabling Doom to run after processing 177 terabytes of type definitions.
Security News
vlt's new "reproduce" tool verifies npm packages against their source code, outperforming traditional provenance adoption in the JavaScript ecosystem.