Amazon DynamoDB - API Reference

1 Amazon DynamoDBAPI ReferenceAmazon DynamoDB : API ReferenceCopyright 2020 Amazon Web Services, Inc. and/or its affiliates. All rights DynamoDB API ReferenceAmazon's trademarks and trade dress may not be used in connection with any product or service that is notAmazon's, in any manner that is likely to cause confusion among customers, or in any manner that disparages ordiscredits Amazon . All other trademarks not owned by Amazon are the property of their respective owners, who mayor may not be affiliated with, connected to, or sponsored by DynamoDB API ReferenceTable of ContentsWelcome .. 1 Actions .. 2 Amazon DynamoDB .. 5 BatchWriteItem.

2 13 CreateBackup .. 22 CreateGlobalTable .. 25 CreateTable .. 41 DeleteTable .. 63 DescribeGlobalTable .. 64 DescribeGlobalTableSettings .. 69 DescribeTable .. 72 DescribeTableReplicaAutoScaling .. 77 DescribeTimeToLive .. 91 ListGlobalTables .. 93 ListTables .. 96 ListTagsOfResource .. 101 Query .. 111 RestoreTableFromBackup .. 124 RestoreTableToPointInTime .. 137 TagResource .. 150 TransactGetItems .. 152 TransactWriteItems .. 158 UntagResource .. 171 UpdateGlobalTable .. 174 UpdateGlobalTableSettings .. 183 UpdateTable .. 195 UpdateTableReplicaAutoScaling .. 204 UpdateTimeToLive .. 209 Amazon DynamoDB Accelerator (DAX).

3 211 CreateCluster .. 212 CreateParameterGroup .. 218 CreateSubnetGroup .. 220 DecreaseReplicationFactor .. 226 DeleteParameterGroup .. 229 DeleteSubnetGroup .. 233 DescribeDefaultParameters .. 236iiiAmazon DynamoDB API ReferenceDescribeEvents .. 239 DescribeParameterGroups .. 242 DescribeParameters .. 245 DescribeSubnetGroups .. 248 IncreaseReplicationFactor .. 251 ListTags .. 255 RebootNode .. 258 TagResource .. 261 UntagResource .. 267 UpdateParameterGroup .. 271 UpdateSubnetGroup .. 273 Amazon DynamoDB Streams .. 275 DescribeStream .. 276 GetRecords .. 280 GetShardIterator .. 285 ListStreams .. 289 Data Types .. 293 Amazon DynamoDB .

4 295 ArchivalSummary .. 298 AttributeDefinition .. 299 AttributeValue .. 300 AttributeValueUpdate .. 303 AutoScalingPolicyDescription .. 305 AutoScalingPolicyUpdate .. 306 AutoScalingSettingsDescription .. 307 AutoScalingSettingsUpdate .. 309 AutoScalingTargetTrackingScalingPolicyCo nfigurationDescription .. 311 AutoScalingTargetTrackingScalingPolicyCo nfigurationUpdate .. 316 BackupSummary .. 318 BillingModeSummary .. 320 CancellationReason .. 321 Capacity .. 326 ConsumedCapacity .. 330 ContributorInsightsSummary .. 331 CreateGlobalSecondaryIndexAction .. 332 CreateReplicaAction .. 334 CreateReplicationGroupMemberAction .. 336 DeleteGlobalSecondaryIndexAction.

5 338 DeleteReplicaAction .. 339 DeleteReplicationGroupMemberAction .. 340 DeleteRequest .. 342 ExpectedAttributeValue .. 343 FailureException .. 348 GlobalSecondaryIndex .. 350 GlobalSecondaryIndexAutoScalingUpdate .. 352 GlobalSecondaryIndexDescription .. 353 GlobalSecondaryIndexInfo .. 356 GlobalSecondaryIndexUpdate .. 358ivAmazon DynamoDB API ReferenceGlobalTable .. 359 GlobalTableDescription .. 360 GlobalTableGlobalSecondaryIndexSettingsU pdate .. 362 ItemCollectionMetrics .. 363 ItemResponse .. 364 KeysAndAttributes .. 365 KeySchemaElement .. 367 LocalSecondaryIndex .. 369 LocalSecondaryIndexDescription .. 371 LocalSecondaryIndexInfo.

6 373 PointInTimeRecoveryDescription .. 375 PointInTimeRecoverySpecification .. 376 Projection .. 377 ProvisionedThroughput .. 378 ProvisionedThroughputDescription .. 379 ProvisionedThroughputOverride .. 381 Put .. 382 PutRequest .. 384 Replica .. 385 ReplicaAutoScalingDescription .. 386 ReplicaAutoScalingUpdate .. 388 ReplicaDescription .. 389 ReplicaGlobalSecondaryIndex .. 391 ReplicaGlobalSecondaryIndexAutoScalingDe scription .. 392 ReplicaGlobalSecondaryIndexAutoScalingUp date .. 394 ReplicaGlobalSecondaryIndexDescription .. 395 ReplicaGlobalSecondaryIndexSettingsDescr iption .. 396 ReplicaGlobalSecondaryIndexSettingsUpdat e .. 398 ReplicaSettingsDescription.

7 399 ReplicaSettingsUpdate .. 401 ReplicationGroupUpdate .. 402 ReplicaUpdate .. 403 RestoreSummary .. 404 SourceTableDetails .. 405 SourceTableFeatureDetails .. 407 SSED escription .. 409 SSES pecification .. 411 StreamSpecification .. 412 TableAutoScalingDescription .. 413 TableDescription .. 414 Tag .. 420 TimeToLiveDescription .. 421 TimeToLiveSpecification .. 422 TransactGetItem .. 423 TransactWriteItem .. 425 UpdateGlobalSecondaryIndexAction .. 427 UpdateReplicationGroupMemberAction .. 428 WriteRequest .. 429 Amazon DynamoDB Accelerator (DAX) .. 434 Event .. 436 NodeTypeSpecificValue .. 439 Parameter .. 440vAmazon DynamoDB API ReferenceParameterGroup.

8 442 ParameterGroupStatus .. 443 ParameterNameValue .. 444 SecurityGroupMembership .. 445 SSED escription .. 446 SSES pecification .. 448 SubnetGroup .. 449 Tag .. 450 Amazon DynamoDB Streams .. 450 AttributeValue .. 452 Identity .. 454 KeySchemaElement .. 455 Record .. 456 SequenceNumberRange .. 458 Shard .. 459 Stream .. 460 StreamDescription .. 461 StreamRecord .. 464 Common Errors .. 466viAmazon DynamoDB API ReferenceWelcomeAmazon DynamoDB provides low-level API actions for managing database tables and indexes, and forcreating, reading, updating and deleting data. DynamoDB also provides API actions for accessing andprocessing stream API Reference describes the low-level API for Amazon DynamoDB .

9 Instead of makingrequests to the low-level API directly from your application, we recommend that you use oneof the AWS Software Development Kits (SDKs) for your programming language. The AWSSDKs take care of request authentication, serialization, and connection management. For moreinformation, see Overview of AWS SDK Support for DynamoDB in the Amazon DynamoDBDeveloper the end of each API action description there are links to the equivalent CLI command andprogramming-specific language method. Similarly, at the end of each API datatype description, there arelinks to the equivalent programming-specific language DynamoDB API ReferenceActionsThe following actions are supported by Amazon DynamoDB : BatchGetItem (p.)

10 5) BatchWriteItem (p. 13) CreateBackup (p. 22) CreateGlobalTable (p. 25) CreateTable (p. 28) DeleteBackup (p. 38) DeleteItem (p. 41) DeleteTable (p. 50) DescribeBackup (p. 55) DescribeContinuousBackups (p. 58) DescribeContributorInsights (p. 60) DescribeEndpoints (p. 63) DescribeGlobalTable (p. 64) DescribeGlobalTableSettings (p. 66) DescribeLimits (p. 69) DescribeTable (p. 72) DescribeTableReplicaAutoScaling (p. 77) DescribeTimeToLive (p. 80) GetItem (p. 82) ListBackups (p. 88) ListContributorInsights (p. 91) ListGlobalTables (p. 93) ListTables (p. 96) ListTagsOfResource (p. 99) PutItem (p. 101) Query (p. 111) RestoreTableFromBackup (p.