Table Of ContentAmazon DynamoDB
API Reference
Amazon DynamoDB API Reference
Amazon DynamoDB: API Reference
Copyright © 2022 Amazon Web Services, Inc. and/or its affiliates. All rights reserved.
Amazon's trademarks and trade dress may not be used in connection with any product or service that is not
Amazon's, in any manner that is likely to cause confusion among customers, or in any manner that disparages or
discredits Amazon. All other trademarks not owned by Amazon are the property of their respective owners, who may
or may not be affiliated with, connected to, or sponsored by Amazon.
Amazon DynamoDB API Reference
Table of Contents
Welcome........................................................................................................................................... 1
Actions............................................................................................................................................. 2
Amazon DynamoDB.................................................................................................................... 4
BatchExecuteStatement...................................................................................................... 6
BatchGetItem................................................................................................................... 10
BatchWriteItem................................................................................................................ 18
CreateBackup................................................................................................................... 27
CreateGlobalTable............................................................................................................ 30
CreateTable..................................................................................................................... 34
DeleteBackup................................................................................................................... 45
DeleteItem...................................................................................................................... 49
DeleteTable..................................................................................................................... 58
DescribeBackup................................................................................................................ 63
DescribeContinuousBackups............................................................................................... 66
DescribeContributorInsights............................................................................................... 68
DescribeEndpoints............................................................................................................ 71
DescribeExport................................................................................................................. 72
DescribeGlobalTable......................................................................................................... 74
DescribeGlobalTableSettings.............................................................................................. 76
DescribeImport................................................................................................................ 80
DescribeKinesisStreamingDestination.................................................................................. 83
DescribeLimits.................................................................................................................. 85
DescribeTable................................................................................................................... 88
DescribeTableReplicaAutoScaling........................................................................................ 93
DescribeTimeToLive.......................................................................................................... 96
DisableKinesisStreamingDestination.................................................................................... 98
EnableKinesisStreamingDestination................................................................................... 101
ExecuteStatement........................................................................................................... 104
ExecuteTransaction......................................................................................................... 110
ExportTableToPointInTime............................................................................................... 116
GetItem......................................................................................................................... 120
ImportTable................................................................................................................... 126
ListBackups.................................................................................................................... 131
ListContributorInsights.................................................................................................... 134
ListExports..................................................................................................................... 136
ListGlobalTables............................................................................................................. 139
ListImports.................................................................................................................... 142
ListTables...................................................................................................................... 145
ListTagsOfResource......................................................................................................... 148
PutItem......................................................................................................................... 150
Query............................................................................................................................ 160
RestoreTableFromBackup................................................................................................. 173
RestoreTableToPointInTime.............................................................................................. 179
Scan.............................................................................................................................. 186
TagResource................................................................................................................... 199
TransactGetItems............................................................................................................ 201
TransactWriteItems......................................................................................................... 207
UntagResource............................................................................................................... 216
UpdateContinuousBackups............................................................................................... 218
UpdateContributorInsights............................................................................................... 220
UpdateGlobalTable......................................................................................................... 223
UpdateGlobalTableSettings.............................................................................................. 226
UpdateItem.................................................................................................................... 232
UpdateTable.................................................................................................................. 244
iii
Amazon DynamoDB API Reference
UpdateTableReplicaAutoScaling ........................................................................................ 253
UpdateTimeToLive.......................................................................................................... 258
DynamoDB Accelerator............................................................................................................ 260
CreateCluster................................................................................................................. 262
CreateParameterGroup.................................................................................................... 268
CreateSubnetGroup......................................................................................................... 270
DecreaseReplicationFactor............................................................................................... 273
DeleteCluster................................................................................................................. 276
DeleteParameterGroup.................................................................................................... 279
DeleteSubnetGroup......................................................................................................... 281
DescribeClusters............................................................................................................. 283
DescribeDefaultParameters.............................................................................................. 286
DescribeEvents............................................................................................................... 289
DescribeParameterGroups................................................................................................ 292
DescribeParameters........................................................................................................ 295
DescribeSubnetGroups.................................................................................................... 298
IncreaseReplicationFactor................................................................................................. 301
ListTags......................................................................................................................... 305
RebootNode................................................................................................................... 308
TagResource................................................................................................................... 311
UntagResource............................................................................................................... 314
UpdateCluster................................................................................................................ 317
UpdateParameterGroup................................................................................................... 321
UpdateSubnetGroup....................................................................................................... 323
Amazon DynamoDB Streams .................................................................................................... 325
DescribeStream.............................................................................................................. 326
GetRecords.................................................................................................................... 330
GetShardIterator............................................................................................................. 336
ListStreams.................................................................................................................... 340
Data Types.................................................................................................................................... 344
Amazon DynamoDB................................................................................................................ 347
ArchivalSummary............................................................................................................ 350
AttributeDefinition.......................................................................................................... 351
AttributeValue................................................................................................................ 352
AttributeValueUpdate...................................................................................................... 355
AutoScalingPolicyDescription........................................................................................... 357
AutoScalingPolicyUpdate................................................................................................. 358
AutoScalingSettingsDescription........................................................................................ 359
AutoScalingSettingsUpdate.............................................................................................. 361
AutoScalingTargetTrackingScalingPolicyConfigurationDescription.......................................... 363
AutoScalingTargetTrackingScalingPolicyConfigurationUpdate............................................... 365
BackupDescription.......................................................................................................... 367
BackupDetails................................................................................................................ 368
BackupSummary............................................................................................................. 370
BatchStatementError....................................................................................................... 372
BatchStatementRequest.................................................................................................. 373
BatchStatementResponse................................................................................................ 374
BillingModeSummary...................................................................................................... 375
CancellationReason......................................................................................................... 376
Capacity........................................................................................................................ 377
Condition....................................................................................................................... 378
ConditionCheck.............................................................................................................. 381
ConsumedCapacity.......................................................................................................... 383
ContinuousBackupsDescription......................................................................................... 385
ContributorInsightsSummary............................................................................................ 386
CreateGlobalSecondaryIndexAction................................................................................... 387
CreateReplicaAction........................................................................................................ 389
iv
Amazon DynamoDB API Reference
CreateReplicationGroupMemberAction............................................................................... 390
CsvOptions.................................................................................................................... 392
Delete........................................................................................................................... 393
DeleteGlobalSecondaryIndexAction................................................................................... 395
DeleteReplicaAction........................................................................................................ 396
DeleteReplicationGroupMemberAction............................................................................... 397
DeleteRequest................................................................................................................ 398
Endpoint....................................................................................................................... 399
ExpectedAttributeValue................................................................................................... 400
ExportDescription........................................................................................................... 404
ExportSummary............................................................................................................. 408
FailureException............................................................................................................. 409
Get............................................................................................................................... 410
GlobalSecondaryIndex..................................................................................................... 412
GlobalSecondaryIndexAutoScalingUpdate.......................................................................... 414
GlobalSecondaryIndexDescription..................................................................................... 415
GlobalSecondaryIndexInfo............................................................................................... 418
GlobalSecondaryIndexUpdate........................................................................................... 420
GlobalTable................................................................................................................... 421
GlobalTableDescription.................................................................................................... 422
GlobalTableGlobalSecondaryIndexSettingsUpdate............................................................... 424
ImportSummary............................................................................................................. 425
ImportTableDescription................................................................................................... 427
InputFormatOptions........................................................................................................ 430
ItemCollectionMetrics...................................................................................................... 431
ItemResponse................................................................................................................. 432
KeysAndAttributes.......................................................................................................... 433
KeySchemaElement......................................................................................................... 435
KinesisDataStreamDestination.......................................................................................... 437
LocalSecondaryIndex....................................................................................................... 438
LocalSecondaryIndexDescription....................................................................................... 440
LocalSecondaryIndexInfo................................................................................................. 442
ParameterizedStatement................................................................................................. 444
PointInTimeRecoveryDescription....................................................................................... 445
PointInTimeRecoverySpecification..................................................................................... 446
Projection...................................................................................................................... 447
ProvisionedThroughput................................................................................................... 448
ProvisionedThroughputDescription.................................................................................... 449
ProvisionedThroughputOverride....................................................................................... 451
Put............................................................................................................................... 452
PutRequest.................................................................................................................... 454
Replica.......................................................................................................................... 455
ReplicaAutoScalingDescription.......................................................................................... 456
ReplicaAutoScalingUpdate............................................................................................... 458
ReplicaDescription.......................................................................................................... 459
ReplicaGlobalSecondaryIndex........................................................................................... 461
ReplicaGlobalSecondaryIndexAutoScalingDescription.......................................................... 462
ReplicaGlobalSecondaryIndexAutoScalingUpdate................................................................ 464
ReplicaGlobalSecondaryIndexDescription........................................................................... 465
ReplicaGlobalSecondaryIndexSettingsDescription................................................................ 466
ReplicaGlobalSecondaryIndexSettingsUpdate..................................................................... 468
ReplicaSettingsDescription............................................................................................... 469
ReplicaSettingsUpdate.................................................................................................... 471
ReplicationGroupUpdate.................................................................................................. 473
ReplicaUpdate................................................................................................................ 474
RestoreSummary............................................................................................................ 475
S3BucketSource.............................................................................................................. 476
v
Amazon DynamoDB API Reference
SourceTableDetails.......................................................................................................... 477
SourceTableFeatureDetails............................................................................................... 479
SSEDescription............................................................................................................... 481
SSESpecification............................................................................................................. 483
StreamSpecification........................................................................................................ 484
TableAutoScalingDescription............................................................................................ 485
TableClassSummary........................................................................................................ 486
TableCreationParameters................................................................................................. 487
TableDescription............................................................................................................. 489
Tag............................................................................................................................... 495
TimeToLiveDescription..................................................................................................... 496
TimeToLiveSpecification.................................................................................................. 497
TransactGetItem............................................................................................................. 498
TransactWriteItem.......................................................................................................... 499
Update.......................................................................................................................... 500
UpdateGlobalSecondaryIndexAction.................................................................................. 502
UpdateReplicationGroupMemberAction............................................................................. 503
WriteRequest................................................................................................................. 505
DynamoDB Accelerator............................................................................................................ 505
Cluster.......................................................................................................................... 507
Endpoint....................................................................................................................... 510
Event............................................................................................................................ 511
Node............................................................................................................................. 512
NodeTypeSpecificValue.................................................................................................... 514
NotificationConfiguration................................................................................................. 515
Parameter...................................................................................................................... 516
ParameterGroup............................................................................................................. 518
ParameterGroupStatus.................................................................................................... 519
ParameterNameValue...................................................................................................... 520
SecurityGroupMembership............................................................................................... 521
SSEDescription............................................................................................................... 522
SSESpecification............................................................................................................. 523
Subnet.......................................................................................................................... 524
SubnetGroup.................................................................................................................. 525
Tag............................................................................................................................... 526
Amazon DynamoDB Streams .................................................................................................... 526
AttributeValue................................................................................................................ 528
Identity......................................................................................................................... 531
KeySchemaElement......................................................................................................... 532
Record ........................................................................................................................... 534
SequenceNumberRange................................................................................................... 536
Shard............................................................................................................................ 537
Stream.......................................................................................................................... 538
StreamDescription.......................................................................................................... 539
StreamRecord................................................................................................................. 542
Common Errors.............................................................................................................................. 544
vi
Amazon DynamoDB API Reference
Welcome
Amazon DynamoDB provides low-level API actions for managing database tables and indexes, and for
creating, reading, updating and deleting data. DynamoDB also provides API actions for accessing and
processing stream records.
Note
This API Reference describes the low-level API for Amazon DynamoDB. Instead of making
requests to the low-level API directly from your application, we recommend that you use one
of the AWS Software Development Kits (SDKs) for your programming language. The AWS
SDKs take care of request authentication, serialization, and connection management. For more
information, see Overview of AWS SDK Support for DynamoDB in the Amazon DynamoDB
Developer Guide.
At the end of each API action description there are links to the equivalent CLI command and
programming-specific language method. Similarly, at the end of each API datatype description, there are
links to the equivalent programming-specific language type.
1
Amazon DynamoDB API Reference
Actions
The following actions are supported by Amazon DynamoDB:
• BatchExecuteStatement (p. 6)
• BatchGetItem (p. 10)
• BatchWriteItem (p. 18)
• CreateBackup (p. 27)
• CreateGlobalTable (p. 30)
• CreateTable (p. 34)
• DeleteBackup (p. 45)
• DeleteItem (p. 49)
• DeleteTable (p. 58)
• DescribeBackup (p. 63)
• DescribeContinuousBackups (p. 66)
• DescribeContributorInsights (p. 68)
• DescribeEndpoints (p. 71)
• DescribeExport (p. 72)
• DescribeGlobalTable (p. 74)
• DescribeGlobalTableSettings (p. 76)
• DescribeImport (p. 80)
• DescribeKinesisStreamingDestination (p. 83)
• DescribeLimits (p. 85)
• DescribeTable (p. 88)
• DescribeTableReplicaAutoScaling (p. 93)
• DescribeTimeToLive (p. 96)
• DisableKinesisStreamingDestination (p. 98)
• EnableKinesisStreamingDestination (p. 101)
• ExecuteStatement (p. 104)
• ExecuteTransaction (p. 110)
• ExportTableToPointInTime (p. 116)
• GetItem (p. 120)
• ImportTable (p. 126)
• ListBackups (p. 131)
• ListContributorInsights (p. 134)
• ListExports (p. 136)
• ListGlobalTables (p. 139)
• ListImports (p. 142)
• ListTables (p. 145)
• ListTagsOfResource (p. 148)
• PutItem (p. 150)
• Query (p. 160)
2
Amazon DynamoDB API Reference
• RestoreTableFromBackup (p. 173)
• RestoreTableToPointInTime (p. 179)
• Scan (p. 186)
• TagResource (p. 199)
• TransactGetItems (p. 201)
• TransactWriteItems (p. 207)
• UntagResource (p. 216)
• UpdateContinuousBackups (p. 218)
• UpdateContributorInsights (p. 220)
• UpdateGlobalTable (p. 223)
• UpdateGlobalTableSettings (p. 226)
• UpdateItem (p. 232)
• UpdateTable (p. 244)
• UpdateTableReplicaAutoScaling (p. 253)
• UpdateTimeToLive (p. 258)
The following actions are supported by DynamoDB Accelerator:
• CreateCluster (p. 262)
• CreateParameterGroup (p. 268)
• CreateSubnetGroup (p. 270)
• DecreaseReplicationFactor (p. 273)
• DeleteCluster (p. 276)
• DeleteParameterGroup (p. 279)
• DeleteSubnetGroup (p. 281)
• DescribeClusters (p. 283)
• DescribeDefaultParameters (p. 286)
• DescribeEvents (p. 289)
• DescribeParameterGroups (p. 292)
• DescribeParameters (p. 295)
• DescribeSubnetGroups (p. 298)
• IncreaseReplicationFactor (p. 301)
• ListTags (p. 305)
• RebootNode (p. 308)
• TagResource (p. 311)
• UntagResource (p. 314)
• UpdateCluster (p. 317)
• UpdateParameterGroup (p. 321)
• UpdateSubnetGroup (p. 323)
The following actions are supported by Amazon DynamoDB Streams:
• DescribeStream (p. 326)
• GetRecords (p. 330)
• GetShardIterator (p. 336)
• ListStreams (p. 340)
3
Amazon DynamoDB API Reference
Amazon DynamoDB
Amazon DynamoDB
The following actions are supported by Amazon DynamoDB:
• BatchExecuteStatement (p. 6)
• BatchGetItem (p. 10)
• BatchWriteItem (p. 18)
• CreateBackup (p. 27)
• CreateGlobalTable (p. 30)
• CreateTable (p. 34)
• DeleteBackup (p. 45)
• DeleteItem (p. 49)
• DeleteTable (p. 58)
• DescribeBackup (p. 63)
• DescribeContinuousBackups (p. 66)
• DescribeContributorInsights (p. 68)
• DescribeEndpoints (p. 71)
• DescribeExport (p. 72)
• DescribeGlobalTable (p. 74)
• DescribeGlobalTableSettings (p. 76)
• DescribeImport (p. 80)
• DescribeKinesisStreamingDestination (p. 83)
• DescribeLimits (p. 85)
• DescribeTable (p. 88)
• DescribeTableReplicaAutoScaling (p. 93)
• DescribeTimeToLive (p. 96)
• DisableKinesisStreamingDestination (p. 98)
• EnableKinesisStreamingDestination (p. 101)
• ExecuteStatement (p. 104)
• ExecuteTransaction (p. 110)
• ExportTableToPointInTime (p. 116)
• GetItem (p. 120)
• ImportTable (p. 126)
• ListBackups (p. 131)
• ListContributorInsights (p. 134)
• ListExports (p. 136)
• ListGlobalTables (p. 139)
• ListImports (p. 142)
• ListTables (p. 145)
• ListTagsOfResource (p. 148)
• PutItem (p. 150)
• Query (p. 160)
• RestoreTableFromBackup (p. 173)
• RestoreTableToPointInTime (p. 179)
• Scan (p. 186)
• TagResource (p. 199)
4
Description:Oct 23, 2014 Cloudfront, CloudTrail, Amazon DevPay, DynamoDB, ElastiCache, Amazon EC2,
Amazon Elastic Compute Cloud, Table of Contents.