@aws-sdk/client-kinesis-analytics
TypeScript icon, indicating that this package has built-in type declarations

3.687.0 • Public • Published

@aws-sdk/client-kinesis-analytics

Description

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

Amazon Kinesis Analytics

Overview

This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. Version 2 of the API supports SQL and Java applications. For more information about version 2, see Amazon Kinesis Data Analytics API V2 Documentation.

This is the Amazon Kinesis Analytics v1 API Reference. The Amazon Kinesis Analytics Developer Guide provides additional information.

Installing

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

  • npm install @aws-sdk/client-kinesis-analytics
  • yarn add @aws-sdk/client-kinesis-analytics
  • pnpm add @aws-sdk/client-kinesis-analytics

Getting Started

Import

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

// ES5 example
const { KinesisAnalyticsClient, ListApplicationsCommand } = require("@aws-sdk/client-kinesis-analytics");
// ES6+ example
import { KinesisAnalyticsClient, ListApplicationsCommand } from "@aws-sdk/client-kinesis-analytics";

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

const params = {
  /** input parameters */
};
const command = new ListApplicationsCommand(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-kinesis-analytics";
const client = new AWS.KinesisAnalytics({ region: "REGION" });

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

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

// callbacks.
client.listApplications(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-kinesis-analytics 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)

AddApplicationCloudWatchLoggingOption

Command API Reference / Input / Output

AddApplicationInput

Command API Reference / Input / Output

AddApplicationInputProcessingConfiguration

Command API Reference / Input / Output

AddApplicationOutput

Command API Reference / Input / Output

AddApplicationReferenceDataSource

Command API Reference / Input / Output

CreateApplication

Command API Reference / Input / Output

DeleteApplication

Command API Reference / Input / Output

DeleteApplicationCloudWatchLoggingOption

Command API Reference / Input / Output

DeleteApplicationInputProcessingConfiguration

Command API Reference / Input / Output

DeleteApplicationOutput

Command API Reference / Input / Output

DeleteApplicationReferenceDataSource

Command API Reference / Input / Output

DescribeApplication

Command API Reference / Input / Output

DiscoverInputSchema

Command API Reference / Input / Output

ListApplications

Command API Reference / Input / Output

ListTagsForResource

Command API Reference / Input / Output

StartApplication

Command API Reference / Input / Output

StopApplication

Command API Reference / Input / Output

TagResource

Command API Reference / Input / Output

UntagResource

Command API Reference / Input / Output

UpdateApplication

Command API Reference / Input / Output

Readme

Keywords

none

Package Sidebar

Install

npm i @aws-sdk/client-kinesis-analytics

Weekly Downloads

7,790

Version

3.687.0

License

Apache-2.0

Unpacked Size

543 kB

Total Files

128

Last publish

Collaborators

  • mattsb42-aws
  • kuhe
  • amzn-oss
  • aws-sdk-bot
  • trivikr-aws