Navigation Guide
You are on the package index page for the Client of a service. Return to the Client landing page

@aws-sdk/client-dynamodb

Description

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.

Installation

NPM

npm install @aws-sdk/client-dynamodb

Yarn

yarn add @aws-sdk/client-dynamodb

pnpm

pnpm add @aws-sdk/client-dynamodb

Types

Type Name	Type
ApproximateCreationDateTimePrecision	TypeAlias
ApproximateCreationDateTimePrecisionenum	Variable
ArchivalSummary	Interface
AttributeAction	TypeAlias
AttributeActionenum	Variable
AttributeDefinition	Interface
AttributeValue	Namespace
AttributeValue	TypeAlias
AttributeValueUpdate	Interface
AutoScalingPolicyDescription	Interface
AutoScalingPolicyUpdate	Interface
AutoScalingSettingsDescription	Interface
AutoScalingSettingsUpdate	Interface
AutoScalingTargetTrackingScalingPolicyConfigurationDescription	Interface
AutoScalingTargetTrackingScalingPolicyConfigurationUpdate	Interface
BackupDescription	Interface
BackupDetails	Interface
BackupInUseException	Class
BackupNotFoundException	Class
BackupStatus	TypeAlias
BackupStatusenum	Variable
BackupSummary	Interface
BackupType	TypeAlias
BackupTypeenum	Variable
BackupTypeFilter	TypeAlias
BackupTypeFilterenum	Variable
BatchExecuteStatementCommand	Class
BatchExecuteStatementCommandInput	Interface
BatchExecuteStatementCommandOutput	Interface
BatchExecuteStatementInput	Interface
BatchExecuteStatementOutput	Interface
BatchGetItemCommand	Class
BatchGetItemCommandInput	Interface
BatchGetItemCommandOutput	Interface
BatchGetItemInput	Interface
BatchGetItemOutput	Interface
BatchStatementError	Interface
BatchStatementErrorCodeEnum	TypeAlias
BatchStatementErrorCodeEnumenum	Variable
BatchStatementRequest	Interface
BatchStatementResponse	Interface
BatchWriteItemCommand	Class
BatchWriteItemCommandInput	Interface
BatchWriteItemCommandOutput	Interface
BatchWriteItemInput	Interface
BatchWriteItemOutput	Interface
BillingMode	TypeAlias
BillingModeenum	Variable
BillingModeSummary	Interface
CancellationReason	Interface
Capacity	Interface
ClientDefaults	Interface
ClientInputEndpointParameters	Interface
ComparisonOperator	TypeAlias
ComparisonOperatorenum	Variable
Condition	Interface
ConditionalCheckFailedException	Class
ConditionalOperator	TypeAlias
ConditionalOperatorenum	Variable
ConditionCheck	Interface
ConsumedCapacity	Interface
ContinuousBackupsDescription	Interface
ContinuousBackupsStatus	TypeAlias
ContinuousBackupsStatusenum	Variable
ContinuousBackupsUnavailableException	Class
ContributorInsightsAction	TypeAlias
ContributorInsightsActionenum	Variable
ContributorInsightsStatus	TypeAlias
ContributorInsightsStatusenum	Variable
ContributorInsightsSummary	Interface
CreateBackupCommand	Class
CreateBackupCommandInput	Interface
CreateBackupCommandOutput	Interface
CreateBackupInput	Interface
CreateBackupOutput	Interface
CreateGlobalSecondaryIndexAction	Interface
CreateGlobalTableCommand	Class
CreateGlobalTableCommandInput	Interface
CreateGlobalTableCommandOutput	Interface
CreateGlobalTableInput	Interface
CreateGlobalTableOutput	Interface
CreateReplicaAction	Interface
CreateReplicationGroupMemberAction	Interface
CreateTableCommand	Class
CreateTableCommandInput	Interface
CreateTableCommandOutput	Interface
CreateTableInput	Interface
CreateTableOutput	Interface
CsvOptions	Interface
Delete	Interface
DeleteBackupCommand	Class
DeleteBackupCommandInput	Interface
DeleteBackupCommandOutput	Interface
DeleteBackupInput	Interface
DeleteBackupOutput	Interface
DeleteGlobalSecondaryIndexAction	Interface
DeleteItemCommand	Class
DeleteItemCommandInput	Interface
DeleteItemCommandOutput	Interface
DeleteItemInput	Interface
DeleteItemOutput	Interface
DeleteReplicaAction	Interface
DeleteReplicationGroupMemberAction	Interface
DeleteRequest	Interface
DeleteResourcePolicyCommand	Class
DeleteResourcePolicyCommandInput	Interface
DeleteResourcePolicyCommandOutput	Interface
DeleteResourcePolicyInput	Interface
DeleteResourcePolicyOutput	Interface
DeleteTableCommand	Class
DeleteTableCommandInput	Interface
DeleteTableCommandOutput	Interface
DeleteTableInput	Interface
DeleteTableOutput	Interface
DescribeBackupCommand	Class
DescribeBackupCommandInput	Interface
DescribeBackupCommandOutput	Interface
DescribeBackupInput	Interface
DescribeBackupOutput	Interface
DescribeContinuousBackupsCommand	Class
DescribeContinuousBackupsCommandInput	Interface
DescribeContinuousBackupsCommandOutput	Interface
DescribeContinuousBackupsInput	Interface
DescribeContinuousBackupsOutput	Interface
DescribeContributorInsightsCommand	Class
DescribeContributorInsightsCommandInput	Interface
DescribeContributorInsightsCommandOutput	Interface
DescribeContributorInsightsInput	Interface
DescribeContributorInsightsOutput	Interface
DescribeEndpointsCommand	Class
DescribeEndpointsCommandInput	Interface
DescribeEndpointsCommandOutput	Interface
DescribeEndpointsRequest	Interface
DescribeEndpointsResponse	Interface
DescribeExportCommand	Class
DescribeExportCommandInput	Interface
DescribeExportCommandOutput	Interface
DescribeExportInput	Interface
DescribeExportOutput	Interface
DescribeGlobalTableCommand	Class
DescribeGlobalTableCommandInput	Interface
DescribeGlobalTableCommandOutput	Interface
DescribeGlobalTableInput	Interface
DescribeGlobalTableOutput	Interface
DescribeGlobalTableSettingsCommand	Class
DescribeGlobalTableSettingsCommandInput	Interface
DescribeGlobalTableSettingsCommandOutput	Interface
DescribeGlobalTableSettingsInput	Interface
DescribeGlobalTableSettingsOutput	Interface
DescribeImportCommand	Class
DescribeImportCommandInput	Interface
DescribeImportCommandOutput	Interface
DescribeImportInput	Interface
DescribeImportOutput	Interface
DescribeKinesisStreamingDestinationCommand	Class
DescribeKinesisStreamingDestinationCommandInput	Interface
DescribeKinesisStreamingDestinationCommandOutput	Interface
DescribeKinesisStreamingDestinationInput	Interface
DescribeKinesisStreamingDestinationOutput	Interface
DescribeLimitsCommand	Class
DescribeLimitsCommandInput	Interface
DescribeLimitsCommandOutput	Interface
DescribeLimitsInput	Interface
DescribeLimitsOutput	Interface
DescribeTableCommand	Class
DescribeTableCommandInput	Interface
DescribeTableCommandOutput	Interface
DescribeTableInput	Interface
DescribeTableOutput	Interface
DescribeTableReplicaAutoScalingCommand	Class
DescribeTableReplicaAutoScalingCommandInput	Interface
DescribeTableReplicaAutoScalingCommandOutput	Interface
DescribeTableReplicaAutoScalingInput	Interface
DescribeTableReplicaAutoScalingOutput	Interface
DescribeTimeToLiveCommand	Class
DescribeTimeToLiveCommandInput	Interface
DescribeTimeToLiveCommandOutput	Interface
DescribeTimeToLiveInput	Interface
DescribeTimeToLiveOutput	Interface
DestinationStatus	TypeAlias
DestinationStatusenum	Variable
DisableKinesisStreamingDestinationCommand	Class
DisableKinesisStreamingDestinationCommandInput	Interface
DisableKinesisStreamingDestinationCommandOutput	Interface
DuplicateItemException	Class
DynamoDB	Class
DynamoDB	Interface
DynamoDBClient	Class
DynamoDBClientConfig	Interface
DynamoDBClientConfigType	TypeAlias
DynamoDBClientResolvedConfig	Interface
DynamoDBClientResolvedConfigType	TypeAlias
DynamoDBPaginationConfiguration	Interface
DynamoDBServiceException	Class
EnableKinesisStreamingConfiguration	Interface
EnableKinesisStreamingDestinationCommand	Class
EnableKinesisStreamingDestinationCommandInput	Interface
EnableKinesisStreamingDestinationCommandOutput	Interface
Endpoint	Interface
ExecuteStatementCommand	Class
ExecuteStatementCommandInput	Interface
ExecuteStatementCommandOutput	Interface
ExecuteStatementInput	Interface
ExecuteStatementOutput	Interface
ExecuteTransactionCommand	Class
ExecuteTransactionCommandInput	Interface
ExecuteTransactionCommandOutput	Interface
ExecuteTransactionInput	Interface
ExecuteTransactionOutput	Interface
ExpectedAttributeValue	Interface
ExportConflictException	Class
ExportDescription	Interface
ExportFormat	TypeAlias
ExportFormatenum	Variable
ExportNotFoundException	Class
ExportStatus	TypeAlias
ExportStatusenum	Variable
ExportSummary	Interface
ExportTableToPointInTimeCommand	Class
ExportTableToPointInTimeCommandInput	Interface
ExportTableToPointInTimeCommandOutput	Interface
ExportTableToPointInTimeInput	Interface
ExportTableToPointInTimeOutput	Interface
ExportType	TypeAlias
ExportTypeenum	Variable
ExportViewType	TypeAlias
ExportViewTypeenum	Variable
FailureException	Interface
Get	Interface
GetItemCommand	Class
GetItemCommandInput	Interface
GetItemCommandOutput	Interface
GetItemInput	Interface
GetItemOutput	Interface
GetResourcePolicyCommand	Class
GetResourcePolicyCommandInput	Interface
GetResourcePolicyCommandOutput	Interface
GetResourcePolicyInput	Interface
GetResourcePolicyOutput	Interface
GlobalSecondaryIndex	Interface
GlobalSecondaryIndexAutoScalingUpdate	Interface
GlobalSecondaryIndexDescription	Interface
GlobalSecondaryIndexInfo	Interface
GlobalSecondaryIndexUpdate	Interface
GlobalSecondaryIndexWarmThroughputDescription	Interface
GlobalTable	Interface
GlobalTableAlreadyExistsException	Class
GlobalTableDescription	Interface
GlobalTableGlobalSecondaryIndexSettingsUpdate	Interface
GlobalTableNotFoundException	Class
GlobalTableStatus	TypeAlias
GlobalTableStatusenum	Variable
IdempotentParameterMismatchException	Class
ImportConflictException	Class
ImportNotFoundException	Class
ImportStatus	TypeAlias
ImportStatusenum	Variable
ImportSummary	Interface
ImportTableCommand	Class
ImportTableCommandInput	Interface
ImportTableCommandOutput	Interface
ImportTableDescription	Interface
ImportTableInput	Interface
ImportTableOutput	Interface
IncrementalExportSpecification	Interface
IndexNotFoundException	Class
IndexStatus	TypeAlias
IndexStatusenum	Variable
InputCompressionType	TypeAlias
InputCompressionTypeenum	Variable
InputFormat	TypeAlias
InputFormatenum	Variable
InputFormatOptions	Interface
InternalServerError	Class
InvalidEndpointException	Class
InvalidExportTimeException	Class
InvalidRestoreTimeException	Class
ItemCollectionMetrics	Interface
ItemCollectionSizeLimitExceededException	Class
ItemResponse	Interface
KeysAndAttributes	Interface
KeySchemaElement	Interface
KeyType	TypeAlias
KeyTypeenum	Variable
KinesisDataStreamDestination	Interface
KinesisStreamingDestinationInput	Interface
KinesisStreamingDestinationOutput	Interface
LimitExceededException	Class
ListBackupsCommand	Class
ListBackupsCommandInput	Interface
ListBackupsCommandOutput	Interface
ListBackupsInput	Interface
ListBackupsOutput	Interface
ListContributorInsightsCommand	Class
ListContributorInsightsCommandInput	Interface
ListContributorInsightsCommandOutput	Interface
ListContributorInsightsInput	Interface
ListContributorInsightsOutput	Interface
ListExportsCommand	Class
ListExportsCommandInput	Interface
ListExportsCommandOutput	Interface
ListExportsInput	Interface
ListExportsOutput	Interface
ListGlobalTablesCommand	Class
ListGlobalTablesCommandInput	Interface
ListGlobalTablesCommandOutput	Interface
ListGlobalTablesInput	Interface
ListGlobalTablesOutput	Interface
ListImportsCommand	Class
ListImportsCommandInput	Interface
ListImportsCommandOutput	Interface
ListImportsInput	Interface
ListImportsOutput	Interface
ListTablesCommand	Class
ListTablesCommandInput	Interface
ListTablesCommandOutput	Interface
ListTablesInput	Interface
ListTablesOutput	Interface
ListTagsOfResourceCommand	Class
ListTagsOfResourceCommandInput	Interface
ListTagsOfResourceCommandOutput	Interface
ListTagsOfResourceInput	Interface
ListTagsOfResourceOutput	Interface
LocalSecondaryIndex	Interface
LocalSecondaryIndexDescription	Interface
LocalSecondaryIndexInfo	Interface
MultiRegionConsistency	TypeAlias
MultiRegionConsistencyenum	Variable
OnDemandThroughput	Interface
OnDemandThroughputOverride	Interface
paginateListContributorInsights	Variable
paginateListExports	Variable
paginateListImports	Variable
paginateListTables	Variable
paginateQuery	Variable
paginateScan	Variable
ParameterizedStatement	Interface
PointInTimeRecoveryDescription	Interface
PointInTimeRecoverySpecification	Interface
PointInTimeRecoveryStatus	TypeAlias
PointInTimeRecoveryStatusenum	Variable
PointInTimeRecoveryUnavailableException	Class
PolicyNotFoundException	Class
Projection	Interface
ProjectionType	TypeAlias
ProjectionTypeenum	Variable
ProvisionedThroughput	Interface
ProvisionedThroughputDescription	Interface
ProvisionedThroughputExceededException	Class
ProvisionedThroughputOverride	Interface
Put	Interface
PutItemCommand	Class
PutItemCommandInput	Interface
PutItemCommandOutput	Interface
PutItemInput	Interface
PutItemOutput	Interface
PutRequest	Interface
PutResourcePolicyCommand	Class
PutResourcePolicyCommandInput	Interface
PutResourcePolicyCommandOutput	Interface
PutResourcePolicyInput	Interface
PutResourcePolicyOutput	Interface
QueryCommand	Class
QueryCommandInput	Interface
QueryCommandOutput	Interface
QueryInput	Interface
QueryOutput	Interface
Replica	Interface
ReplicaAlreadyExistsException	Class
ReplicaAutoScalingDescription	Interface
ReplicaAutoScalingUpdate	Interface
ReplicaDescription	Interface
ReplicaGlobalSecondaryIndex	Interface
ReplicaGlobalSecondaryIndexAutoScalingDescription	Interface
ReplicaGlobalSecondaryIndexAutoScalingUpdate	Interface
ReplicaGlobalSecondaryIndexDescription	Interface
ReplicaGlobalSecondaryIndexSettingsDescription	Interface
ReplicaGlobalSecondaryIndexSettingsUpdate	Interface
ReplicaNotFoundException	Class
ReplicaSettingsDescription	Interface
ReplicaSettingsUpdate	Interface
ReplicaStatus	TypeAlias
ReplicaStatusenum	Variable
ReplicatedWriteConflictException	Class
ReplicationGroupUpdate	Interface
ReplicaUpdate	Interface
RequestLimitExceeded	Class
ResourceInUseException	Class
ResourceNotFoundException	Class
RestoreSummary	Interface
RestoreTableFromBackupCommand	Class
RestoreTableFromBackupCommandInput	Interface
RestoreTableFromBackupCommandOutput	Interface
RestoreTableFromBackupInput	Interface
RestoreTableFromBackupOutput	Interface
RestoreTableToPointInTimeCommand	Class
RestoreTableToPointInTimeCommandInput	Interface
RestoreTableToPointInTimeCommandOutput	Interface
RestoreTableToPointInTimeInput	Interface
RestoreTableToPointInTimeOutput	Interface
ReturnConsumedCapacity	TypeAlias
ReturnConsumedCapacityenum	Variable
ReturnItemCollectionMetrics	TypeAlias
ReturnItemCollectionMetricsenum	Variable
ReturnValue	TypeAlias
ReturnValueenum	Variable
ReturnValuesOnConditionCheckFailure	TypeAlias
ReturnValuesOnConditionCheckFailureenum	Variable
RuntimeExtension	Interface
S3BucketSource	Interface
S3SseAlgorithm	TypeAlias
S3SseAlgorithmenum	Variable
ScalarAttributeType	TypeAlias
ScalarAttributeTypeenum	Variable
ScanCommand	Class
ScanCommandInput	Interface
ScanCommandOutput	Interface
ScanInput	Interface
ScanOutput	Interface
Select	TypeAlias
Selectenum	Variable
ServiceInputTypes	TypeAlias
ServiceOutputTypes	TypeAlias
SourceTableDetails	Interface
SourceTableFeatureDetails	Interface
SSEDescription	Interface
SSESpecification	Interface
SSEStatus	TypeAlias
SSEStatusenum	Variable
SSEType	TypeAlias
SSETypeenum	Variable
StreamSpecification	Interface
StreamViewType	TypeAlias
StreamViewTypeenum	Variable
TableAlreadyExistsException	Class
TableAutoScalingDescription	Interface
TableClass	TypeAlias
TableClassenum	Variable
TableClassSummary	Interface
TableCreationParameters	Interface
TableDescription	Interface
TableInUseException	Class
TableNotFoundException	Class
TableStatus	TypeAlias
TableStatusenum	Variable
TableWarmThroughputDescription	Interface
Tag	Interface
TagResourceCommand	Class
TagResourceCommandInput	Interface
TagResourceCommandOutput	Interface
TagResourceInput	Interface
TimeToLiveDescription	Interface
TimeToLiveSpecification	Interface
TimeToLiveStatus	TypeAlias
TimeToLiveStatusenum	Variable
TransactGetItem	Interface
TransactGetItemsCommand	Class
TransactGetItemsCommandInput	Interface
TransactGetItemsCommandOutput	Interface
TransactGetItemsInput	Interface
TransactGetItemsOutput	Interface
TransactionCanceledException	Class
TransactionConflictException	Class
TransactionInProgressException	Class
TransactWriteItem	Interface
TransactWriteItemsCommand	Class
TransactWriteItemsCommandInput	Interface
TransactWriteItemsCommandOutput	Interface
TransactWriteItemsInput	Interface
TransactWriteItemsOutput	Interface
UntagResourceCommand	Class
UntagResourceCommandInput	Interface
UntagResourceCommandOutput	Interface
UntagResourceInput	Interface
Update	Interface
UpdateContinuousBackupsCommand	Class
UpdateContinuousBackupsCommandInput	Interface
UpdateContinuousBackupsCommandOutput	Interface
UpdateContinuousBackupsInput	Interface
UpdateContinuousBackupsOutput	Interface
UpdateContributorInsightsCommand	Class
UpdateContributorInsightsCommandInput	Interface
UpdateContributorInsightsCommandOutput	Interface
UpdateContributorInsightsInput	Interface
UpdateContributorInsightsOutput	Interface
UpdateGlobalSecondaryIndexAction	Interface
UpdateGlobalTableCommand	Class
UpdateGlobalTableCommandInput	Interface
UpdateGlobalTableCommandOutput	Interface
UpdateGlobalTableInput	Interface
UpdateGlobalTableOutput	Interface
UpdateGlobalTableSettingsCommand	Class
UpdateGlobalTableSettingsCommandInput	Interface
UpdateGlobalTableSettingsCommandOutput	Interface
UpdateGlobalTableSettingsInput	Interface
UpdateGlobalTableSettingsOutput	Interface
UpdateItemCommand	Class
UpdateItemCommandInput	Interface
UpdateItemCommandOutput	Interface
UpdateItemInput	Interface
UpdateItemOutput	Interface
UpdateKinesisStreamingConfiguration	Interface
UpdateKinesisStreamingDestinationCommand	Class
UpdateKinesisStreamingDestinationCommandInput	Interface
UpdateKinesisStreamingDestinationCommandOutput	Interface
UpdateKinesisStreamingDestinationInput	Interface
UpdateKinesisStreamingDestinationOutput	Interface
UpdateReplicationGroupMemberAction	Interface
UpdateTableCommand	Class
UpdateTableCommandInput	Interface
UpdateTableCommandOutput	Interface
UpdateTableInput	Interface
UpdateTableOutput	Interface
UpdateTableReplicaAutoScalingCommand	Class
UpdateTableReplicaAutoScalingCommandInput	Interface
UpdateTableReplicaAutoScalingCommandOutput	Interface
UpdateTableReplicaAutoScalingInput	Interface
UpdateTableReplicaAutoScalingOutput	Interface
UpdateTimeToLiveCommand	Class
UpdateTimeToLiveCommandInput	Interface
UpdateTimeToLiveCommandOutput	Interface
UpdateTimeToLiveInput	Interface
UpdateTimeToLiveOutput	Interface
waitForTableExistsdeprecated	Variable
waitForTableNotExistsdeprecated	Variable
waitUntilTableExists	Variable
waitUntilTableNotExists	Variable
WarmThroughput	Interface
WriteRequest	Interface

Item	Package	Type
AcceptPrimaryEmailUpdateCommand Command/Operation Page	@aws-sdk/client-account	Class
AccessDeniedException	@aws-sdk/client-account	Class
Account	@aws-sdk/client-account	Class
AccountClient	@aws-sdk/client-account	Class
AccountServiceException	@aws-sdk/client-account	Class
ConflictException	@aws-sdk/client-account	Class
DeleteAlternateContactCommand Command/Operation Page	@aws-sdk/client-account	Class
DisableRegionCommand Command/Operation Page	@aws-sdk/client-account	Class
EnableRegionCommand Command/Operation Page	@aws-sdk/client-account	Class
GetAccountInformationCommand Command/Operation Page	@aws-sdk/client-account	Class

Select your cookie preferences

Customize cookie preferences

Essential

Performance

Functional

Advertising

Unable to save cookie preferences

Getting Started

References

@aws-sdk/client-dynamodb

Description

Installation

Types

Table of Contents

Search