This package has been deprecated

Author message:

The package @aws-sdk/client-iotanalytics-node has been renamed to @aws-sdk/client-iotanalytics. Please install the renamed package.

@aws-sdk/client-iotanalytics-node

Description

AWS IoT Analytics allows you to collect large amounts of device data, process messages, and store them. You can then query the data and run sophisticated analytics on it. AWS IoT Analytics enables advanced data exploration through integration with Jupyter Notebooks and data visualization through integration with Amazon QuickSight.

Traditional analytics and business intelligence tools are designed to process structured data. IoT data often comes from devices that record noisy processes (such as temperature, motion, or sound). As a result the data from these devices can have significant gaps, corrupted messages, and false readings that must be cleaned up before analysis can occur. Also, IoT data is often only meaningful in the context of other data from external sources.

AWS IoT Analytics automates the steps required to analyze data from IoT devices. AWS IoT Analytics filters, transforms, and enriches IoT data before storing it in a time-series data store for analysis. You can set up the service to collect only the data you need from your devices, apply mathematical transforms to process the data, and enrich the data with device-specific metadata such as device type and location before storing it. Then, you can analyze your data by running queries using the built-in SQL query engine, or perform more complex analytics and machine learning inference. AWS IoT Analytics includes pre-built models for common IoT use cases so you can answer questions like which devices are about to fail or which customers are at risk of abandoning their wearable devices.

Installing

To install the this package using NPM, simply type the following into a terminal window:

npm install @aws-sdk/client-iotanalytics-node

Getting Started

Import

The AWS SDK is modulized by clients and commands in CommonJS modules. To send a request, you only need to import the client(IoTAnalyticsClient) and the commands you need, for example BatchPutMessageCommand:

//JavaScript
const {
  IoTAnalyticsClient
} = require("@aws-sdk/client-iotanalytics-node/IoTAnalyticsClient");
const {
  BatchPutMessageCommand
} = require("@aws-sdk/client-iotanalytics-node/commands/BatchPutMessageCommand");

//TypeScript
import { IoTAnalyticsClient } from "@aws-sdk/client-iotanalytics-node/IoTAnalyticsClient";
import { BatchPutMessageCommand } from "@aws-sdk/client-iotanalytics-node/commands/BatchPutMessageCommand";

Usage

To send a request, you:

• Initiate client with configuration (e.g. credentials, region). For more information you can refer to the API reference.
• 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.

const ioTAnalytics = new IoTAnalyticsClient({region: 'region'});
//clients can be shared by different commands
const params = {
  channelName: /**a string value*/,
  messages: [ /**a list of structure*/ ],
};
const batchPutMessageCommand = new BatchPutMessageCommand(params);
ioTAnalytics.send(batchPutMessageCommand).then(data => {
    // do something
}).catch(error => {
    // error handling
})

In addition to using promises, there are 2 other ways to send a request:

// async/await
try {
  const data = await ioTAnalytics.send(batchPutMessageCommand);
  // do something
} catch (error) {
  // error handling
}

// callback
ioTAnalytics.send(batchPutMessageCommand, (err, data) => {
  //do something
});

The SDK can also send requests using the simplified callback style from version 2 of the SDK.

import * as AWS from "@aws-sdk/@aws-sdk/client-iotanalytics-node/IoTAnalytics";
const ioTAnalytics = new AWS.IoTAnalytics({ region: "region" });
ioTAnalytics.batchPutMessage(params, (err, data) => {
  //do something
});

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 ioTAnalytics.send(batchPutMessageCommand);
  // do something
} catch (error) {
  const metadata = error.$metadata;
  console.log(
    `requestId: ${metadata.requestId}
cfId: ${metadata.cfId}
extendedRequestId: ${metadata.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 and have limited bandwidth to address them.

• Ask a question on StackOverflow and tag it with aws-sdk-js
• Come join the AWS JavaScript community on gitter
• If it turns out that you may have found a bug, please open an issue

Contributing

This client code is generated automatically. Any modifications will be overwritten the next time the `@aws-sdk/@aws-sdk/client-iotanalytics-node' package is updated. To contribute to SDK you can checkout our code generator package.

License

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