@aws-sdk/client-dynamodb

Description

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

Amazon DynamoDB

Amazon DynamoDB is a fully managed NoSQL database service that provides fast and predictable performance with seamless scalability. DynamoDB lets you offload the administrative burdens of operating and scaling a distributed database, so that you don't have to worry about hardware provisioning, setup and configuration, replication, software patching, or cluster scaling.

With DynamoDB, you can create database tables that can store and retrieve any amount of data, and serve any level of request traffic. You can scale up or scale down your tables' throughput capacity without downtime or performance degradation, and use the Amazon Web Services Management Console to monitor resource utilization and performance metrics.

DynamoDB automatically spreads the data and traffic for your tables over a sufficient number of servers to handle your throughput and storage requirements, while maintaining consistent and fast performance. All of your data is stored on solid state disks (SSDs) and automatically replicated across multiple Availability Zones in an Amazon Web Services Region, providing built-in high availability and data durability.

Installing

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

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

Getting Started

Import

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

// ES5 example
const { DynamoDBClient, ListBackupsCommand } = require("@aws-sdk/client-dynamodb");

// ES6+ example
import { DynamoDBClient, ListBackupsCommand } from "@aws-sdk/client-dynamodb";

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

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

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

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

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

BatchExecuteStatement

Command API Reference / Input / Output

BatchGetItem

Command API Reference / Input / Output

BatchWriteItem

Command API Reference / Input / Output

CreateBackup

Command API Reference / Input / Output

CreateGlobalTable

Command API Reference / Input / Output

CreateTable

Command API Reference / Input / Output

DeleteBackup

Command API Reference / Input / Output

DeleteItem

Command API Reference / Input / Output

DeleteResourcePolicy

Command API Reference / Input / Output

DeleteTable

Command API Reference / Input / Output

DescribeBackup

Command API Reference / Input / Output

DescribeContinuousBackups

Command API Reference / Input / Output

DescribeContributorInsights

Command API Reference / Input / Output

DescribeEndpoints

Command API Reference / Input / Output

DescribeExport

Command API Reference / Input / Output

DescribeGlobalTable

Command API Reference / Input / Output

DescribeGlobalTableSettings

Command API Reference / Input / Output

DescribeImport

Command API Reference / Input / Output

DescribeKinesisStreamingDestination

Command API Reference / Input / Output

DescribeLimits

Command API Reference / Input / Output

DescribeTable

Command API Reference / Input / Output

DescribeTableReplicaAutoScaling

Command API Reference / Input / Output

DescribeTimeToLive

Command API Reference / Input / Output

DisableKinesisStreamingDestination

Command API Reference / Input / Output

EnableKinesisStreamingDestination

Command API Reference / Input / Output

ExecuteStatement

Command API Reference / Input / Output

ExecuteTransaction

Command API Reference / Input / Output

ExportTableToPointInTime

Command API Reference / Input / Output

GetItem

Command API Reference / Input / Output

GetResourcePolicy

Command API Reference / Input / Output

ImportTable

Command API Reference / Input / Output

ListBackups

Command API Reference / Input / Output

ListContributorInsights

Command API Reference / Input / Output

ListExports

Command API Reference / Input / Output

ListGlobalTables

Command API Reference / Input / Output

ListImports

Command API Reference / Input / Output

ListTables

Command API Reference / Input / Output

ListTagsOfResource

Command API Reference / Input / Output

PutItem

Command API Reference / Input / Output

PutResourcePolicy

Command API Reference / Input / Output

Query

Command API Reference / Input / Output

RestoreTableFromBackup

Command API Reference / Input / Output

RestoreTableToPointInTime

Command API Reference / Input / Output

Scan

Command API Reference / Input / Output

TagResource

Command API Reference / Input / Output

TransactGetItems

Command API Reference / Input / Output

TransactWriteItems

Command API Reference / Input / Output

UntagResource

Command API Reference / Input / Output

UpdateContinuousBackups

Command API Reference / Input / Output

UpdateContributorInsights

Command API Reference / Input / Output

UpdateGlobalTable

Command API Reference / Input / Output

UpdateGlobalTableSettings

Command API Reference / Input / Output

UpdateItem

Command API Reference / Input / Output

UpdateKinesisStreamingDestination

Command API Reference / Input / Output

UpdateTable

Command API Reference / Input / Output

UpdateTableReplicaAutoScaling

Command API Reference / Input / Output

UpdateTimeToLive

Command API Reference / Input / Output