Socket
Socket
Sign inDemoInstall

@aws-sdk/client-iot-data-plane

Package Overview
Dependencies
42
Maintainers
5
Versions
368
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

@aws-sdk/client-iot-data-plane


Version published
Weekly downloads
232K
decreased by-27.65%
Maintainers
5
Created
Weekly downloads
 

Package description

What is @aws-sdk/client-iot-data-plane?

@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.

What are @aws-sdk/client-iot-data-plane's main functionalities?

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));"}

Other packages similar to @aws-sdk/client-iot-data-plane

Changelog

Source

3.614.0 (2024-07-10)

Bug Fixes

  • util-dynamodb: perform global interface check in NativeAttributeBinary union (#6261) (e116b4c)

Features

  • client-batch: This feature allows AWS Batch Jobs with EKS container orchestration type to be run as Multi-Node Parallel Jobs. (bda616d)
  • client-bedrock-agent-runtime: Introduces query decomposition, enhanced Agents integration with Knowledge bases, session summary generation, and code interpretation (preview) for Claude V3 Sonnet and Haiku models. Also introduces Prompt Flows (preview) to link prompts, foundational models, and resources for end-to-end solutions. (f2f40c1)
  • client-bedrock-agent: Introduces new data sources and chunking strategies for Knowledge bases, advanced parsing logic using FMs, session summary generation, and code interpretation (preview) for Claude V3 Sonnet and Haiku models. Also introduces Prompt Flows (preview) to link prompts, foundational models, and resources. (6d701b1)
  • client-bedrock-runtime: Add support for contextual grounding check and ApplyGuardrail API for Guardrails for Amazon Bedrock. (8863b77)
  • client-bedrock: Add support for contextual grounding check for Guardrails for Amazon Bedrock. (f8cc6bd)
  • client-ec2: Add parameters to enable provisioning IPAM BYOIPv4 space at a Local Zone Network Border Group level (d835dbb)
  • client-glue: Add recipe step support for recipe node (c9d85d8)
  • client-license-manager-linux-subscriptions: Add support for third party subscription providers, starting with RHEL subscriptions through Red Hat Subscription Manager (RHSM). Additionally, add support for tagging subscription provider resources, and detect when an instance has more than one Linux subscription and notify the customer. (e490334)
  • client-mediaconnect: AWS Elemental MediaConnect introduces the ability to disable outputs. Disabling an output allows you to keep the output attached to the flow, but stop streaming to the output destination. A disabled output does not incur data transfer costs. (427a732)
  • clients: update client endpoints as of 2024-07-10 (3a748e5)

Readme

Source

@aws-sdk/client-iot-data-plane

Description

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.

Installing

To install the 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-plane
  • yarn add @aws-sdk/client-iot-data-plane
  • pnpm add @aws-sdk/client-iot-data-plane

Getting Started

Import

The 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";

Usage

To send a request, you:

  • Initiate client with configuration (e.g. credentials, region).
  • Initiate command with input parameters.
  • Call send operation on client with command object as input.
  • If you are using a custom http handler, you may call 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);
Async/await

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.

Promises

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.
  });
Callbacks

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.
});
v2 compatible style

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.
});

Troubleshooting

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;
   * }
   */
}

Getting Help

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.

To test your universal JavaScript code in Node.js, browser and react-native environments, visit our code samples repo.

Contributing

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.

License

This SDK is distributed under the Apache License, Version 2.0, see LICENSE for more information.

Client Commands (Operations List)

DeleteThingShadow

Command API Reference / Input / Output

GetRetainedMessage

Command API Reference / Input / Output

GetThingShadow

Command API Reference / Input / Output

ListNamedShadowsForThing

Command API Reference / Input / Output

ListRetainedMessages

Command API Reference / Input / Output

Publish

Command API Reference / Input / Output

UpdateThingShadow

Command API Reference / Input / Output

FAQs

Last updated on 10 Jul 2024

Did you know?

Socket

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.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Packages

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc