@aws-sdk/client-iotanalytics

Description

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

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

IoT Analytics automates the steps required to analyze data from IoT devices. 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. 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 this package, simply type add or install @aws-sdk/client-iotanalytics
using your favorite package manager:
- npm install @aws-sdk/client-iotanalytics
- yarn add @aws-sdk/client-iotanalytics
- pnpm add @aws-sdk/client-iotanalytics

Getting Started

$3

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

``js
// ES5 example
const { IoTAnalyticsClient, ListChannelsCommand } = require("@aws-sdk/client-iotanalytics");
`

`ts
// ES6+ example
import { IoTAnalyticsClient, ListChannelsCommand } from "@aws-sdk/client-iotanalytics";
`

$3

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.

`js
// a client can be shared by different commands.
const client = new IoTAnalyticsClient({ region: "REGION" });

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

#### Async/await

We recommend using await
operator to wait for the promise returned by send operation as follows:

`js
// 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.

`js
client.send(command).then(
(data) => {
// process data.
},
(error) => {
// error handling.
}
);
`

Promises can also be called using .catch() and .finally() as follows:

`js
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.

`js
// 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

`ts
import * as AWS from "@aws-sdk/client-iotanalytics";
const client = new AWS.IoTAnalytics({ region: "REGION" });

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

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

// callbacks.
client.listChannels(params, (err, data) => {
// process err and data.
});
`

$3

When the service returns an exception, the error will include the exception information,
as well as response metadata (e.g. request id).

`js
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.

- Visit 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-iotanalytics` 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)

BatchPutMessage

Command API Reference / Input / Output

CancelPipelineReprocessing

Command API Reference / Input / Output

CreateChannel

Command API Reference / Input / Output

CreateDataset

Command API Reference / Input / Output

CreateDatasetContent

Command API Reference / Input / Output

CreateDatastore

Command API Reference / Input / Output

CreatePipeline

Command API Reference / Input / Output

DeleteChannel

Command API Reference / Input / Output

DeleteDataset

Command API Reference / Input / Output

DeleteDatasetContent

Command API Reference / Input / Output

DeleteDatastore

Command API Reference / Input / Output

DeletePipeline

Command API Reference / Input / Output

DescribeChannel

Command API Reference / Input / Output

DescribeDataset

Command API Reference / Input / Output

DescribeDatastore

Command API Reference / Input / Output

DescribeLoggingOptions

Command API Reference / Input / Output

DescribePipeline

Command API Reference / Input / Output

GetDatasetContent

Command API Reference / Input / Output

ListChannels

Command API Reference / Input / Output

ListDatasetContents

Command API Reference / Input / Output

ListDatasets

Command API Reference / Input / Output

ListDatastores

Command API Reference / Input / Output

ListPipelines

Command API Reference / Input / Output

ListTagsForResource

Command API Reference / Input / Output

PutLoggingOptions

Command API Reference / Input / Output

RunPipelineActivity

Command API Reference / Input / Output

SampleChannelData

Command API Reference / Input / Output

StartPipelineReprocessing

Command API Reference / Input / Output

TagResource

Command API Reference / Input / Output

UntagResource

Command API Reference / Input / Output

UpdateChannel

Command API Reference / Input / Output

UpdateDataset

Command API Reference / Input / Output

UpdateDatastore

Command API Reference / Input / Output

UpdatePipeline

Command API Reference / Input / Output