@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

Description

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

Amazon DynamoDB

Amazon DynamoDB Streams provides API actions for accessing streams and processing stream records. To learn more about application development with Streams, see Capturing Table Activity with DynamoDB Streams in the Amazon DynamoDB Developer Guide.

Installing

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

• npm install @aws-sdk/client-dynamodb-streams
• yarn add @aws-sdk/client-dynamodb-streams
• pnpm add @aws-sdk/client-dynamodb-streams

Getting Started

Import

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

// ES5 example
const { DynamoDBStreamsClient, ListStreamsCommand } = require("@aws-sdk/client-dynamodb-streams");

// ES6+ example
import { DynamoDBStreamsClient, ListStreamsCommand } from "@aws-sdk/client-dynamodb-streams";

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

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

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

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

// callbacks.
client.listStreams(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.

• 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-dynamodb-streams 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)

DescribeStream

Command API Reference / Input / Output

GetRecords

Command API Reference / Input / Output

GetShardIterator

Command API Reference / Input / Output

ListStreams

Command API Reference / Input / Output

Changelog

3.679.0 (2024-10-24)

Features

• client-appconfig: This release improves deployment safety by granting customers the ability to REVERT completed deployments, to the last known good state.In the StopDeployment API revert case the status of a COMPLETE deployment will be REVERTED. AppConfig only allows a revert within 72 hours of deployment completion. (9c9494a)
• client-ec2: This release includes a new API to describe some details of the Amazon Machine Images (AMIs) that were used to launch EC2 instances, even if those AMIs are no longer available for use. (f624638)
• client-ecs: This release adds support for EBS volumes attached to Amazon ECS Windows tasks running on EC2 instances. (eba29d1)
• client-qbusiness: Add a new field in chat response. This field can be used to support nested schemas in array fields (e7c6ed5)
• clients: update client endpoints as of 2024-10-24 (c296fb5)