@aws-sdk/client-iot-wireless

Description

AWS SDK for JavaScript IoTWireless Client for Node.js, Browser and React Native.

AWS IoT Wireless provides bi-directional communication between internet-connected wireless devices and the AWS Cloud. To onboard both LoRaWAN and Sidewalk devices to AWS IoT, use the IoT Wireless API. These wireless devices use the Low Power Wide Area Networking (LPWAN) communication protocol to communicate with AWS IoT.

Using the API, you can perform create, read, update, and delete operations for your wireless devices, gateways, destinations, and profiles. After onboarding your devices, you can use the API operations to set log levels and monitor your devices with CloudWatch.

You can also use the API operations to create multicast groups and schedule a multicast session for sending a downlink message to devices in the group. By using Firmware Updates Over-The-Air (FUOTA) API operations, you can create a FUOTA task and schedule a session to update the firmware of individual devices or an entire group of devices in a multicast group.

To connect to the AWS IoT Wireless Service, use the Service endpoints as described in IoT Wireless Service endpoints. You can use both IPv4 and IPv6 protocols to connect to the endpoints and send requests to the AWS IoT Wireless service. For more information, see Using IPv6 with AWS IoT Wireless.

Installing

To install this package, use the CLI of your favorite package manager:

• npm install @aws-sdk/client-iot-wireless
• yarn add @aws-sdk/client-iot-wireless
• pnpm add @aws-sdk/client-iot-wireless

Getting Started

Import

The AWS SDK is modulized by clients and commands. To send a request, you only need to import the IoTWirelessClient and the commands you need, for example ListDestinationsCommand:

// ES5 example
const { IoTWirelessClient, ListDestinationsCommand } = require("@aws-sdk/client-iot-wireless");

// ES6+ example
import { IoTWirelessClient, ListDestinationsCommand } from "@aws-sdk/client-iot-wireless";

Usage

To send a request:

• Instantiate a client with configuration (e.g. credentials, region).
  • See docs/CLIENTS for configuration details.
  • See @aws-sdk/config for additional options.
• Instantiate a command with input parameters.
• Call the send operation on the client, providing the command object as input.

const client = new IoTWirelessClient({ region: "REGION" });

const params = { /** input parameters */ };
const command = new ListDestinationsCommand(params);

Async/await

We recommend using the 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.
}

Promises

You can also use Promise chaining.

client
  .send(command)
  .then((data) => {
    // process data.
  })
  .catch((error) => {
    // error handling.
  })
  .finally(() => {
    // finally.
  });

Aggregated client

The aggregated client class is exported from the same package, but without the "Client" suffix.

IoTWireless extends IoTWirelessClient and additionally supports all operations, waiters, and paginators as methods. This style may be familiar to you from the AWS SDK for JavaScript v2.

If you are bundling the AWS SDK, we recommend using only the bare-bones client (IoTWirelessClient). More details are in the blog post on modular packages in AWS SDK for JavaScript.

import { IoTWireless } from "@aws-sdk/client-iot-wireless";

const client = new IoTWireless({ region: "REGION" });

// async/await.
try {
  const data = await client.listDestinations(params);
  // process data.
} catch (error) {
  // error handling.
}

// Promises.
client
  .listDestinations(params)
  .then((data) => {
    // process data.
  })
  .catch((error) => {
    // error handling.
  });

// callbacks (not recommended).
client.listDestinations(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;
   * }
   */
}

See also docs/ERROR_HANDLING.

Getting Help

Please use these community resources for getting help. We use GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.

• Visit the Developer Guide or API Reference.
• Check out the blog posts tagged with aws-sdk-js on AWS Developer Blog.
• Ask a question on StackOverflow and tag it with aws-sdk-js.
• Join the AWS JavaScript community on gitter.
• If it turns out that you may have found a bug, please open an issue.

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-wireless 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)