@aws-sdk/client-timestream-write

@aws-sdk/client-timestream-write

Description

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

Amazon Timestream Write

Amazon Timestream is a fast, scalable, fully managed time-series database service that makes it easy to store and analyze trillions of time-series data points per day. With Timestream, you can easily store and analyze IoT sensor data to derive insights from your IoT applications. You can analyze industrial telemetry to streamline equipment management and maintenance. You can also store and analyze log data and metrics to improve the performance and availability of your applications.

Timestream is built from the ground up to effectively ingest, process, and store time-series data. It organizes data to optimize query processing. It automatically scales based on the volume of data ingested and on the query volume to ensure you receive optimal performance while inserting and querying data. As your data grows over time, Timestream’s adaptive query processing engine spans across storage tiers to provide fast analysis while reducing costs.

Installing

To install this package, simply type add or install @aws-sdk/client-timestream-write using your favorite package manager:

• npm install @aws-sdk/client-timestream-write
• yarn add @aws-sdk/client-timestream-write
• pnpm add @aws-sdk/client-timestream-write

Getting Started

Import

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

// ES5 example
const { TimestreamWriteClient, ListTablesCommand } = require("@aws-sdk/client-timestream-write");

// ES6+ example
import { TimestreamWriteClient, ListTablesCommand } from "@aws-sdk/client-timestream-write";

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 TimestreamWriteClient({ region: "REGION" });

const params = {
  /** input parameters */
};
const command = new ListTablesCommand(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-timestream-write";
const client = new AWS.TimestreamWrite({ region: "REGION" });

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

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

// callbacks.
client.listTables(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.

• 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-timestream-write 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)

CreateBatchLoadTask

Command API Reference / Input / Output

CreateDatabase

Command API Reference / Input / Output

CreateTable

Command API Reference / Input / Output

DeleteDatabase

Command API Reference / Input / Output

DeleteTable

Command API Reference / Input / Output

DescribeBatchLoadTask

Command API Reference / Input / Output

DescribeDatabase

Command API Reference / Input / Output

DescribeEndpoints

Command API Reference / Input / Output

DescribeTable

Command API Reference / Input / Output

ListBatchLoadTasks

Command API Reference / Input / Output

ListDatabases

Command API Reference / Input / Output

ListTables

Command API Reference / Input / Output

ListTagsForResource

Command API Reference / Input / Output

ResumeBatchLoadTask

Command API Reference / Input / Output

TagResource

Command API Reference / Input / Output

UntagResource

Command API Reference / Input / Output

UpdateDatabase

Command API Reference / Input / Output

UpdateTable

Command API Reference / Input / Output

WriteRecords

Command API Reference / Input / Output