@aws-sdk/client-kinesis

Description

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

Amazon Kinesis Data Streams Service API Reference

Amazon Kinesis Data Streams is a managed service that scales elastically for real-time
processing of streaming big data.

Installing

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

Getting Started

$3

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

``js
// ES5 example
const { KinesisClient, ListShardsCommand } = require("@aws-sdk/client-kinesis");
`

`ts
// ES6+ example
import { KinesisClient, ListShardsCommand } from "@aws-sdk/client-kinesis";
`

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

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

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

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

// callbacks.
client.listShards(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` 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)

AddTagsToStream

Command API Reference / Input / Output

CreateStream

Command API Reference / Input / Output

DecreaseStreamRetentionPeriod

Command API Reference / Input / Output

DeleteResourcePolicy

Command API Reference / Input / Output

DeleteStream

Command API Reference / Input / Output

DeregisterStreamConsumer

Command API Reference / Input / Output

DescribeAccountSettings

Command API Reference / Input / Output

DescribeLimits

Command API Reference / Input / Output

DescribeStream

Command API Reference / Input / Output

DescribeStreamConsumer

Command API Reference / Input / Output

DescribeStreamSummary

Command API Reference / Input / Output

DisableEnhancedMonitoring

Command API Reference / Input / Output

EnableEnhancedMonitoring

Command API Reference / Input / Output

GetRecords

Command API Reference / Input / Output

GetResourcePolicy

Command API Reference / Input / Output

GetShardIterator

Command API Reference / Input / Output

IncreaseStreamRetentionPeriod

Command API Reference / Input / Output

ListShards

Command API Reference / Input / Output

ListStreamConsumers

Command API Reference / Input / Output

ListStreams

Command API Reference / Input / Output

ListTagsForResource

Command API Reference / Input / Output

ListTagsForStream

Command API Reference / Input / Output

MergeShards

Command API Reference / Input / Output

PutRecord

Command API Reference / Input / Output

PutRecords

Command API Reference / Input / Output

PutResourcePolicy

Command API Reference / Input / Output

RegisterStreamConsumer

Command API Reference / Input / Output

RemoveTagsFromStream

Command API Reference / Input / Output

SplitShard

Command API Reference / Input / Output

StartStreamEncryption

Command API Reference / Input / Output

StopStreamEncryption

Command API Reference / Input / Output

SubscribeToShard

Command API Reference / Input / Output

TagResource

Command API Reference / Input / Output

UntagResource

Command API Reference / Input / Output

UpdateAccountSettings

Command API Reference / Input / Output

UpdateMaxRecordSize

Command API Reference / Input / Output

UpdateShardCount

Command API Reference / Input / Output

UpdateStreamMode

Command API Reference / Input / Output

UpdateStreamWarmThroughput

Command API Reference / Input / Output