@aws-sdk/client-dynamodb-streams

What is @aws-sdk/client-dynamodb-streams?

@aws-sdk/client-dynamodb-streams is a part of the AWS SDK for JavaScript, which allows you to interact with Amazon DynamoDB Streams. DynamoDB Streams capture a time-ordered sequence of item-level modifications in a DynamoDB table and store this information for up to 24 hours. This package enables you to work with these streams, allowing you to capture and process changes to your DynamoDB tables.

What are @aws-sdk/client-dynamodb-streams's main functionalities?

List Streams

This feature allows you to list all the streams associated with a DynamoDB table. The code sample demonstrates how to create a DynamoDBStreamsClient, create a ListStreamsCommand, and send the command to list the streams.

{"language":"javascript","content":"const { DynamoDBStreamsClient, ListStreamsCommand } = require('@aws-sdk/client-dynamodb-streams');\n\nconst client = new DynamoDBStreamsClient({ region: 'us-west-2' });\n\nconst listStreams = async () => {\n  const command = new ListStreamsCommand({ TableName: 'YourTableName' });\n  const response = await client.send(command);\n  console.log(response.Streams);\n};\n\nlistStreams();"}

Describe Stream

This feature allows you to describe a specific stream. The code sample demonstrates how to create a DescribeStreamCommand with a given StreamArn and send the command to get the stream description.

{"language":"javascript","content":"const { DynamoDBStreamsClient, DescribeStreamCommand } = require('@aws-sdk/client-dynamodb-streams');\n\nconst client = new DynamoDBStreamsClient({ region: 'us-west-2' });\n\nconst describeStream = async (streamArn) => {\n  const command = new DescribeStreamCommand({ StreamArn: streamArn });\n  const response = await client.send(command);\n  console.log(response.StreamDescription);\n};\n\ndescribeStream('your-stream-arn');"}

Get Shard Iterator

This feature allows you to get a shard iterator, which is used to read stream records from a shard. The code sample demonstrates how to create a GetShardIteratorCommand with the necessary parameters and send the command to get the shard iterator.

{"language":"javascript","content":"const { DynamoDBStreamsClient, GetShardIteratorCommand } = require('@aws-sdk/client-dynamodb-streams');\n\nconst client = new DynamoDBStreamsClient({ region: 'us-west-2' });\n\nconst getShardIterator = async (streamArn, shardId) => {\n  const command = new GetShardIteratorCommand({\n    StreamArn: streamArn,\n    ShardId: shardId,\n    ShardIteratorType: 'TRIM_HORIZON'\n  });\n  const response = await client.send(command);\n  console.log(response.ShardIterator);\n};\n\ngetShardIterator('your-stream-arn', 'your-shard-id');"}

Get Records

This feature allows you to get records from a shard using a shard iterator. The code sample demonstrates how to create a GetRecordsCommand with a given ShardIterator and send the command to retrieve the records.

{"language":"javascript","content":"const { DynamoDBStreamsClient, GetRecordsCommand } = require('@aws-sdk/client-dynamodb-streams');\n\nconst client = new DynamoDBStreamsClient({ region: 'us-west-2' });\n\nconst getRecords = async (shardIterator) => {\n  const command = new GetRecordsCommand({ ShardIterator: shardIterator });\n  const response = await client.send(command);\n  console.log(response.Records);\n};\n\ngetRecords('your-shard-iterator');"}

Other packages similar to @aws-sdk/client-dynamodb-streams

kinesis

The 'kinesis' package allows you to interact with Amazon Kinesis Streams, which is similar to DynamoDB Streams but designed for real-time processing of streaming data at scale. While DynamoDB Streams is specific to DynamoDB table changes, Kinesis Streams can handle a broader range of streaming data use cases.

aws-sdk

The 'aws-sdk' package is the older version of the AWS SDK for JavaScript, which includes support for DynamoDB Streams among many other AWS services. The newer modular packages like '@aws-sdk/client-dynamodb-streams' offer more fine-grained control and smaller bundle sizes.

README

@aws-sdk/client-dynamodb-streams

For SDK usage, please step to SDK reademe.