@aws-sdk/client-kinesis-analytics-v2

Description

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

Amazon Managed Service for Apache Flink was previously known as Amazon Kinesis Data Analytics for Apache Flink.

Amazon Managed Service for Apache Flink is a fully managed service that you can use to process and analyze streaming data using Java, Python, SQL, or Scala. The service
enables you to quickly author and run Java, SQL, or Scala code against streaming sources to perform time
series analytics, feed real-time dashboards, and create real-time metrics.

Installing

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

Getting Started

$3

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

``js
// ES5 example
const { KinesisAnalyticsV2Client, ListApplicationsCommand } = require("@aws-sdk/client-kinesis-analytics-v2");
`

`ts
// ES6+ example
import { KinesisAnalyticsV2Client, ListApplicationsCommand } from "@aws-sdk/client-kinesis-analytics-v2";
`

$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 KinesisAnalyticsV2Client({ 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:

`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-kinesis-analytics-v2";
const client = new AWS.KinesisAnalyticsV2({ 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.
});
`

$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-kinesis-analytics-v2` 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

AddApplicationVpcConfiguration

Command API Reference / Input / Output

CreateApplication

Command API Reference / Input / Output

CreateApplicationPresignedUrl

Command API Reference / Input / Output

CreateApplicationSnapshot

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

DeleteApplicationSnapshot

Command API Reference / Input / Output

DeleteApplicationVpcConfiguration

Command API Reference / Input / Output

DescribeApplication

Command API Reference / Input / Output

DescribeApplicationOperation

Command API Reference / Input / Output

DescribeApplicationSnapshot

Command API Reference / Input / Output

DescribeApplicationVersion

Command API Reference / Input / Output

DiscoverInputSchema

Command API Reference / Input / Output

ListApplicationOperations

Command API Reference / Input / Output

ListApplications

Command API Reference / Input / Output

ListApplicationSnapshots

Command API Reference / Input / Output

ListApplicationVersions

Command API Reference / Input / Output

ListTagsForResource

Command API Reference / Input / Output

RollbackApplication

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

UpdateApplicationMaintenanceConfiguration

Command API Reference / Input / Output