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 AWS 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 AWS region, providing built-in high availability and data durability.
License: Apache 2.0 License
Resources
The BatchGetItem operation returns the attributes of one or more items from one or more tables. You identify requested items by primary key.
A single operation can retrieve up to 16 MB of data, which can contain as many as 100 items. BatchGetItem returns a partial result if the response size limit is exceeded, the table's provisioned throughput is exceeded, or an internal processing failure occurs. If a partial result is returned, the operation returns a value for UnprocessedKeys. You can use this value to retry the operation starting with the next item to get.
If you request more than 100 items, BatchGetItem returns a ValidationException with the message "Too many items requested for the BatchGetItem call."
For example, if you ask to retrieve 100 items, but each individual item is 300 KB in size, the system returns 52 items (so as not to exceed the 16 MB limit). It also returns an appropriate UnprocessedKeys value so you can get the next page of results. If desired, your application can include its own logic to assemble the pages of results into one dataset.
If none of the items can be processed due to insufficient provisioned throughput on all of the tables in the request, then BatchGetItem returns a ProvisionedThroughputExceededException. If at least one of the items is successfully processed, then BatchGetItem completes successfully, while returning the keys of the unread items in UnprocessedKeys.
If DynamoDB returns any unprocessed items, you should retry the batch operation on those items. However, we strongly recommend that you use an exponential backoff algorithm. If you retry the batch operation immediately, the underlying read or write requests can still fail due to throttling on the individual tables. If you delay the batch operation using exponential backoff, the individual requests in the batch are much more likely to succeed.
For more information, see Batch Operations and Error Handling in the Amazon DynamoDB Developer Guide.
By default, BatchGetItem performs eventually consistent reads on every table in the request. If you want strongly consistent reads instead, you can set ConsistentRead to true for any or all tables.
In order to minimize response latency, BatchGetItem retrieves items in parallel.
When designing your application, keep in mind that DynamoDB does not return items in any particular order. To help parse the response by item, include the primary key values for the items in your request in the ProjectionExpression parameter.
If a requested item does not exist, it is not returned in the result. Requests for nonexistent items consume the minimum read capacity units according to the type of read. For more information, see Working with Tables in the Amazon DynamoDB Developer Guide.
Request
Query
| Name | Data Type | Description |
|---|---|---|
RequestItems
|
string |
Pagination token |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-Target
|
string Allowed values: - DynamoDB_20120810.BatchGetItem |
|
X-Amz-Content-Sha256
|
string | |
X-Amz-Date
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Signature
|
string | |
X-Amz-SignedHeaders
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
BatchGetItemInput
|
object |
Represents the input of a |
Properties
RequestItems
|
BatchGetRequestMap |
A map of one or more table names and, for each table, a map that describes one or more items to retrieve from that table. Each table name can be used only once per Each element in the map of items to retrieve consists of the following:
|
||||
|
||||||
ReturnConsumedCapacity
|
ReturnConsumedCapacity | |||||
|
||||||
Responses
Body
| Name | Data Type | Description |
|---|---|---|
BatchGetItemOutput
|
object |
Represents the output of a |
Properties
Responses
|
BatchGetResponseMap |
A map of table name to a list of items. Each object in |
||||||||||||||||||||||||||||||||
Extends
ItemList
|
||||||||||||||||||||||||||||||||||
UnprocessedKeys
|
BatchGetRequestMap |
A map of tables and their respective keys that were not processed with the current response. The Each element consists of:
If there are no unprocessed keys remaining, the response contains an empty |
||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||
ConsumedCapacity
|
ConsumedCapacityMultiple |
The read capacity units consumed by the entire Each element consists of:
|
||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||
Examples
{
"Responses": {
"Music": [
{
"AlbumTitle": {
"S": "Somewhat Famous"
}
},
{
"AlbumTitle": {
"S": "Blue Sky Blues"
}
},
{
"AlbumTitle": {
"S": "Louder Than Ever"
}
}
]
}
}Body
| Name | Data Type | Description |
|---|---|---|
ProvisionedThroughputExceededException
|
Body
| Name | Data Type | Description |
|---|---|---|
ResourceNotFoundException
|
Body
| Name | Data Type | Description |
|---|---|---|
RequestLimitExceeded
|
Body
| Name | Data Type | Description |
|---|---|---|
InternalServerError
|
The BatchWriteItem operation puts or deletes multiple items in one or more tables. A single call to BatchWriteItem can write up to 16 MB of data, which can comprise as many as 25 put or delete requests. Individual items to be written can be as large as 400 KB.
BatchWriteItem cannot update items. To update items, use the UpdateItem action.
The individual PutItem and DeleteItem operations specified in BatchWriteItem are atomic; however BatchWriteItem as a whole is not. If any requested operations fail because the table's provisioned throughput is exceeded or an internal processing failure occurs, the failed operations are returned in the UnprocessedItems response parameter. You can investigate and optionally resend the requests. Typically, you would call BatchWriteItem in a loop. Each iteration would check for unprocessed items and submit a new BatchWriteItem request with those unprocessed items until all items have been processed.
If none of the items can be processed due to insufficient provisioned throughput on all of the tables in the request, then BatchWriteItem returns a ProvisionedThroughputExceededException.
If DynamoDB returns any unprocessed items, you should retry the batch operation on those items. However, we strongly recommend that you use an exponential backoff algorithm. If you retry the batch operation immediately, the underlying read or write requests can still fail due to throttling on the individual tables. If you delay the batch operation using exponential backoff, the individual requests in the batch are much more likely to succeed.
For more information, see Batch Operations and Error Handling in the Amazon DynamoDB Developer Guide.
With BatchWriteItem, you can efficiently write or delete large amounts of data, such as from Amazon EMR, or copy data from another database into DynamoDB. In order to improve performance with these large-scale operations, BatchWriteItem does not behave in the same way as individual PutItem and DeleteItem calls would. For example, you cannot specify conditions on individual put and delete requests, and BatchWriteItem does not return deleted items in the response.
If you use a programming language that supports concurrency, you can use threads to write items in parallel. Your application must include the necessary logic to manage the threads. With languages that don't support threading, you must update or delete the specified items one at a time. In both situations, BatchWriteItem performs the specified put and delete operations in parallel, giving you the power of the thread pool approach without having to introduce complexity into your application.
Parallel processing reduces latency, but each specified put and delete request consumes the same number of write capacity units whether it is processed in parallel or not. Delete operations on nonexistent items consume one write capacity unit.
If one or more of the following is true, DynamoDB rejects the entire batch write operation:
-
One or more tables specified in the
BatchWriteItemrequest does not exist. -
Primary key attributes specified on an item in the request do not match those in the corresponding table's primary key schema.
-
You try to perform multiple operations on the same item in the same
BatchWriteItemrequest. For example, you cannot put and delete the same item in the sameBatchWriteItemrequest. -
Your request contains at least two items with identical hash and range keys (which essentially is two put operations).
-
There are more than 25 requests in the batch.
-
Any individual item in a batch exceeds 400 KB.
-
The total request size exceeds 16 MB.
Request
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-Target
|
string Allowed values: - DynamoDB_20120810.BatchWriteItem |
|
X-Amz-Content-Sha256
|
string | |
X-Amz-Date
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Signature
|
string | |
X-Amz-SignedHeaders
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
BatchWriteItemInput
|
object |
Represents the input of a |
Properties
RequestItems
|
BatchWriteItemRequestMap |
A map of one or more table names and, for each table, a list of operations to be performed (
|
||||
|
||||||
ReturnConsumedCapacity
|
ReturnConsumedCapacity | |||||
|
||||||
ReturnItemCollectionMetrics
|
ReturnItemCollectionMetrics |
Determines whether item collection metrics are returned. If set to |
||||
|
||||||
Responses
Body
| Name | Data Type | Description |
|---|---|---|
BatchWriteItemOutput
|
object |
Represents the output of a |
Properties
UnprocessedItems
|
BatchWriteItemRequestMap |
A map of tables and requests against those tables that were not processed. The Each
If there are no unprocessed items remaining, the response contains an empty |
||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||
ItemCollectionMetrics
|
ItemCollectionMetricsPerTable |
A list of tables that were processed by Each entry consists of the following subelements:
|
||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||
ConsumedCapacity
|
ConsumedCapacityMultiple |
The capacity units consumed by the entire Each element consists of:
|
||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||
Body
| Name | Data Type | Description |
|---|---|---|
ProvisionedThroughputExceededException
|
Body
| Name | Data Type | Description |
|---|---|---|
ResourceNotFoundException
|
Body
| Name | Data Type | Description |
|---|---|---|
ItemCollectionSizeLimitExceededException
|
Body
| Name | Data Type | Description |
|---|---|---|
RequestLimitExceeded
|
Body
| Name | Data Type | Description |
|---|---|---|
InternalServerError
|
Creates a backup for an existing table.
Each time you create an on-demand backup, the entire table data is backed up. There is no limit to the number of on-demand backups that can be taken.
When you create an on-demand backup, a time marker of the request is cataloged, and the backup is created asynchronously, by applying all changes until the time of the request to the last full table snapshot. Backup requests are processed instantaneously and become available for restore within minutes.
You can call CreateBackup at a maximum rate of 50 times per second.
All backups in DynamoDB work without consuming any provisioned throughput on the table.
If you submit a backup request on 2018-12-14 at 14:25:00, the backup is guaranteed to contain all data committed to the table up to 14:24:00, and data committed after 14:26:00 will not be. The backup might contain data modifications made between 14:24:00 and 14:26:00. On-demand backup does not support causal consistency.
Along with data, the following are also included on the backups:
-
Global secondary indexes (GSIs)
-
Local secondary indexes (LSIs)
-
Streams
-
Provisioned read and write capacity
Request
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-Target
|
string Allowed values: - DynamoDB_20120810.CreateBackup |
|
X-Amz-Content-Sha256
|
string | |
X-Amz-Date
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Signature
|
string | |
X-Amz-SignedHeaders
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
CreateBackupInput
|
object |
Properties
TableName
|
TableName |
The name of the table. |
||||
|
||||||
BackupName
|
BackupName |
Specified name for the backup. |
||||
|
||||||
Responses
Body
| Name | Data Type | Description |
|---|---|---|
CreateBackupOutput
|
object |
Properties
BackupDetails
|
BackupDetails |
Contains the details of the backup created for the table. |
||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||
Body
| Name | Data Type | Description |
|---|---|---|
TableNotFoundException
|
Body
| Name | Data Type | Description |
|---|---|---|
TableInUseException
|
Body
| Name | Data Type | Description |
|---|---|---|
ContinuousBackupsUnavailableException
|
Body
| Name | Data Type | Description |
|---|---|---|
BackupInUseException
|
Body
| Name | Data Type | Description |
|---|---|---|
LimitExceededException
|
Body
| Name | Data Type | Description |
|---|---|---|
InternalServerError
|
Creates a global table from an existing table. A global table creates a replication relationship between two or more DynamoDB tables with the same table name in the provided Regions.
This method only applies to Version 2017.11.29 of global tables.
If you want to add a new replica table to a global table, each of the following conditions must be true:
-
The table must have the same primary key as all of the other replicas.
-
The table must have the same name as all of the other replicas.
-
The table must have DynamoDB Streams enabled, with the stream containing both the new and the old images of the item.
-
None of the replica tables in the global table can contain any data.
If global secondary indexes are specified, then the following conditions must also be met:
-
The global secondary indexes must have the same name.
-
The global secondary indexes must have the same hash key and sort key (if present).
Write capacity settings should be set consistently across your replica tables and secondary indexes. DynamoDB strongly recommends enabling auto scaling to manage the write capacity settings for all of your global tables replicas and indexes.
If you prefer to manage write capacity settings manually, you should provision equal replicated write capacity units to your replica tables. You should also provision equal replicated write capacity units to matching secondary indexes across your global table.
Request
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-Target
|
string Allowed values: - DynamoDB_20120810.CreateGlobalTable |
|
X-Amz-Content-Sha256
|
string | |
X-Amz-Date
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Signature
|
string | |
X-Amz-SignedHeaders
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
CreateGlobalTableInput
|
object |
Properties
GlobalTableName
|
TableName |
The global table name. |
||||
|
||||||
ReplicationGroup
|
ReplicaList |
The Regions where the global table needs to be created. |
||||
|
||||||
Responses
Body
| Name | Data Type | Description |
|---|---|---|
CreateGlobalTableOutput
|
object |
Properties
GlobalTableDescription
|
GlobalTableDescription |
Contains the details of the global table. |
|||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||
Body
| Name | Data Type | Description |
|---|---|---|
LimitExceededException
|
Body
| Name | Data Type | Description |
|---|---|---|
InternalServerError
|
Body
| Name | Data Type | Description |
|---|---|---|
GlobalTableAlreadyExistsException
|
Body
| Name | Data Type | Description |
|---|---|---|
TableNotFoundException
|
The CreateTable operation adds a new table to your account. In an AWS account, table names must be unique within each Region. That is, you can have two tables with same name if you create the tables in different Regions.
CreateTable is an asynchronous operation. Upon receiving a CreateTable request, DynamoDB immediately returns a response with a TableStatus of CREATING. After the table is created, DynamoDB sets the TableStatus to ACTIVE. You can perform read and write operations only on an ACTIVE table.
You can optionally define secondary indexes on the new table, as part of the CreateTable operation. If you want to create multiple tables with secondary indexes on them, you must create the tables sequentially. Only one table with secondary indexes can be in the CREATING state at any given time.
You can use the DescribeTable action to check the table status.
Request
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-Target
|
string Allowed values: - DynamoDB_20120810.CreateTable |
|
X-Amz-Content-Sha256
|
string | |
X-Amz-Date
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Signature
|
string | |
X-Amz-SignedHeaders
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
CreateTableInput
|
object |
Represents the input of a |
Properties
AttributeDefinitions
|
AttributeDefinitions |
An array of attributes that describe the key schema for the table and indexes. |
||||||||||||||||||||||||
|
||||||||||||||||||||||||||
TableName
|
TableName |
The name of the table to create. |
||||||||||||||||||||||||
|
||||||||||||||||||||||||||
KeySchema
|
KeySchema |
Specifies the attributes that make up the primary key for a table or an index. The attributes in Each
The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from the DynamoDB usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value. For a simple primary key (partition key), you must provide exactly one element with a For a composite primary key (partition key and sort key), you must provide exactly two elements, in this order: The first element must have a For more information, see Working with Tables in the Amazon DynamoDB Developer Guide. |
||||||||||||||||||||||||
|
||||||||||||||||||||||||||
LocalSecondaryIndexes
|
LocalSecondaryIndexList |
One or more local secondary indexes (the maximum is 5) to be created on the table. Each index is scoped to a given partition key value. There is a 10 GB size limit per partition key value; otherwise, the size of a local secondary index is unconstrained. Each local secondary index in the array includes the following:
|
||||||||||||||||||||||||
|
||||||||||||||||||||||||||
GlobalSecondaryIndexes
|
GlobalSecondaryIndexList |
One or more global secondary indexes (the maximum is 20) to be created on the table. Each global secondary index in the array includes the following:
|
||||||||||||||||||||||||
|
||||||||||||||||||||||||||
BillingMode
|
BillingMode |
Controls how you are charged for read and write throughput and how you manage capacity. This setting can be changed later.
|
||||||||||||||||||||||||
|
||||||||||||||||||||||||||
ProvisionedThroughput
|
ProvisionedThroughput |
Represents the provisioned throughput settings for a specified table or index. The settings can be modified using the If you set BillingMode as For current minimum and maximum provisioned throughput values, see Limits in the Amazon DynamoDB Developer Guide. |
||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||
StreamSpecification
|
StreamSpecification |
The settings for DynamoDB Streams on the table. These settings consist of:
|
||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||
SSESpecification
|
SSESpecification |
Represents the settings used to enable server-side encryption. |
||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||
Tags
|
TagList |
A list of key-value pairs to label the table. For more information, see Tagging for DynamoDB. |
||||||||||||||||||||||||
|
||||||||||||||||||||||||||
Responses
Body
| Name | Data Type | Description |
|---|---|---|
CreateTableOutput
|
object |
Represents the output of a |
Properties
TableDescription
|
TableDescription |
Represents the properties of the table. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Examples
{
"TableDescription": {
"AttributeDefinitions": [
{
"AttributeName": "Artist",
"AttributeType": "S"
},
{
"AttributeName": "SongTitle",
"AttributeType": "S"
}
],
"CreationDateTime": "1421866952.062",
"ItemCount": 0,
"KeySchema": [
{
"AttributeName": "Artist",
"KeyType": "HASH"
},
{
"AttributeName": "SongTitle",
"KeyType": "RANGE"
}
],
"ProvisionedThroughput": {
"ReadCapacityUnits": 5,
"WriteCapacityUnits": 5
},
"TableName": "Music",
"TableSizeBytes": 0,
"TableStatus": "CREATING"
}
}Body
| Name | Data Type | Description |
|---|---|---|
ResourceInUseException
|
Body
| Name | Data Type | Description |
|---|---|---|
LimitExceededException
|
Body
| Name | Data Type | Description |
|---|---|---|
InternalServerError
|
Deletes an existing backup of a table.
You can call DeleteBackup at a maximum rate of 10 times per second.
Request
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-Target
|
string Allowed values: - DynamoDB_20120810.DeleteBackup |
|
X-Amz-Content-Sha256
|
string | |
X-Amz-Date
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Signature
|
string | |
X-Amz-SignedHeaders
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
DeleteBackupInput
|
object |
Properties
BackupArn
|
BackupArn |
The ARN associated with the backup. |
||||
|
||||||
Responses
Body
| Name | Data Type | Description |
|---|---|---|
DeleteBackupOutput
|
object |
Properties
BackupDescription
|
BackupDescription |
Contains the description of the backup created for the table. |
|||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||
Body
| Name | Data Type | Description |
|---|---|---|
BackupNotFoundException
|
Body
| Name | Data Type | Description |
|---|---|---|
BackupInUseException
|
Body
| Name | Data Type | Description |
|---|---|---|
LimitExceededException
|
Body
| Name | Data Type | Description |
|---|---|---|
InternalServerError
|
Deletes a single item in a table by primary key. You can perform a conditional delete operation that deletes the item if it exists, or if it has an expected attribute value.
In addition to deleting an item, you can also return the item's attribute values in the same operation, using the ReturnValues parameter.
Unless you specify conditions, the DeleteItem is an idempotent operation; running it multiple times on the same item or attribute does not result in an error response.
Conditional deletes are useful for deleting items only if specific conditions are met. If those conditions are met, DynamoDB performs the delete. Otherwise, the item is not deleted.
Request
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-Target
|
string Allowed values: - DynamoDB_20120810.DeleteItem |
|
X-Amz-Content-Sha256
|
string | |
X-Amz-Date
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Signature
|
string | |
X-Amz-SignedHeaders
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
DeleteItemInput
|
object |
Represents the input of a |
Properties
TableName
|
TableName |
The name of the table from which to delete the item. |
||||
|
||||||
Key
|
Key |
A map of attribute names to For the primary key, you must provide all of the attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key. |
||||
|
||||||
Expected
|
ExpectedAttributeMap |
This is a legacy parameter. Use |
||||
|
||||||
ConditionalOperator
|
ConditionalOperator |
This is a legacy parameter. Use |
||||
|
||||||
ReturnValues
|
ReturnValue |
Use
The |
||||
|
||||||
ReturnConsumedCapacity
|
ReturnConsumedCapacity | |||||
|
||||||
ReturnItemCollectionMetrics
|
ReturnItemCollectionMetrics |
Determines whether item collection metrics are returned. If set to |
||||
|
||||||
ConditionExpression
|
ConditionExpression |
A condition that must be satisfied in order for a conditional An expression can contain any of the following:
For more information about condition expressions, see Condition Expressions in the Amazon DynamoDB Developer Guide. |
||||
|
||||||
ExpressionAttributeNames
|
ExpressionAttributeNameMap |
One or more substitution tokens for attribute names in an expression. The following are some use cases for using
Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:
The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for
You could then use this substitution in an expression, as in this example:
Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime. For more information on expression attribute names, see Specifying Item Attributes in the Amazon DynamoDB Developer Guide. |
||||
|
||||||
ExpressionAttributeValues
|
ExpressionAttributeValueMap |
One or more values that can be substituted in an expression. Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the ProductStatus attribute was one of the following: You would first need to specify You could then use these values in an expression, such as this: For more information on expression attribute values, see Condition Expressions in the Amazon DynamoDB Developer Guide. |
||||
|
||||||
Responses
Body
| Name | Data Type | Description |
|---|---|---|
DeleteItemOutput
|
object |
Represents the output of a |
Properties
Attributes
|
AttributeMap |
A map of attribute names to |
||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||
ConsumedCapacity
|
ConsumedCapacity |
The capacity units consumed by the |
||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||
ItemCollectionMetrics
|
ItemCollectionMetrics |
Information about item collections, if any, that were affected by the Each
|
||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||
Examples
{
"ConsumedCapacity": {
"CapacityUnits": 1,
"TableName": "Music"
}
}Body
| Name | Data Type | Description |
|---|---|---|
ConditionalCheckFailedException
|
Body
| Name | Data Type | Description |
|---|---|---|
ProvisionedThroughputExceededException
|
Body
| Name | Data Type | Description |
|---|---|---|
ResourceNotFoundException
|
Body
| Name | Data Type | Description |
|---|---|---|
ItemCollectionSizeLimitExceededException
|
Body
| Name | Data Type | Description |
|---|---|---|
TransactionConflictException
|
Body
| Name | Data Type | Description |
|---|---|---|
RequestLimitExceeded
|
Body
| Name | Data Type | Description |
|---|---|---|
InternalServerError
|
The DeleteTable operation deletes a table and all of its items. After a DeleteTable request, the specified table is in the DELETING state until DynamoDB completes the deletion. If the table is in the ACTIVE state, you can delete it. If a table is in CREATING or UPDATING states, then DynamoDB returns a ResourceInUseException. If the specified table does not exist, DynamoDB returns a ResourceNotFoundException. If table is already in the DELETING state, no error is returned.
DynamoDB might continue to accept data read and write operations, such as GetItem and PutItem, on a table in the DELETING state until the table deletion is complete.
When you delete a table, any indexes on that table are also deleted.
If you have DynamoDB Streams enabled on the table, then the corresponding stream on that table goes into the DISABLED state, and the stream is automatically deleted after 24 hours.
Use the DescribeTable action to check the status of the table.
Request
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-Target
|
string Allowed values: - DynamoDB_20120810.DeleteTable |
|
X-Amz-Content-Sha256
|
string | |
X-Amz-Date
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Signature
|
string | |
X-Amz-SignedHeaders
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
DeleteTableInput
|
object |
Represents the input of a |
Properties
TableName
|
TableName |
The name of the table to delete. |
||||
|
||||||
Responses
Body
| Name | Data Type | Description |
|---|---|---|
DeleteTableOutput
|
object |
Represents the output of a |
Properties
TableDescription
|
TableDescription |
Represents the properties of a table. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Examples
{
"TableDescription": {
"ItemCount": 0,
"ProvisionedThroughput": {
"NumberOfDecreasesToday": 1,
"ReadCapacityUnits": 5,
"WriteCapacityUnits": 5
},
"TableName": "Music",
"TableSizeBytes": 0,
"TableStatus": "DELETING"
}
}Body
| Name | Data Type | Description |
|---|---|---|
ResourceInUseException
|
Body
| Name | Data Type | Description |
|---|---|---|
ResourceNotFoundException
|
Body
| Name | Data Type | Description |
|---|---|---|
LimitExceededException
|
Body
| Name | Data Type | Description |
|---|---|---|
InternalServerError
|
Describes an existing backup of a table.
You can call DescribeBackup at a maximum rate of 10 times per second.
Request
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-Target
|
string Allowed values: - DynamoDB_20120810.DescribeBackup |
|
X-Amz-Content-Sha256
|
string | |
X-Amz-Date
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Signature
|
string | |
X-Amz-SignedHeaders
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
DescribeBackupInput
|
object |
Properties
BackupArn
|
BackupArn |
The Amazon Resource Name (ARN) associated with the backup. |
||||
|
||||||
Responses
Body
| Name | Data Type | Description |
|---|---|---|
DescribeBackupOutput
|
object |
Properties
BackupDescription
|
BackupDescription |
Contains the description of the backup created for the table. |
|||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||
Body
| Name | Data Type | Description |
|---|---|---|
BackupNotFoundException
|
Body
| Name | Data Type | Description |
|---|---|---|
InternalServerError
|
Checks the status of continuous backups and point in time recovery on the specified table. Continuous backups are ENABLED on all tables at table creation. If point in time recovery is enabled, PointInTimeRecoveryStatus will be set to ENABLED.
After continuous backups and point in time recovery are enabled, you can restore to any point in time within EarliestRestorableDateTime and LatestRestorableDateTime.
LatestRestorableDateTime is typically 5 minutes before the current time. You can restore your table to any point in time during the last 35 days.
You can call DescribeContinuousBackups at a maximum rate of 10 times per second.
Request
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-Target
|
string Allowed values: - DynamoDB_20120810.DescribeContinuousBackups |
|
X-Amz-Content-Sha256
|
string | |
X-Amz-Date
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Signature
|
string | |
X-Amz-SignedHeaders
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
DescribeContinuousBackupsInput
|
object |
Properties
TableName
|
TableName |
Name of the table for which the customer wants to check the continuous backups and point in time recovery settings. |
||||
|
||||||
Responses
Body
| Name | Data Type | Description |
|---|---|---|
DescribeContinuousBackupsOutput
|
object |
Properties
ContinuousBackupsDescription
|
ContinuousBackupsDescription |
Represents the continuous backups and point in time recovery settings on the table. |
||||||||||
Properties
|
||||||||||||
Body
| Name | Data Type | Description |
|---|---|---|
TableNotFoundException
|
Body
| Name | Data Type | Description |
|---|---|---|
InternalServerError
|
Returns information about contributor insights, for a given table or global secondary index.
Request
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-Target
|
string Allowed values: - DynamoDB_20120810.DescribeContributorInsights |
|
X-Amz-Content-Sha256
|
string | |
X-Amz-Date
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Signature
|
string | |
X-Amz-SignedHeaders
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
DescribeContributorInsightsInput
|
object |
Properties
TableName
|
TableName |
The name of the table to describe. |
||||
|
||||||
IndexName
|
IndexName |
The name of the global secondary index to describe, if applicable. |
||||
|
||||||
Responses
Body
| Name | Data Type | Description |
|---|---|---|
DescribeContributorInsightsOutput
|
object |
Properties
TableName
|
TableName |
The name of the table being described. |
||||||||||
|
||||||||||||
IndexName
|
IndexName |
The name of the global secondary index being described. |
||||||||||
|
||||||||||||
ContributorInsightsRuleList
|
ContributorInsightsRuleList |
List of names of the associated Alpine rules. |
||||||||||
|
||||||||||||
ContributorInsightsStatus
|
ContributorInsightsStatus |
Current Status contributor insights. |
||||||||||
|
||||||||||||
LastUpdateDateTime
|
LastUpdateDateTime |
Timestamp of the last time the status was changed. |
||||||||||
|
||||||||||||
FailureException
|
FailureException |
Returns information about the last failure that encountered. The most common exceptions for a FAILED status are:
|
||||||||||
Properties
|
||||||||||||
Body
| Name | Data Type | Description |
|---|---|---|
ResourceNotFoundException
|
Body
| Name | Data Type | Description |
|---|---|---|
InternalServerError
|
Returns the regional endpoint information.
Request
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-Target
|
string Allowed values: - DynamoDB_20120810.DescribeEndpoints |
|
X-Amz-Content-Sha256
|
string | |
X-Amz-Date
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Signature
|
string | |
X-Amz-SignedHeaders
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
DescribeEndpointsRequest
|
object |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
DescribeEndpointsResponse
|
object |
Properties
Endpoints
|
Endpoints |
List of endpoints. |
||||
|
||||||
Returns information about the specified global table.
This method only applies to Version 2017.11.29 of global tables.
Request
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-Target
|
string Allowed values: - DynamoDB_20120810.DescribeGlobalTable |
|
X-Amz-Content-Sha256
|
string | |
X-Amz-Date
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Signature
|
string | |
X-Amz-SignedHeaders
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
DescribeGlobalTableInput
|
object |
Properties
GlobalTableName
|
TableName |
The name of the global table. |
||||
|
||||||
Responses
Body
| Name | Data Type | Description |
|---|---|---|
DescribeGlobalTableOutput
|
object |
Properties
GlobalTableDescription
|
GlobalTableDescription |
Contains the details of the global table. |
|||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||
Body
| Name | Data Type | Description |
|---|---|---|
InternalServerError
|
Body
| Name | Data Type | Description |
|---|---|---|
GlobalTableNotFoundException
|
Describes Region-specific settings for a global table.
This method only applies to Version 2017.11.29 of global tables.
Request
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-Target
|
string Allowed values: - DynamoDB_20120810.DescribeGlobalTableSettings |
|
X-Amz-Content-Sha256
|
string | |
X-Amz-Date
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Signature
|
string | |
X-Amz-SignedHeaders
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
DescribeGlobalTableSettingsInput
|
object |
Properties
GlobalTableName
|
TableName |
The name of the global table to describe. |
||||
|
||||||
Responses
Body
| Name | Data Type | Description |
|---|---|---|
DescribeGlobalTableSettingsOutput
|
object |
Properties
GlobalTableName
|
TableName |
The name of the global table. |
||||
|
||||||
ReplicaSettings
|
ReplicaSettingsDescriptionList |
The Region-specific settings for the global table. |
||||
|
||||||
Body
| Name | Data Type | Description |
|---|---|---|
GlobalTableNotFoundException
|
Body
| Name | Data Type | Description |
|---|---|---|
InternalServerError
|
Returns the current provisioned-capacity limits for your AWS account in a Region, both for the Region as a whole and for any one DynamoDB table that you create there.
When you establish an AWS account, the account has initial limits on the maximum read capacity units and write capacity units that you can provision across all of your DynamoDB tables in a given Region. Also, there are per-table limits that apply when you create a table there. For more information, see Limits page in the Amazon DynamoDB Developer Guide.
Although you can increase these limits by filing a case at AWS Support Center, obtaining the increase is not instantaneous. The DescribeLimits action lets you write code to compare the capacity you are currently using to those limits imposed by your account so that you have enough time to apply for an increase before you hit a limit.
For example, you could use one of the AWS SDKs to do the following:
-
Call
DescribeLimitsfor a particular Region to obtain your current account limits on provisioned capacity there. -
Create a variable to hold the aggregate read capacity units provisioned for all your tables in that Region, and one to hold the aggregate write capacity units. Zero them both.
-
Call
ListTablesto obtain a list of all your DynamoDB tables. -
For each table name listed by
ListTables, do the following:-
Call
DescribeTablewith the table name. -
Use the data returned by
DescribeTableto add the read capacity units and write capacity units provisioned for the table itself to your variables. -
If the table has one or more global secondary indexes (GSIs), loop over these GSIs and add their provisioned capacity values to your variables as well.
-
-
Report the account limits for that Region returned by
DescribeLimits, along with the total current provisioned capacity levels you have calculated.
This will let you see whether you are getting close to your account-level limits.
The per-table limits apply only when you are creating a new table. They restrict the sum of the provisioned capacity of the new table itself and all its global secondary indexes.
For existing tables and their GSIs, DynamoDB doesn't let you increase provisioned capacity extremely rapidly. But the only upper limit that applies is that the aggregate provisioned capacity over all your tables and GSIs cannot exceed either of the per-account limits.
DescribeLimits should only be called periodically. You can expect throttling errors if you call it more than once in a minute.
The DescribeLimits Request element has no content.
Request
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-Target
|
string Allowed values: - DynamoDB_20120810.DescribeLimits |
|
X-Amz-Content-Sha256
|
string | |
X-Amz-Date
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Signature
|
string | |
X-Amz-SignedHeaders
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
DescribeLimitsInput
|
object |
Represents the input of a |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
DescribeLimitsOutput
|
object |
Represents the output of a |
Properties
AccountMaxReadCapacityUnits
|
PositiveLongObject |
The maximum total read capacity units that your account allows you to provision across all of your tables in this Region. |
||||
|
||||||
AccountMaxWriteCapacityUnits
|
PositiveLongObject |
The maximum total write capacity units that your account allows you to provision across all of your tables in this Region. |
||||
|
||||||
TableMaxReadCapacityUnits
|
PositiveLongObject |
The maximum read capacity units that your account allows you to provision for a new table that you are creating in this Region, including the read capacity units provisioned for its global secondary indexes (GSIs). |
||||
|
||||||
TableMaxWriteCapacityUnits
|
PositiveLongObject |
The maximum write capacity units that your account allows you to provision for a new table that you are creating in this Region, including the write capacity units provisioned for its global secondary indexes (GSIs). |
||||
|
||||||
Examples
{
"AccountMaxReadCapacityUnits": 20000,
"AccountMaxWriteCapacityUnits": 20000,
"TableMaxReadCapacityUnits": 10000,
"TableMaxWriteCapacityUnits": 10000
}Body
| Name | Data Type | Description |
|---|---|---|
InternalServerError
|
Returns information about the table, including the current status of the table, when it was created, the primary key schema, and any indexes on the table.
If you issue a DescribeTable request immediately after a CreateTable request, DynamoDB might return a ResourceNotFoundException. This is because DescribeTable uses an eventually consistent query, and the metadata for your table might not be available at that moment. Wait for a few seconds, and then try the DescribeTable request again.
Request
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-Target
|
string Allowed values: - DynamoDB_20120810.DescribeTable |
|
X-Amz-Content-Sha256
|
string | |
X-Amz-Date
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Signature
|
string | |
X-Amz-SignedHeaders
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
DescribeTableInput
|
object |
Represents the input of a |
Properties
TableName
|
TableName |
The name of the table to describe. |
||||
|
||||||
Responses
Body
| Name | Data Type | Description |
|---|---|---|
DescribeTableOutput
|
object |
Represents the output of a |
Properties
Table
|
TableDescription |
The properties of the table. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Examples
{
"Table": {
"AttributeDefinitions": [
{
"AttributeName": "Artist",
"AttributeType": "S"
},
{
"AttributeName": "SongTitle",
"AttributeType": "S"
}
],
"CreationDateTime": "1421866952.062",
"ItemCount": 0,
"KeySchema": [
{
"AttributeName": "Artist",
"KeyType": "HASH"
},
{
"AttributeName": "SongTitle",
"KeyType": "RANGE"
}
],
"ProvisionedThroughput": {
"NumberOfDecreasesToday": 1,
"ReadCapacityUnits": 5,
"WriteCapacityUnits": 5
},
"TableName": "Music",
"TableSizeBytes": 0,
"TableStatus": "ACTIVE"
}
}Body
| Name | Data Type | Description |
|---|---|---|
ResourceNotFoundException
|
Body
| Name | Data Type | Description |
|---|---|---|
InternalServerError
|
Describes auto scaling settings across replicas of the global table at once.
This method only applies to Version 2019.11.21 of global tables.
Request
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-Target
|
string Allowed values: - DynamoDB_20120810.DescribeTableReplicaAutoScaling |
|
X-Amz-Content-Sha256
|
string | |
X-Amz-Date
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Signature
|
string | |
X-Amz-SignedHeaders
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
DescribeTableReplicaAutoScalingInput
|
object |
Properties
TableName
|
TableName |
The name of the table. |
||||
|
||||||
Responses
Body
| Name | Data Type | Description |
|---|---|---|
DescribeTableReplicaAutoScalingOutput
|
object |
Properties
TableAutoScalingDescription
|
TableAutoScalingDescription |
Represents the auto scaling properties of the table. |
||||||||||||||||||||
Properties
|
||||||||||||||||||||||
Body
| Name | Data Type | Description |
|---|---|---|
ResourceNotFoundException
|
Body
| Name | Data Type | Description |
|---|---|---|
InternalServerError
|
Gives a description of the Time to Live (TTL) status on the specified table.
Request
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-Target
|
string Allowed values: - DynamoDB_20120810.DescribeTimeToLive |
|
X-Amz-Content-Sha256
|
string | |
X-Amz-Date
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Signature
|
string | |
X-Amz-SignedHeaders
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
DescribeTimeToLiveInput
|
object |
Properties
TableName
|
TableName |
The name of the table to be described. |
||||
|
||||||
Responses
Body
| Name | Data Type | Description |
|---|---|---|
DescribeTimeToLiveOutput
|
object |
Properties
TimeToLiveDescription
|
TimeToLiveDescription | |||||||||||
Properties
|
||||||||||||
Body
| Name | Data Type | Description |
|---|---|---|
ResourceNotFoundException
|
Body
| Name | Data Type | Description |
|---|---|---|
InternalServerError
|
The GetItem operation returns a set of attributes for the item with the given primary key. If there is no matching item, GetItem does not return any data and there will be no Item element in the response.
GetItem provides an eventually consistent read by default. If your application requires a strongly consistent read, set ConsistentRead to true. Although a strongly consistent read might take more time than an eventually consistent read, it always returns the last updated value.
Request
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-Target
|
string Allowed values: - DynamoDB_20120810.GetItem |
|
X-Amz-Content-Sha256
|
string | |
X-Amz-Date
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Signature
|
string | |
X-Amz-SignedHeaders
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
GetItemInput
|
object |
Represents the input of a |
Properties
TableName
|
TableName |
The name of the table containing the requested item. |
||||
|
||||||
Key
|
Key |
A map of attribute names to For the primary key, you must provide all of the attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key. |
||||
|
||||||
AttributesToGet
|
AttributeNameList |
This is a legacy parameter. Use |
||||
|
||||||
ConsistentRead
|
ConsistentRead |
Determines the read consistency model: If set to |
||||
|
||||||
ReturnConsumedCapacity
|
ReturnConsumedCapacity | |||||
|
||||||
ProjectionExpression
|
ProjectionExpression |
A string that identifies one or more attributes to retrieve from the table. These attributes can include scalars, sets, or elements of a JSON document. The attributes in the expression must be separated by commas. If no attribute names are specified, then all attributes are returned. If any of the requested attributes are not found, they do not appear in the result. For more information, see Specifying Item Attributes in the Amazon DynamoDB Developer Guide. |
||||
|
||||||
ExpressionAttributeNames
|
ExpressionAttributeNameMap |
One or more substitution tokens for attribute names in an expression. The following are some use cases for using
Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:
The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for
You could then use this substitution in an expression, as in this example:
Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime. For more information on expression attribute names, see Specifying Item Attributes in the Amazon DynamoDB Developer Guide. |
||||
|
||||||
Responses
Body
| Name | Data Type | Description |
|---|---|---|
GetItemOutput
|
object |
Represents the output of a |
Properties
Item
|
AttributeMap |
A map of attribute names to |
||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||
ConsumedCapacity
|
ConsumedCapacity |
The capacity units consumed by the |
||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||
Examples
{
"Item": {
"AlbumTitle": {
"S": "Songs About Life"
},
"Artist": {
"S": "Acme Band"
},
"SongTitle": {
"S": "Happy Day"
}
}
}Body
| Name | Data Type | Description |
|---|---|---|
ProvisionedThroughputExceededException
|
Body
| Name | Data Type | Description |
|---|---|---|
ResourceNotFoundException
|
Body
| Name | Data Type | Description |
|---|---|---|
RequestLimitExceeded
|
Body
| Name | Data Type | Description |
|---|---|---|
InternalServerError
|
List backups associated with an AWS account. To list backups for a given table, specify TableName. ListBackups returns a paginated list of results with at most 1 MB worth of items in a page. You can also specify a limit for the maximum number of entries to be returned in a page.
In the request, start time is inclusive, but end time is exclusive. Note that these limits are for the time at which the original backup was requested.
You can call ListBackups a maximum of five times per second.
Request
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-Target
|
string Allowed values: - DynamoDB_20120810.ListBackups |
|
X-Amz-Content-Sha256
|
string | |
X-Amz-Date
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Signature
|
string | |
X-Amz-SignedHeaders
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
ListBackupsInput
|
object |
Properties
TableName
|
TableName |
The backups from the table specified by |
||||
|
||||||
Limit
|
BackupsInputLimit |
Maximum number of backups to return at once. |
||||
|
||||||
TimeRangeLowerBound
|
TimeRangeLowerBound |
Only backups created after this time are listed. |
||||
|
||||||
TimeRangeUpperBound
|
TimeRangeUpperBound |
Only backups created before this time are listed. |
||||
|
||||||
ExclusiveStartBackupArn
|
BackupArn |
|
||||
|
||||||
BackupType
|
BackupTypeFilter |
The backups from the table specified by Where
|
||||
|
||||||
Responses
Body
| Name | Data Type | Description |
|---|---|---|
ListBackupsOutput
|
object |
Properties
BackupSummaries
|
BackupSummaries |
List of |
||||
|
||||||
LastEvaluatedBackupArn
|
BackupArn |
The ARN of the backup last evaluated when the current page of results was returned, inclusive of the current page of results. This value may be specified as the If If |
||||
|
||||||
Body
| Name | Data Type | Description |
|---|---|---|
InternalServerError
|
Returns a list of ContributorInsightsSummary for a table and all its global secondary indexes.
Request
Query
| Name | Data Type | Description |
|---|---|---|
MaxResults
|
string |
Pagination limit |
NextToken
|
string |
Pagination token |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-Target
|
string Allowed values: - DynamoDB_20120810.ListContributorInsights |
|
X-Amz-Content-Sha256
|
string | |
X-Amz-Date
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Signature
|
string | |
X-Amz-SignedHeaders
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
ListContributorInsightsInput
|
object |
Properties
TableName
|
TableName |
The name of the table. |
||||
|
||||||
NextToken
|
NextTokenString |
A token to for the desired page, if there is one. |
||||
|
||||||
MaxResults
|
ListContributorInsightsLimit |
Maximum number of results to return per page. |
||||
|
||||||
Responses
Body
| Name | Data Type | Description |
|---|---|---|
ListContributorInsightsOutput
|
object |
Properties
ContributorInsightsSummaries
|
ContributorInsightsSummaries |
A list of ContributorInsightsSummary. |
||||
|
||||||
NextToken
|
NextTokenString |
A token to go to the next page if there is one. |
||||
|
||||||
Body
| Name | Data Type | Description |
|---|---|---|
ResourceNotFoundException
|
Body
| Name | Data Type | Description |
|---|---|---|
InternalServerError
|
Lists all global tables that have a replica in the specified Region.
This method only applies to Version 2017.11.29 of global tables.
Request
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-Target
|
string Allowed values: - DynamoDB_20120810.ListGlobalTables |
|
X-Amz-Content-Sha256
|
string | |
X-Amz-Date
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Signature
|
string | |
X-Amz-SignedHeaders
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
ListGlobalTablesInput
|
object |
Properties
ExclusiveStartGlobalTableName
|
TableName |
The first global table name that this operation will evaluate. |
||||
|
||||||
Limit
|
PositiveIntegerObject |
The maximum number of table names to return. |
||||
|
||||||
RegionName
|
RegionName |
Lists the global tables in a specific Region. |
||||
|
||||||
Responses
Body
| Name | Data Type | Description |
|---|---|---|
ListGlobalTablesOutput
|
object |
Properties
GlobalTables
|
GlobalTableList |
List of global table names. |
||||
|
||||||
LastEvaluatedGlobalTableName
|
TableName |
Last evaluated global table name. |
||||
|
||||||
Body
| Name | Data Type | Description |
|---|---|---|
InternalServerError
|
Returns an array of table names associated with the current account and endpoint. The output from ListTables is paginated, with each page returning a maximum of 100 table names.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Limit
|
string |
Pagination limit |
ExclusiveStartTableName
|
string |
Pagination token |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-Target
|
string Allowed values: - DynamoDB_20120810.ListTables |
|
X-Amz-Content-Sha256
|
string | |
X-Amz-Date
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Signature
|
string | |
X-Amz-SignedHeaders
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
ListTablesInput
|
object |
Represents the input of a |
Properties
ExclusiveStartTableName
|
TableName |
The first table name that this operation will evaluate. Use the value that was returned for |
||||
|
||||||
Limit
|
ListTablesInputLimit |
A maximum number of table names to return. If this parameter is not specified, the limit is 100. |
||||
|
||||||
Responses
Body
| Name | Data Type | Description |
|---|---|---|
ListTablesOutput
|
object |
Represents the output of a |
Properties
TableNames
|
TableNameList |
The names of the tables associated with the current account at the current endpoint. The maximum size of this array is 100. If |
|||||||||||
|
|||||||||||||
LastEvaluatedTableName
|
TableName |
The name of the last table in the current page of results. Use this value as the If you do not receive a |
|||||||||||
|
|||||||||||||
Examples
{
"TableNames": [
"Forum",
"ProductCatalog",
"Reply",
"Thread"
]
}Body
| Name | Data Type | Description |
|---|---|---|
InternalServerError
|
List all tags on an Amazon DynamoDB resource. You can call ListTagsOfResource up to 10 times per second, per account.
For an overview on tagging DynamoDB resources, see Tagging for DynamoDB in the Amazon DynamoDB Developer Guide.
Request
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-Target
|
string Allowed values: - DynamoDB_20120810.ListTagsOfResource |
|
X-Amz-Content-Sha256
|
string | |
X-Amz-Date
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Signature
|
string | |
X-Amz-SignedHeaders
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
ListTagsOfResourceInput
|
object |
Properties
ResourceArn
|
ResourceArnString |
The Amazon DynamoDB resource with tags to be listed. This value is an Amazon Resource Name (ARN). |
||||
|
||||||
NextToken
|
NextTokenString |
An optional string that, if supplied, must be copied from the output of a previous call to ListTagOfResource. When provided in this manner, this API fetches the next page of results. |
||||
|
||||||
Responses
Body
| Name | Data Type | Description |
|---|---|---|
ListTagsOfResourceOutput
|
object |
Properties
Tags
|
TagList |
The tags currently associated with the Amazon DynamoDB resource. |
||||
|
||||||
NextToken
|
NextTokenString |
If this value is returned, there are additional results to be displayed. To retrieve them, call ListTagsOfResource again, with NextToken set to this value. |
||||
|
||||||
Body
| Name | Data Type | Description |
|---|---|---|
ResourceNotFoundException
|
Body
| Name | Data Type | Description |
|---|---|---|
InternalServerError
|
Creates a new item, or replaces an old item with a new item. If an item that has the same primary key as the new item already exists in the specified table, the new item completely replaces the existing item. You can perform a conditional put operation (add a new item if one with the specified primary key doesn't exist), or replace an existing item if it has certain attribute values. You can return the item's attribute values in the same operation, using the ReturnValues parameter.
This topic provides general information about the PutItem API.
For information on how to call the PutItem API using the AWS SDK in specific languages, see the following:
When you add an item, the primary key attributes are the only required attributes. Attribute values cannot be null. String and Binary type attributes must have lengths greater than zero. Set type attributes cannot be empty. Requests with empty values will be rejected with a ValidationException exception.
To prevent a new item from replacing an existing item, use a conditional expression that contains the attribute_not_exists function with the name of the attribute being used as the partition key for the table. Since every record must contain that attribute, the attribute_not_exists function will only succeed if no matching item exists.
For more information about PutItem, see Working with Items in the Amazon DynamoDB Developer Guide.
Request
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-Target
|
string Allowed values: - DynamoDB_20120810.PutItem |
|
X-Amz-Content-Sha256
|
string | |
X-Amz-Date
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Signature
|
string | |
X-Amz-SignedHeaders
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
PutItemInput
|
object |
Represents the input of a |
Properties
TableName
|
TableName |
The name of the table to contain the item. |
||||
|
||||||
Item
|
PutItemInputAttributeMap |
A map of attribute name/value pairs, one for each attribute. Only the primary key attributes are required; you can optionally provide other attribute name-value pairs for the item. You must provide all of the attributes for the primary key. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide both values for both the partition key and the sort key. If you specify any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition. For more information about primary keys, see Primary Key in the Amazon DynamoDB Developer Guide. Each element in the |
||||
|
||||||
Expected
|
ExpectedAttributeMap |
This is a legacy parameter. Use |
||||
|
||||||
ReturnValues
|
ReturnValue |
Use
The |
||||
|
||||||
ReturnConsumedCapacity
|
ReturnConsumedCapacity | |||||
|
||||||
ReturnItemCollectionMetrics
|
ReturnItemCollectionMetrics |
Determines whether item collection metrics are returned. If set to |
||||
|
||||||
ConditionalOperator
|
ConditionalOperator |
This is a legacy parameter. Use |
||||
|
||||||
ConditionExpression
|
ConditionExpression |
A condition that must be satisfied in order for a conditional An expression can contain any of the following:
For more information on condition expressions, see Condition Expressions in the Amazon DynamoDB Developer Guide. |
||||
|
||||||
ExpressionAttributeNames
|
ExpressionAttributeNameMap |
One or more substitution tokens for attribute names in an expression. The following are some use cases for using
Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:
The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for
You could then use this substitution in an expression, as in this example:
Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime. For more information on expression attribute names, see Specifying Item Attributes in the Amazon DynamoDB Developer Guide. |
||||
|
||||||
ExpressionAttributeValues
|
ExpressionAttributeValueMap |
One or more values that can be substituted in an expression. Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the ProductStatus attribute was one of the following: You would first need to specify You could then use these values in an expression, such as this: For more information on expression attribute values, see Condition Expressions in the Amazon DynamoDB Developer Guide. |
||||
|
||||||
Responses
Body
| Name | Data Type | Description |
|---|---|---|
PutItemOutput
|
object |
Represents the output of a |
Properties
Attributes
|
AttributeMap |
The attribute values as they appeared before the |
||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||
ConsumedCapacity
|
ConsumedCapacity |
The capacity units consumed by the |
||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||
ItemCollectionMetrics
|
ItemCollectionMetrics |
Information about item collections, if any, that were affected by the Each
|
||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||
Examples
{
"ConsumedCapacity": {
"CapacityUnits": 1,
"TableName": "Music"
}
}Body
| Name | Data Type | Description |
|---|---|---|
ConditionalCheckFailedException
|
Body
| Name | Data Type | Description |
|---|---|---|
ProvisionedThroughputExceededException
|
Body
| Name | Data Type | Description |
|---|---|---|
ResourceNotFoundException
|
Body
| Name | Data Type | Description |
|---|---|---|
ItemCollectionSizeLimitExceededException
|
Body
| Name | Data Type | Description |
|---|---|---|
TransactionConflictException
|
Body
| Name | Data Type | Description |
|---|---|---|
RequestLimitExceeded
|
Body
| Name | Data Type | Description |
|---|---|---|
InternalServerError
|
The Query operation finds items based on primary key values. You can query any table or secondary index that has a composite primary key (a partition key and a sort key).
Use the KeyConditionExpression parameter to provide a specific value for the partition key. The Query operation will return all of the items from the table or index with that partition key value. You can optionally narrow the scope of the Query operation by specifying a sort key value and a comparison operator in KeyConditionExpression. To further refine the Query results, you can optionally provide a FilterExpression. A FilterExpression determines which items within the results should be returned to you. All of the other results are discarded.
A Query operation always returns a result set. If no matching items are found, the result set will be empty. Queries that do not return results consume the minimum number of read capacity units for that type of read operation.
DynamoDB calculates the number of read capacity units consumed based on item size, not on the amount of data that is returned to an application. The number of capacity units consumed will be the same whether you request all of the attributes (the default behavior) or just some of them (using a projection expression). The number will also be the same whether or not you use a FilterExpression.
Query results are always sorted by the sort key value. If the data type of the sort key is Number, the results are returned in numeric order; otherwise, the results are returned in order of UTF-8 bytes. By default, the sort order is ascending. To reverse the order, set the ScanIndexForward parameter to false.
A single Query operation will read up to the maximum number of items set (if using the Limit parameter) or a maximum of 1 MB of data and then apply any filtering to the results using FilterExpression. If LastEvaluatedKey is present in the response, you will need to paginate the result set. For more information, see Paginating the Results in the Amazon DynamoDB Developer Guide.
FilterExpression is applied after a Query finishes, but before the results are returned. A FilterExpression cannot contain partition key or sort key attributes. You need to specify those attributes in the KeyConditionExpression.
A Query operation can return an empty result set and a LastEvaluatedKey if all the items read for the page of results are filtered out.
You can query a table, a local secondary index, or a global secondary index. For a query on a table or on a local secondary index, you can set the ConsistentRead parameter to true and obtain a strongly consistent result. Global secondary indexes support eventually consistent reads only, so do not specify ConsistentRead when querying a global secondary index.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Limit
|
string |
Pagination limit |
ExclusiveStartKey
|
string |
Pagination token |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-Target
|
string Allowed values: - DynamoDB_20120810.Query |
|
X-Amz-Content-Sha256
|
string | |
X-Amz-Date
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Signature
|
string | |
X-Amz-SignedHeaders
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
QueryInput
|
object |
Represents the input of a |
Properties
TableName
|
TableName |
The name of the table containing the requested items. |
||||
|
||||||
IndexName
|
IndexName |
The name of an index to query. This index can be any local secondary index or global secondary index on the table. Note that if you use the |
||||
|
||||||
Select
|
Select |
The attributes to be returned in the result. You can retrieve all item attributes, specific item attributes, the count of matching items, or in the case of an index, some or all of the attributes projected into the index.
If neither If you use the |
||||
|
||||||
AttributesToGet
|
AttributeNameList |
This is a legacy parameter. Use |
||||
|
||||||
Limit
|
PositiveIntegerObject |
The maximum number of items to evaluate (not necessarily the number of matching items). If DynamoDB processes the number of items up to the limit while processing the results, it stops the operation and returns the matching values up to that point, and a key in |
||||
|
||||||
ConsistentRead
|
ConsistentRead |
Determines the read consistency model: If set to Strongly consistent reads are not supported on global secondary indexes. If you query a global secondary index with |
||||
|
||||||
KeyConditions
|
KeyConditions |
This is a legacy parameter. Use |
||||
|
||||||
QueryFilter
|
FilterConditionMap |
This is a legacy parameter. Use |
||||
|
||||||
ConditionalOperator
|
ConditionalOperator |
This is a legacy parameter. Use |
||||
|
||||||
ScanIndexForward
|
BooleanObject |
Specifies the order for index traversal: If Items with the same partition key value are stored in sorted order by sort key. If the sort key data type is Number, the results are stored in numeric order. For type String, the results are stored in order of UTF-8 bytes. For type Binary, DynamoDB treats each byte of the binary data as unsigned. If |
||||
|
||||||
ExclusiveStartKey
|
Key |
The primary key of the first item that this operation will evaluate. Use the value that was returned for The data type for |
||||
|
||||||
ReturnConsumedCapacity
|
ReturnConsumedCapacity | |||||
|
||||||
ProjectionExpression
|
ProjectionExpression |
A string that identifies one or more attributes to retrieve from the table. These attributes can include scalars, sets, or elements of a JSON document. The attributes in the expression must be separated by commas. If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result. For more information, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide. |
||||
|
||||||
FilterExpression
|
ConditionExpression |
A string that contains conditions that DynamoDB applies after the A A For more information, see Filter Expressions in the Amazon DynamoDB Developer Guide. |
||||
|
||||||
KeyConditionExpression
|
KeyExpression |
The condition that specifies the key values for items to be retrieved by the The condition must perform an equality test on a single partition key value. The condition can optionally perform one of several comparison tests on a single sort key value. This allows The partition key equality test is required, and must be specified in the following format: If you also want to provide a condition for the sort key, it must be combined using Valid comparisons for the sort key condition are as follows:
Use the You can optionally use the
To work around this, define a placeholder (such a
For a list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide. For more information on |
||||
|
||||||
ExpressionAttributeNames
|
ExpressionAttributeNameMap |
One or more substitution tokens for attribute names in an expression. The following are some use cases for using
Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:
The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for
You could then use this substitution in an expression, as in this example:
Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime. For more information on expression attribute names, see Specifying Item Attributes in the Amazon DynamoDB Developer Guide. |
||||
|
||||||
ExpressionAttributeValues
|
ExpressionAttributeValueMap |
One or more values that can be substituted in an expression. Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the ProductStatus attribute was one of the following: You would first need to specify You could then use these values in an expression, such as this: For more information on expression attribute values, see Specifying Conditions in the Amazon DynamoDB Developer Guide. |
||||
|
||||||
Responses
Body
| Name | Data Type | Description |
|---|---|---|
QueryOutput
|
object |
Represents the output of a |
Properties
Items
|
ItemList |
An array of item attributes that match the query criteria. Each element in this array consists of an attribute name and the value for that attribute. |
||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||
Count
|
Integer |
The number of items in the response. If you used a If you did not use a filter in the request, then |
||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||
ScannedCount
|
Integer |
The number of items evaluated, before any If you did not use a filter in the request, then |
||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||
LastEvaluatedKey
|
Key |
The primary key of the item where the operation stopped, inclusive of the previous result set. Use this value to start a new operation, excluding this value in the new request. If If |
||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||
ConsumedCapacity
|
ConsumedCapacity |
The capacity units consumed by the |
||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||
Examples
{
"ConsumedCapacity": [],
"Count": 2,
"Items": [
{
"SongTitle": {
"S": "Call Me Today"
}
}
],
"ScannedCount": 2
}Body
| Name | Data Type | Description |
|---|---|---|
ProvisionedThroughputExceededException
|
Body
| Name | Data Type | Description |
|---|---|---|
ResourceNotFoundException
|
Body
| Name | Data Type | Description |
|---|---|---|
RequestLimitExceeded
|
Body
| Name | Data Type | Description |
|---|---|---|
InternalServerError
|
Creates a new table from an existing backup. Any number of users can execute up to 4 concurrent restores (any type of restore) in a given account.
You can call RestoreTableFromBackup at a maximum rate of 10 times per second.
You must manually set up the following on the restored table:
-
Auto scaling policies
-
IAM policies
-
Amazon CloudWatch metrics and alarms
-
Tags
-
Stream settings
-
Time to Live (TTL) settings
Request
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-Target
|
string Allowed values: - DynamoDB_20120810.RestoreTableFromBackup |
|
X-Amz-Content-Sha256
|
string | |
X-Amz-Date
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Signature
|
string | |
X-Amz-SignedHeaders
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
RestoreTableFromBackupInput
|
object |
Properties
TargetTableName
|
TableName |
The name of the new table to which the backup must be restored. |
||||||||||||||||||||||||
|
||||||||||||||||||||||||||
BackupArn
|
BackupArn |
The Amazon Resource Name (ARN) associated with the backup. |
||||||||||||||||||||||||
|
||||||||||||||||||||||||||
BillingModeOverride
|
BillingMode |
The billing mode of the restored table. |
||||||||||||||||||||||||
|
||||||||||||||||||||||||||
GlobalSecondaryIndexOverride
|
GlobalSecondaryIndexList |
List of global secondary indexes for the restored table. The indexes provided should match existing secondary indexes. You can choose to exclude some or all of the indexes at the time of restore. |
||||||||||||||||||||||||
|
||||||||||||||||||||||||||
LocalSecondaryIndexOverride
|
LocalSecondaryIndexList |
List of local secondary indexes for the restored table. The indexes provided should match existing secondary indexes. You can choose to exclude some or all of the indexes at the time of restore. |
||||||||||||||||||||||||
|
||||||||||||||||||||||||||
ProvisionedThroughputOverride
|
ProvisionedThroughput |
Provisioned throughput settings for the restored table. |
||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||
Responses
Body
| Name | Data Type | Description |
|---|---|---|
RestoreTableFromBackupOutput
|
object |
Properties
TableDescription
|
TableDescription |
The description of the table created from an existing backup. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body
| Name | Data Type | Description |
|---|---|---|
TableAlreadyExistsException
|
Body
| Name | Data Type | Description |
|---|---|---|
TableInUseException
|
Body
| Name | Data Type | Description |
|---|---|---|
BackupNotFoundException
|
Body
| Name | Data Type | Description |
|---|---|---|
BackupInUseException
|
Body
| Name | Data Type | Description |
|---|---|---|
LimitExceededException
|
Body
| Name | Data Type | Description |
|---|---|---|
InternalServerError
|
Restores the specified table to the specified point in time within EarliestRestorableDateTime and LatestRestorableDateTime. You can restore your table to any point in time during the last 35 days. Any number of users can execute up to 4 concurrent restores (any type of restore) in a given account.
When you restore using point in time recovery, DynamoDB restores your table data to the state based on the selected date and time (day:hour:minute:second) to a new table.
Along with data, the following are also included on the new restored table using point in time recovery:
-
Global secondary indexes (GSIs)
-
Local secondary indexes (LSIs)
-
Provisioned read and write capacity
-
Encryption settings
All these settings come from the current settings of the source table at the time of restore.
You must manually set up the following on the restored table:
-
Auto scaling policies
-
IAM policies
-
Amazon CloudWatch metrics and alarms
-
Tags
-
Stream settings
-
Time to Live (TTL) settings
-
Point in time recovery settings
Request
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-Target
|
string Allowed values: - DynamoDB_20120810.RestoreTableToPointInTime |
|
X-Amz-Content-Sha256
|
string | |
X-Amz-Date
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Signature
|
string | |
X-Amz-SignedHeaders
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
RestoreTableToPointInTimeInput
|
object |
Properties
SourceTableName
|
TableName |
Name of the source table that is being restored. |
||||||||||||||||||||||||
|
||||||||||||||||||||||||||
TargetTableName
|
TableName |
The name of the new table to which it must be restored to. |
||||||||||||||||||||||||
|
||||||||||||||||||||||||||
UseLatestRestorableTime
|
BooleanObject |
Restore the table to the latest possible time. |
||||||||||||||||||||||||
|
||||||||||||||||||||||||||
RestoreDateTime
|
Date |
Time in the past to restore the table to. |
||||||||||||||||||||||||
|
||||||||||||||||||||||||||
BillingModeOverride
|
BillingMode |
The billing mode of the restored table. |
||||||||||||||||||||||||
|
||||||||||||||||||||||||||
GlobalSecondaryIndexOverride
|
GlobalSecondaryIndexList |
List of global secondary indexes for the restored table. The indexes provided should match existing secondary indexes. You can choose to exclude some or all of the indexes at the time of restore. |
||||||||||||||||||||||||
|
||||||||||||||||||||||||||
LocalSecondaryIndexOverride
|
LocalSecondaryIndexList |
List of local secondary indexes for the restored table. The indexes provided should match existing secondary indexes. You can choose to exclude some or all of the indexes at the time of restore. |
||||||||||||||||||||||||
|
||||||||||||||||||||||||||
ProvisionedThroughputOverride
|
ProvisionedThroughput |
Provisioned throughput settings for the restored table. |
||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||
Responses
Body
| Name | Data Type | Description |
|---|---|---|
RestoreTableToPointInTimeOutput
|
object |
Properties
TableDescription
|
TableDescription |
Represents the properties of a table. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body
| Name | Data Type | Description |
|---|---|---|
TableAlreadyExistsException
|
Body
| Name | Data Type | Description |
|---|---|---|
TableNotFoundException
|
Body
| Name | Data Type | Description |
|---|---|---|
TableInUseException
|
Body
| Name | Data Type | Description |
|---|---|---|
LimitExceededException
|
Body
| Name | Data Type | Description |
|---|---|---|
InvalidRestoreTimeException
|
Body
| Name | Data Type | Description |
|---|---|---|
PointInTimeRecoveryUnavailableException
|
Body
| Name | Data Type | Description |
|---|---|---|
InternalServerError
|
The Scan operation returns one or more items and item attributes by accessing every item in a table or a secondary index. To have DynamoDB return fewer items, you can provide a FilterExpression operation.
If the total number of scanned items exceeds the maximum dataset size limit of 1 MB, the scan stops and results are returned to the user as a LastEvaluatedKey value to continue the scan in a subsequent operation. The results also include the number of items exceeding the limit. A scan can result in no table data meeting the filter criteria.
A single Scan operation reads up to the maximum number of items set (if using the Limit parameter) or a maximum of 1 MB of data and then apply any filtering to the results using FilterExpression. If LastEvaluatedKey is present in the response, you need to paginate the result set. For more information, see Paginating the Results in the Amazon DynamoDB Developer Guide.
Scan operations proceed sequentially; however, for faster performance on a large table or secondary index, applications can request a parallel Scan operation by providing the Segment and TotalSegments parameters. For more information, see Parallel Scan in the Amazon DynamoDB Developer Guide.
Scan uses eventually consistent reads when accessing the data in a table; therefore, the result set might not include the changes to data in the table immediately before the operation began. If you need a consistent copy of the data, as of the time that the Scan begins, you can set the ConsistentRead parameter to true.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Limit
|
string |
Pagination limit |
ExclusiveStartKey
|
string |
Pagination token |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-Target
|
string Allowed values: - DynamoDB_20120810.Scan |
|
X-Amz-Content-Sha256
|
string | |
X-Amz-Date
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Signature
|
string | |
X-Amz-SignedHeaders
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
ScanInput
|
object |
Represents the input of a |
Properties
TableName
|
TableName |
The name of the table containing the requested items; or, if you provide |
||||
|
||||||
IndexName
|
IndexName |
The name of a secondary index to scan. This index can be any local secondary index or global secondary index. Note that if you use the |
||||
|
||||||
AttributesToGet
|
AttributeNameList |
This is a legacy parameter. Use |
||||
|
||||||
Limit
|
PositiveIntegerObject |
The maximum number of items to evaluate (not necessarily the number of matching items). If DynamoDB processes the number of items up to the limit while processing the results, it stops the operation and returns the matching values up to that point, and a key in |
||||
|
||||||
Select
|
Select |
The attributes to be returned in the result. You can retrieve all item attributes, specific item attributes, the count of matching items, or in the case of an index, some or all of the attributes projected into the index.
| ||||