@aws-sdk/client-kinesis
Advanced tools
AWS SDK for JavaScript Kinesis Client for Node.js, Browser and React Native
@aws-sdk/client-kinesis is an AWS SDK for JavaScript package that allows developers to interact with Amazon Kinesis, a platform for real-time data streaming. This package provides methods to create, manage, and interact with Kinesis streams, enabling real-time processing of data.
Create Stream
This feature allows you to create a new Kinesis stream. The code sample demonstrates how to create a stream named 'my-stream' with one shard.
const { KinesisClient, CreateStreamCommand } = require('@aws-sdk/client-kinesis');
const client = new KinesisClient({ region: 'us-east-1' });
const command = new CreateStreamCommand({ StreamName: 'my-stream', ShardCount: 1 });
client.send(command).then(
(data) => console.log('Stream created:', data),
(error) => console.error('Error creating stream:', error)
);Put Record
This feature allows you to put a record into a Kinesis stream. The code sample demonstrates how to put a record with data 'my-data' into the stream 'my-stream' using a partition key.
const { KinesisClient, PutRecordCommand } = require('@aws-sdk/client-kinesis');
const client = new KinesisClient({ region: 'us-east-1' });
const command = new PutRecordCommand({
StreamName: 'my-stream',
Data: Buffer.from('my-data'),
PartitionKey: 'partition-key'
});
client.send(command).then(
(data) => console.log('Record put:', data),
(error) => console.error('Error putting record:', error)
);Get Records
This feature allows you to get records from a Kinesis stream. The code sample demonstrates how to get records from the shard 'shardId-000000000000' of the stream 'my-stream'.
const { KinesisClient, GetRecordsCommand, GetShardIteratorCommand } = require('@aws-sdk/client-kinesis');
const client = new KinesisClient({ region: 'us-east-1' });
const shardIteratorCommand = new GetShardIteratorCommand({
StreamName: 'my-stream',
ShardId: 'shardId-000000000000',
ShardIteratorType: 'TRIM_HORIZON'
});
client.send(shardIteratorCommand).then(
(shardIteratorData) => {
const getRecordsCommand = new GetRecordsCommand({ ShardIterator: shardIteratorData.ShardIterator });
return client.send(getRecordsCommand);
}
).then(
(recordsData) => console.log('Records:', recordsData.Records),
(error) => console.error('Error getting records:', error)
);List Streams
This feature allows you to list all Kinesis streams in your account. The code sample demonstrates how to list all streams.
const { KinesisClient, ListStreamsCommand } = require('@aws-sdk/client-kinesis');
const client = new KinesisClient({ region: 'us-east-1' });
const command = new ListStreamsCommand({});
client.send(command).then(
(data) => console.log('Streams:', data.StreamNames),
(error) => console.error('Error listing streams:', error)
);kinesis-client is a lightweight client for interacting with Amazon Kinesis. It provides basic functionalities for creating streams, putting records, and getting records. Compared to @aws-sdk/client-kinesis, it offers a simpler interface but lacks some advanced features and configurations.
aws-kinesis-agg is a client library for aggregating and de-aggregating records for Amazon Kinesis. It is particularly useful for optimizing the number of records sent to Kinesis by aggregating multiple records into a single Kinesis record. This package complements @aws-sdk/client-kinesis by providing additional functionality for record aggregation.
kinesis-streams is a Node.js library for working with Amazon Kinesis streams. It provides a higher-level abstraction over the Kinesis API, making it easier to work with streams and records. Compared to @aws-sdk/client-kinesis, it offers a more user-friendly API but may not support all low-level operations.
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.
To install the this package, simply type add or install @aws-sdk/client-kinesis using your favorite package manager:
npm install @aws-sdk/client-kinesisyarn add @aws-sdk/client-kinesispnpm add @aws-sdk/client-kinesisThe 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:
// ES5 example
const { KinesisClient, ListShardsCommand } = require("@aws-sdk/client-kinesis");
// ES6+ example
import { KinesisClient, ListShardsCommand } from "@aws-sdk/client-kinesis";
To send a request, you:
send operation on client with command object as input.destroy() to close open connections.// a client can be shared by different commands.
const client = new KinesisClient({ region: "REGION" });
const params = {
/** input parameters */
};
const command = new ListShardsCommand(params);
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.
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.
});
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.
});
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";
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.
});
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;
* }
*/
}
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.
aws-sdk-js
on AWS Developer Blog.aws-sdk-js.To test your universal JavaScript code in Node.js, browser and react-native environments, visit our code samples repo.
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.
This SDK is distributed under the Apache License, Version 2.0, see LICENSE for more information.
3.645.0 (2024-09-04)
FAQs
AWS SDK for JavaScript Kinesis Client for Node.js, Browser and React Native
The npm package @aws-sdk/client-kinesis receives a total of 986,044 weekly downloads. As such, @aws-sdk/client-kinesis popularity was classified as popular.
We found that @aws-sdk/client-kinesis demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 5 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
PyPI confirms no security flaws were exploited in the Ultralytics supply chain attack and highlights improvements for safer package publishing.
Security News
Research
The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.