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.
To install 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
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";
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 DynamoDBClient({ region: "REGION" }); const params = { /** input parameters */ }; const command = new ListBackupsCommand(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-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. });
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-dynamodb
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.
Client Commands (Operations List) BatchExecuteStatementCommand API Reference / Input / Output
BatchGetItemCommand API Reference / Input / Output
BatchWriteItemCommand API Reference / Input / Output
CreateBackupCommand API Reference / Input / Output
CreateGlobalTableCommand API Reference / Input / Output
CreateTableCommand API Reference / Input / Output
DeleteBackupCommand API Reference / Input / Output
DeleteItemCommand API Reference / Input / Output
DeleteResourcePolicyCommand API Reference / Input / Output
DeleteTableCommand API Reference / Input / Output
DescribeBackupCommand API Reference / Input / Output
DescribeContinuousBackupsCommand API Reference / Input / Output
DescribeContributorInsightsCommand API Reference / Input / Output
DescribeEndpointsCommand API Reference / Input / Output
DescribeExportCommand API Reference / Input / Output
DescribeGlobalTableCommand API Reference / Input / Output
DescribeGlobalTableSettingsCommand API Reference / Input / Output
DescribeImportCommand API Reference / Input / Output
DescribeKinesisStreamingDestinationCommand API Reference / Input / Output
DescribeLimitsCommand API Reference / Input / Output
DescribeTableCommand API Reference / Input / Output
DescribeTableReplicaAutoScalingCommand API Reference / Input / Output
DescribeTimeToLiveCommand API Reference / Input / Output
DisableKinesisStreamingDestinationCommand API Reference / Input / Output
EnableKinesisStreamingDestinationCommand API Reference / Input / Output
ExecuteStatementCommand API Reference / Input / Output
ExecuteTransactionCommand API Reference / Input / Output
ExportTableToPointInTimeCommand API Reference / Input / Output
GetItemCommand API Reference / Input / Output
GetResourcePolicyCommand API Reference / Input / Output
ImportTableCommand API Reference / Input / Output
ListBackupsCommand API Reference / Input / Output
ListContributorInsightsCommand API Reference / Input / Output
ListExportsCommand API Reference / Input / Output
ListGlobalTablesCommand API Reference / Input / Output
ListImportsCommand API Reference / Input / Output
ListTablesCommand API Reference / Input / Output
ListTagsOfResourceCommand API Reference / Input / Output
PutItemCommand API Reference / Input / Output
PutResourcePolicyCommand API Reference / Input / Output
QueryCommand API Reference / Input / Output
RestoreTableFromBackupCommand API Reference / Input / Output
RestoreTableToPointInTimeCommand API Reference / Input / Output
ScanCommand API Reference / Input / Output
TagResourceCommand API Reference / Input / Output
TransactGetItemsCommand API Reference / Input / Output
TransactWriteItemsCommand API Reference / Input / Output
UntagResourceCommand API Reference / Input / Output
UpdateContinuousBackupsCommand API Reference / Input / Output
UpdateContributorInsightsCommand API Reference / Input / Output
UpdateGlobalTableCommand API Reference / Input / Output
UpdateGlobalTableSettingsCommand API Reference / Input / Output
UpdateItemCommand API Reference / Input / Output
UpdateKinesisStreamingDestinationCommand API Reference / Input / Output
UpdateTableCommand API Reference / Input / Output
UpdateTableReplicaAutoScalingCommand API Reference / Input / Output
UpdateTimeToLiveCommand API Reference / Input / Output
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4