# Actions
The following actions are supported by Amazon DynamoDB:
+ [BatchExecuteStatement](API_BatchExecuteStatement.md)
+ [BatchGetItem](API_BatchGetItem.md)
+ [BatchWriteItem](API_BatchWriteItem.md)
+ [CreateBackup](API_CreateBackup.md)
+ [CreateGlobalTable](API_CreateGlobalTable.md)
+ [CreateTable](API_CreateTable.md)
+ [DeleteBackup](API_DeleteBackup.md)
+ [DeleteItem](API_DeleteItem.md)
+ [DeleteResourcePolicy](API_DeleteResourcePolicy.md)
+ [DeleteTable](API_DeleteTable.md)
+ [DescribeBackup](API_DescribeBackup.md)
+ [DescribeContinuousBackups](API_DescribeContinuousBackups.md)
+ [DescribeContributorInsights](API_DescribeContributorInsights.md)
+ [DescribeEndpoints](API_DescribeEndpoints.md)
+ [DescribeExport](API_DescribeExport.md)
+ [DescribeGlobalTable](API_DescribeGlobalTable.md)
+ [DescribeGlobalTableSettings](API_DescribeGlobalTableSettings.md)
+ [DescribeImport](API_DescribeImport.md)
+ [DescribeKinesisStreamingDestination](API_DescribeKinesisStreamingDestination.md)
+ [DescribeLimits](API_DescribeLimits.md)
+ [DescribeTable](API_DescribeTable.md)
+ [DescribeTableReplicaAutoScaling](API_DescribeTableReplicaAutoScaling.md)
+ [DescribeTimeToLive](API_DescribeTimeToLive.md)
+ [DisableKinesisStreamingDestination](API_DisableKinesisStreamingDestination.md)
+ [EnableKinesisStreamingDestination](API_EnableKinesisStreamingDestination.md)
+ [ExecuteStatement](API_ExecuteStatement.md)
+ [ExecuteTransaction](API_ExecuteTransaction.md)
+ [ExportTableToPointInTime](API_ExportTableToPointInTime.md)
+ [GetItem](API_GetItem.md)
+ [GetResourcePolicy](API_GetResourcePolicy.md)
+ [ImportTable](API_ImportTable.md)
+ [ListBackups](API_ListBackups.md)
+ [ListContributorInsights](API_ListContributorInsights.md)
+ [ListExports](API_ListExports.md)
+ [ListGlobalTables](API_ListGlobalTables.md)
+ [ListImports](API_ListImports.md)
+ [ListTables](API_ListTables.md)
+ [ListTagsOfResource](API_ListTagsOfResource.md)
+ [PutItem](API_PutItem.md)
+ [PutResourcePolicy](API_PutResourcePolicy.md)
+ [Query](API_Query.md)
+ [RestoreTableFromBackup](API_RestoreTableFromBackup.md)
+ [RestoreTableToPointInTime](API_RestoreTableToPointInTime.md)
+ [Scan](API_Scan.md)
+ [TagResource](API_TagResource.md)
+ [TransactGetItems](API_TransactGetItems.md)
+ [TransactWriteItems](API_TransactWriteItems.md)
+ [UntagResource](API_UntagResource.md)
+ [UpdateContinuousBackups](API_UpdateContinuousBackups.md)
+ [UpdateContributorInsights](API_UpdateContributorInsights.md)
+ [UpdateGlobalTable](API_UpdateGlobalTable.md)
+ [UpdateGlobalTableSettings](API_UpdateGlobalTableSettings.md)
+ [UpdateItem](API_UpdateItem.md)
+ [UpdateKinesisStreamingDestination](API_UpdateKinesisStreamingDestination.md)
+ [UpdateTable](API_UpdateTable.md)
+ [UpdateTableReplicaAutoScaling](API_UpdateTableReplicaAutoScaling.md)
+ [UpdateTimeToLive](API_UpdateTimeToLive.md)
The following actions are supported by DynamoDB Accelerator:
+ [CreateCluster](API_dax_CreateCluster.md)
+ [CreateParameterGroup](API_dax_CreateParameterGroup.md)
+ [CreateSubnetGroup](API_dax_CreateSubnetGroup.md)
+ [DecreaseReplicationFactor](API_dax_DecreaseReplicationFactor.md)
+ [DeleteCluster](API_dax_DeleteCluster.md)
+ [DeleteParameterGroup](API_dax_DeleteParameterGroup.md)
+ [DeleteSubnetGroup](API_dax_DeleteSubnetGroup.md)
+ [DescribeClusters](API_dax_DescribeClusters.md)
+ [DescribeDefaultParameters](API_dax_DescribeDefaultParameters.md)
+ [DescribeEvents](API_dax_DescribeEvents.md)
+ [DescribeParameterGroups](API_dax_DescribeParameterGroups.md)
+ [DescribeParameters](API_dax_DescribeParameters.md)
+ [DescribeSubnetGroups](API_dax_DescribeSubnetGroups.md)
+ [IncreaseReplicationFactor](API_dax_IncreaseReplicationFactor.md)
+ [ListTags](API_dax_ListTags.md)
+ [RebootNode](API_dax_RebootNode.md)
+ [TagResource](API_dax_TagResource.md)
+ [UntagResource](API_dax_UntagResource.md)
+ [UpdateCluster](API_dax_UpdateCluster.md)
+ [UpdateParameterGroup](API_dax_UpdateParameterGroup.md)
+ [UpdateSubnetGroup](API_dax_UpdateSubnetGroup.md)
The following actions are supported by Amazon DynamoDB Streams:
+ [DescribeStream](API_streams_DescribeStream.md)
+ [GetRecords](API_streams_GetRecords.md)
+ [GetShardIterator](API_streams_GetShardIterator.md)
+ [ListStreams](API_streams_ListStreams.md)
# Amazon DynamoDB
The following actions are supported by Amazon DynamoDB:
+ [BatchExecuteStatement](API_BatchExecuteStatement.md)
+ [BatchGetItem](API_BatchGetItem.md)
+ [BatchWriteItem](API_BatchWriteItem.md)
+ [CreateBackup](API_CreateBackup.md)
+ [CreateGlobalTable](API_CreateGlobalTable.md)
+ [CreateTable](API_CreateTable.md)
+ [DeleteBackup](API_DeleteBackup.md)
+ [DeleteItem](API_DeleteItem.md)
+ [DeleteResourcePolicy](API_DeleteResourcePolicy.md)
+ [DeleteTable](API_DeleteTable.md)
+ [DescribeBackup](API_DescribeBackup.md)
+ [DescribeContinuousBackups](API_DescribeContinuousBackups.md)
+ [DescribeContributorInsights](API_DescribeContributorInsights.md)
+ [DescribeEndpoints](API_DescribeEndpoints.md)
+ [DescribeExport](API_DescribeExport.md)
+ [DescribeGlobalTable](API_DescribeGlobalTable.md)
+ [DescribeGlobalTableSettings](API_DescribeGlobalTableSettings.md)
+ [DescribeImport](API_DescribeImport.md)
+ [DescribeKinesisStreamingDestination](API_DescribeKinesisStreamingDestination.md)
+ [DescribeLimits](API_DescribeLimits.md)
+ [DescribeTable](API_DescribeTable.md)
+ [DescribeTableReplicaAutoScaling](API_DescribeTableReplicaAutoScaling.md)
+ [DescribeTimeToLive](API_DescribeTimeToLive.md)
+ [DisableKinesisStreamingDestination](API_DisableKinesisStreamingDestination.md)
+ [EnableKinesisStreamingDestination](API_EnableKinesisStreamingDestination.md)
+ [ExecuteStatement](API_ExecuteStatement.md)
+ [ExecuteTransaction](API_ExecuteTransaction.md)
+ [ExportTableToPointInTime](API_ExportTableToPointInTime.md)
+ [GetItem](API_GetItem.md)
+ [GetResourcePolicy](API_GetResourcePolicy.md)
+ [ImportTable](API_ImportTable.md)
+ [ListBackups](API_ListBackups.md)
+ [ListContributorInsights](API_ListContributorInsights.md)
+ [ListExports](API_ListExports.md)
+ [ListGlobalTables](API_ListGlobalTables.md)
+ [ListImports](API_ListImports.md)
+ [ListTables](API_ListTables.md)
+ [ListTagsOfResource](API_ListTagsOfResource.md)
+ [PutItem](API_PutItem.md)
+ [PutResourcePolicy](API_PutResourcePolicy.md)
+ [Query](API_Query.md)
+ [RestoreTableFromBackup](API_RestoreTableFromBackup.md)
+ [RestoreTableToPointInTime](API_RestoreTableToPointInTime.md)
+ [Scan](API_Scan.md)
+ [TagResource](API_TagResource.md)
+ [TransactGetItems](API_TransactGetItems.md)
+ [TransactWriteItems](API_TransactWriteItems.md)
+ [UntagResource](API_UntagResource.md)
+ [UpdateContinuousBackups](API_UpdateContinuousBackups.md)
+ [UpdateContributorInsights](API_UpdateContributorInsights.md)
+ [UpdateGlobalTable](API_UpdateGlobalTable.md)
+ [UpdateGlobalTableSettings](API_UpdateGlobalTableSettings.md)
+ [UpdateItem](API_UpdateItem.md)
+ [UpdateKinesisStreamingDestination](API_UpdateKinesisStreamingDestination.md)
+ [UpdateTable](API_UpdateTable.md)
+ [UpdateTableReplicaAutoScaling](API_UpdateTableReplicaAutoScaling.md)
+ [UpdateTimeToLive](API_UpdateTimeToLive.md)
# BatchExecuteStatement
This operation allows you to perform batch reads or writes on data stored in DynamoDB, using PartiQL. Each read statement in a `BatchExecuteStatement` must specify an equality condition on all key attributes. This enforces that each `SELECT` statement in a batch returns at most a single item. For more information, see [Running batch operations with PartiQL for DynamoDB ](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ql-reference.multiplestatements.batching.html).
**Note**
The entire batch must consist of either read statements or write statements, you cannot mix both in one batch.
**Important**
A HTTP 200 response does not mean that all statements in the BatchExecuteStatement succeeded. Error details for individual statements can be found under the [Error](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_BatchStatementResponse.html#DDB-Type-BatchStatementResponse-Error) field of the `BatchStatementResponse` for each statement.
## Request Syntax
```
{
"ReturnConsumedCapacity": "string",
"Statements": [
{
"ConsistentRead": boolean,
"Parameters": [
{
"B": blob,
"BOOL": boolean,
"BS": [ blob ],
"L": [
"AttributeValue"
],
"M": {
"string" : "AttributeValue"
},
"N": "string",
"NS": [ "string" ],
"NULL": boolean,
"S": "string",
"SS": [ "string" ]
}
],
"ReturnValuesOnConditionCheckFailure": "string",
"Statement": "string"
}
]
}
```
## Request Parameters
The request accepts the following data in JSON format.
**Note**
In the following list, the required parameters are described first.
** [Statements](#API_BatchExecuteStatement_RequestSyntax) **
The list of PartiQL statements representing the batch to run.
Type: Array of [BatchStatementRequest](API_BatchStatementRequest.md) objects
Array Members: Minimum number of 1 item. Maximum number of 25 items.
Required: Yes
** [ReturnConsumedCapacity](#API_BatchExecuteStatement_RequestSyntax) **
Determines the level of detail about either provisioned or on-demand throughput consumption that is returned in the response:
+ `INDEXES` - The response includes the aggregate `ConsumedCapacity` for the operation, together with `ConsumedCapacity` for each table and secondary index that was accessed.
Note that some operations, such as `GetItem` and `BatchGetItem`, do not access any indexes at all. In these cases, specifying `INDEXES` will only return `ConsumedCapacity` information for table(s).
+ `TOTAL` - The response includes only the aggregate `ConsumedCapacity` for the operation.
+ `NONE` - No `ConsumedCapacity` details are included in the response.
Type: String
Valid Values: `INDEXES | TOTAL | NONE`
Required: No
## Response Syntax
```
{
"ConsumedCapacity": [
{
"CapacityUnits": number,
"GlobalSecondaryIndexes": {
"string" : {
"CapacityUnits": number,
"ReadCapacityUnits": number,
"WriteCapacityUnits": number
}
},
"LocalSecondaryIndexes": {
"string" : {
"CapacityUnits": number,
"ReadCapacityUnits": number,
"WriteCapacityUnits": number
}
},
"ReadCapacityUnits": number,
"Table": {
"CapacityUnits": number,
"ReadCapacityUnits": number,
"WriteCapacityUnits": number
},
"TableName": "string",
"WriteCapacityUnits": number
}
],
"Responses": [
{
"Error": {
"Code": "string",
"Item": {
"string" : {
"B": blob,
"BOOL": boolean,
"BS": [ blob ],
"L": [
"AttributeValue"
],
"M": {
"string" : "AttributeValue"
},
"N": "string",
"NS": [ "string" ],
"NULL": boolean,
"S": "string",
"SS": [ "string" ]
}
},
"Message": "string"
},
"Item": {
"string" : {
"B": blob,
"BOOL": boolean,
"BS": [ blob ],
"L": [
"AttributeValue"
],
"M": {
"string" : "AttributeValue"
},
"N": "string",
"NS": [ "string" ],
"NULL": boolean,
"S": "string",
"SS": [ "string" ]
}
},
"TableName": "string"
}
]
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [ConsumedCapacity](#API_BatchExecuteStatement_ResponseSyntax) **
The capacity units consumed by the entire operation. The values of the list are ordered according to the ordering of the statements.
Type: Array of [ConsumedCapacity](API_ConsumedCapacity.md) objects
** [Responses](#API_BatchExecuteStatement_ResponseSyntax) **
The response to each PartiQL statement in the batch. The values of the list are ordered according to the ordering of the request statements.
Type: Array of [BatchStatementResponse](API_BatchStatementResponse.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalServerError **
An error occurred on the server side.
** message **
The server encountered an internal error trying to fulfill the request.
HTTP Status Code: 500
** RequestLimitExceeded **
Throughput exceeds the current throughput quota for your account. For detailed information about why the request was throttled and the ARN of the impacted resource, find the [ThrottlingReason](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_ThrottlingReason.html) field in the returned exception. Contact [Support](https://aws.amazon.com/support) to request a quota increase.
** ThrottlingReasons **
A list of [ThrottlingReason](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_ThrottlingReason.html) that provide detailed diagnostic information about why the request was throttled.
HTTP Status Code: 400
** ThrottlingException **
The request was denied due to request throttling. For detailed information about why the request was throttled and the ARN of the impacted resource, find the [ThrottlingReason](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_ThrottlingReason.html) field in the returned exception.
** throttlingReasons **
A list of [ThrottlingReason](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_ThrottlingReason.html) that provide detailed diagnostic information about why the request was throttled.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/dynamodb-2012-08-10/BatchExecuteStatement)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/dynamodb-2012-08-10/BatchExecuteStatement)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/BatchExecuteStatement)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/dynamodb-2012-08-10/BatchExecuteStatement)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/BatchExecuteStatement)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/dynamodb-2012-08-10/BatchExecuteStatement)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/dynamodb-2012-08-10/BatchExecuteStatement)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/dynamodb-2012-08-10/BatchExecuteStatement)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/dynamodb-2012-08-10/BatchExecuteStatement)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/BatchExecuteStatement)
# BatchGetItem
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, more than 1MB per partition is requested, 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.
**Important**
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`.
**Important**
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](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#BatchOperations) 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` may retrieve 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](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#CapacityUnitCalculations) in the *Amazon DynamoDB Developer Guide*.
**Note**
`BatchGetItem` will result in a `ValidationException` if the same key is specified multiple times.
## Request Syntax
```
{
"RequestItems": {
"string" : {
"AttributesToGet": [ "string" ],
"ConsistentRead": boolean,
"ExpressionAttributeNames": {
"string" : "string"
},
"Keys": [
{
"string" : {
"B": blob,
"BOOL": boolean,
"BS": [ blob ],
"L": [
"AttributeValue"
],
"M": {
"string" : "AttributeValue"
},
"N": "string",
"NS": [ "string" ],
"NULL": boolean,
"S": "string",
"SS": [ "string" ]
}
}
],
"ProjectionExpression": "string"
}
},
"ReturnConsumedCapacity": "string"
}
```
## Request Parameters
The request accepts the following data in JSON format.
**Note**
In the following list, the required parameters are described first.
** [RequestItems](#API_BatchGetItem_RequestSyntax) **
A map of one or more table names or table ARNs and, for each table, a map that describes one or more items to retrieve from that table. Each table name or ARN can be used only once per `BatchGetItem` request.
Each element in the map of items to retrieve consists of the following:
+ `ConsistentRead` - If `true`, a strongly consistent read is used; if `false` (the default), an eventually consistent read is used.
+ `ExpressionAttributeNames` - One or more substitution tokens for attribute names in the `ProjectionExpression` parameter. The following are some use cases for using `ExpressionAttributeNames`:
+ To access an attribute whose name conflicts with a DynamoDB reserved word.
+ To create a placeholder for repeating occurrences of an attribute name in an expression.
+ To prevent special characters in an attribute name from being misinterpreted in an expression.
Use the **\$1** character in an expression to dereference an attribute name. For example, consider the following attribute name:
+ `Percentile`
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](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ReservedWords.html) in the *Amazon DynamoDB Developer Guide*). To work around this, you could specify the following for `ExpressionAttributeNames`:
+ `{"#P":"Percentile"}`
You could then use this substitution in an expression, as in this example:
+ `#P = :val`
**Note**
Tokens that begin with the **:** character are *expression attribute values*, which are placeholders for the actual value at runtime.
For more information about expression attribute names, see [Accessing Item Attributes](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html) in the *Amazon DynamoDB Developer Guide*.
+ `Keys` - An array of primary key attribute values that define specific items in the table. For each primary key, you must provide *all* of the key attributes. For example, with a simple primary key, you only need to provide the partition key value. For a composite key, you must provide *both* the partition key value and the sort key value.
+ `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 [Accessing Item Attributes](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html) in the *Amazon DynamoDB Developer Guide*.
+ `AttributesToGet` - This is a legacy parameter. Use `ProjectionExpression` instead. For more information, see [AttributesToGet](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.AttributesToGet.html) in the *Amazon DynamoDB Developer Guide*.
Type: String to [KeysAndAttributes](API_KeysAndAttributes.md) object map
Map Entries: Maximum number of 100 items.
Key Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: Yes
** [ReturnConsumedCapacity](#API_BatchGetItem_RequestSyntax) **
Determines the level of detail about either provisioned or on-demand throughput consumption that is returned in the response:
+ `INDEXES` - The response includes the aggregate `ConsumedCapacity` for the operation, together with `ConsumedCapacity` for each table and secondary index that was accessed.
Note that some operations, such as `GetItem` and `BatchGetItem`, do not access any indexes at all. In these cases, specifying `INDEXES` will only return `ConsumedCapacity` information for table(s).
+ `TOTAL` - The response includes only the aggregate `ConsumedCapacity` for the operation.
+ `NONE` - No `ConsumedCapacity` details are included in the response.
Type: String
Valid Values: `INDEXES | TOTAL | NONE`
Required: No
## Response Syntax
```
{
"ConsumedCapacity": [
{
"CapacityUnits": number,
"GlobalSecondaryIndexes": {
"string" : {
"CapacityUnits": number,
"ReadCapacityUnits": number,
"WriteCapacityUnits": number
}
},
"LocalSecondaryIndexes": {
"string" : {
"CapacityUnits": number,
"ReadCapacityUnits": number,
"WriteCapacityUnits": number
}
},
"ReadCapacityUnits": number,
"Table": {
"CapacityUnits": number,
"ReadCapacityUnits": number,
"WriteCapacityUnits": number
},
"TableName": "string",
"WriteCapacityUnits": number
}
],
"Responses": {
"string" : [
{
"string" : {
"B": blob,
"BOOL": boolean,
"BS": [ blob ],
"L": [
"AttributeValue"
],
"M": {
"string" : "AttributeValue"
},
"N": "string",
"NS": [ "string" ],
"NULL": boolean,
"S": "string",
"SS": [ "string" ]
}
}
]
},
"UnprocessedKeys": {
"string" : {
"AttributesToGet": [ "string" ],
"ConsistentRead": boolean,
"ExpressionAttributeNames": {
"string" : "string"
},
"Keys": [
{
"string" : {
"B": blob,
"BOOL": boolean,
"BS": [ blob ],
"L": [
"AttributeValue"
],
"M": {
"string" : "AttributeValue"
},
"N": "string",
"NS": [ "string" ],
"NULL": boolean,
"S": "string",
"SS": [ "string" ]
}
}
],
"ProjectionExpression": "string"
}
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [ConsumedCapacity](#API_BatchGetItem_ResponseSyntax) **
The read capacity units consumed by the entire `BatchGetItem` operation.
Each element consists of:
+ `TableName` - The table that consumed the provisioned throughput.
+ `CapacityUnits` - The total number of capacity units consumed.
Type: Array of [ConsumedCapacity](API_ConsumedCapacity.md) objects
** [Responses](#API_BatchGetItem_ResponseSyntax) **
A map of table name or table ARN to a list of items. Each object in `Responses` consists of a table name or ARN, along with a map of attribute data consisting of the data type and attribute value.
Type: String to array of string to [AttributeValue](API_AttributeValue.md) object maps map
Key Length Constraints: Minimum length of 1. Maximum length of 1024.
Key Length Constraints: Maximum length of 65535.
** [UnprocessedKeys](#API_BatchGetItem_ResponseSyntax) **
A map of tables and their respective keys that were not processed with the current response. The `UnprocessedKeys` value is in the same form as `RequestItems`, so the value can be provided directly to a subsequent `BatchGetItem` operation. For more information, see `RequestItems` in the Request Parameters section.
Each element consists of:
+ `Keys` - An array of primary key attribute values that define specific items in the table.
+ `ProjectionExpression` - One or more attributes to be retrieved from the table or index. By default, all attributes are returned. If a requested attribute is not found, it does not appear in the result.
+ `ConsistentRead` - The consistency of a read operation. If set to `true`, then a strongly consistent read is used; otherwise, an eventually consistent read is used.
If there are no unprocessed keys remaining, the response contains an empty `UnprocessedKeys` map.
Type: String to [KeysAndAttributes](API_KeysAndAttributes.md) object map
Map Entries: Maximum number of 100 items.
Key Length Constraints: Minimum length of 1. Maximum length of 1024.
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalServerError **
An error occurred on the server side.
** message **
The server encountered an internal error trying to fulfill the request.
HTTP Status Code: 500
** ProvisionedThroughputExceededException **
The request was denied due to request throttling. For detailed information about why the request was throttled and the ARN of the impacted resource, find the [ThrottlingReason](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_ThrottlingReason.html) field in the returned exception. The AWS SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to [Error Retries and Exponential Backoff](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Programming.Errors.html#Programming.Errors.RetryAndBackoff) in the *Amazon DynamoDB Developer Guide*.
** message **
You exceeded your maximum allowed provisioned throughput.
** ThrottlingReasons **
A list of [ThrottlingReason](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_ThrottlingReason.html) that provide detailed diagnostic information about why the request was throttled.
HTTP Status Code: 400
** RequestLimitExceeded **
Throughput exceeds the current throughput quota for your account. For detailed information about why the request was throttled and the ARN of the impacted resource, find the [ThrottlingReason](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_ThrottlingReason.html) field in the returned exception. Contact [Support](https://aws.amazon.com/support) to request a quota increase.
** ThrottlingReasons **
A list of [ThrottlingReason](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_ThrottlingReason.html) that provide detailed diagnostic information about why the request was throttled.
HTTP Status Code: 400
** ResourceNotFoundException **
The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be `ACTIVE`.
** message **
The resource which is being requested does not exist.
HTTP Status Code: 400
** ThrottlingException **
The request was denied due to request throttling. For detailed information about why the request was throttled and the ARN of the impacted resource, find the [ThrottlingReason](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_ThrottlingReason.html) field in the returned exception.
** throttlingReasons **
A list of [ThrottlingReason](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_ThrottlingReason.html) that provide detailed diagnostic information about why the request was throttled.
HTTP Status Code: 400
## Examples
### Retrieve Items from Multiple Tables
The following example requests attributes from two different tables.
#### Sample Request
```
POST / HTTP/1.1
Host: dynamodb..;
Accept-Encoding: identity
Content-Length:
User-Agent:
Content-Type: application/x-amz-json-1.0
Authorization: AWS4-HMAC-SHA256 Credential=, SignedHeaders=, Signature=
X-Amz-Date:
X-Amz-Target: DynamoDB_20120810.BatchGetItem
{
"RequestItems": {
"Forum": {
"Keys": [
{
"Name":{"S":"Amazon DynamoDB"}
},
{
"Name":{"S":"Amazon RDS"}
},
{
"Name":{"S":"Amazon Redshift"}
}
],
"ProjectionExpression":"Name, Threads, Messages, Views"
},
"Thread": {
"Keys": [
{
"ForumName":{"S":"Amazon DynamoDB"},
"Subject":{"S":"Concurrent reads"}
}
],
"ProjectionExpression":"Tags, Message"
}
},
"ReturnConsumedCapacity": "TOTAL"
}
```
#### Sample Response
```
HTTP/1.1 200 OK
x-amzn-RequestId:
x-amz-crc32:
Content-Type: application/x-amz-json-1.0
Content-Length:
Date:
{
"Responses": {
"Forum": [
{
"Name":{
"S":"Amazon DynamoDB"
},
"Threads":{
"N":"5"
},
"Messages":{
"N":"19"
},
"Views":{
"N":"35"
}
},
{
"Name":{
"S":"Amazon RDS"
},
"Threads":{
"N":"8"
},
"Messages":{
"N":"32"
},
"Views":{
"N":"38"
}
},
{
"Name":{
"S":"Amazon Redshift"
},
"Threads":{
"N":"12"
},
"Messages":{
"N":"55"
},
"Views":{
"N":"47"
}
}
]
"Thread": [
{
"Tags":{
"SS":["Reads","MultipleUsers"]
},
"Message":{
"S":"How many users can read a single data item at a time? Are there any limits?"
}
}
]
},
"UnprocessedKeys": {
},
"ConsumedCapacity": [
{
"TableName": "Forum",
"CapacityUnits": 3
},
{
"TableName": "Thread",
"CapacityUnits": 1
}
]
}
```
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/dynamodb-2012-08-10/BatchGetItem)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/dynamodb-2012-08-10/BatchGetItem)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/BatchGetItem)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/dynamodb-2012-08-10/BatchGetItem)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/BatchGetItem)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/dynamodb-2012-08-10/BatchGetItem)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/dynamodb-2012-08-10/BatchGetItem)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/dynamodb-2012-08-10/BatchGetItem)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/dynamodb-2012-08-10/BatchGetItem)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/BatchGetItem)
# BatchWriteItem
The `BatchWriteItem` operation puts or deletes multiple items in one or more tables. A single call to `BatchWriteItem` can transmit up to 16MB of data over the network, consisting of up to 25 item put or delete operations. While individual items can be up to 400 KB once stored, it's important to note that an item's representation might be greater than 400KB while being sent in DynamoDB's JSON format for the API call. For more details on this distinction, see [Naming Rules and Data Types](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.NamingRulesDataTypes.html).
**Note**
`BatchWriteItem` cannot update items. If you perform a `BatchWriteItem` operation on an existing item, that item's values will be overwritten by the operation and it will appear like it was updated. To update items, we recommend you 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.
For tables and indexes with provisioned capacity, 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`. For all tables and indexes, if none of the items can be processed due to other throttling scenarios (such as exceeding partition level limits), then `BatchWriteItem` returns a `ThrottlingException`.
**Important**
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](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#Programming.Errors.BatchOperations) 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 `BatchWriteItem` request 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 `BatchWriteItem` request. For example, you cannot put and delete the same item in the same `BatchWriteItem` request.
+ 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.
+ Any individual items with keys exceeding the key length limits. For a partition key, the limit is 2048 bytes and for a sort key, the limit is 1024 bytes.
## Request Syntax
```
{
"RequestItems": {
"string" : [
{
"DeleteRequest": {
"Key": {
"string" : {
"B": blob,
"BOOL": boolean,
"BS": [ blob ],
"L": [
"AttributeValue"
],
"M": {
"string" : "AttributeValue"
},
"N": "string",
"NS": [ "string" ],
"NULL": boolean,
"S": "string",
"SS": [ "string" ]
}
}
},
"PutRequest": {
"Item": {
"string" : {
"B": blob,
"BOOL": boolean,
"BS": [ blob ],
"L": [
"AttributeValue"
],
"M": {
"string" : "AttributeValue"
},
"N": "string",
"NS": [ "string" ],
"NULL": boolean,
"S": "string",
"SS": [ "string" ]
}
}
}
}
]
},
"ReturnConsumedCapacity": "string",
"ReturnItemCollectionMetrics": "string"
}
```
## Request Parameters
The request accepts the following data in JSON format.
**Note**
In the following list, the required parameters are described first.
** [RequestItems](#API_BatchWriteItem_RequestSyntax) **
A map of one or more table names or table ARNs and, for each table, a list of operations to be performed (`DeleteRequest` or `PutRequest`). Each element in the map consists of the following:
+ `DeleteRequest` - Perform a `DeleteItem` operation on the specified item. The item to be deleted is identified by a `Key` subelement:
+ `Key` - A map of primary key attribute values that uniquely identify the item. Each entry in this map consists of an attribute name and an attribute value. For each primary key, you must provide *all* of the key 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.
+ `PutRequest` - Perform a `PutItem` operation on the specified item. The item to be put is identified by an `Item` subelement:
+ `Item` - A map of attributes and their values. Each entry in this map consists of an attribute name and an attribute value. Attribute values must not be null; string and binary type attributes must have lengths greater than zero; and set type attributes must not be empty. Requests that contain empty values are rejected with a `ValidationException` exception.
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.
Type: String to array of [WriteRequest](API_WriteRequest.md) objects map
Map Entries: Maximum number of 25 items.
Key Length Constraints: Minimum length of 1. Maximum length of 1024.
Array Members: Minimum number of 1 item. Maximum number of 25 items.
Required: Yes
** [ReturnConsumedCapacity](#API_BatchWriteItem_RequestSyntax) **
Determines the level of detail about either provisioned or on-demand throughput consumption that is returned in the response:
+ `INDEXES` - The response includes the aggregate `ConsumedCapacity` for the operation, together with `ConsumedCapacity` for each table and secondary index that was accessed.
Note that some operations, such as `GetItem` and `BatchGetItem`, do not access any indexes at all. In these cases, specifying `INDEXES` will only return `ConsumedCapacity` information for table(s).
+ `TOTAL` - The response includes only the aggregate `ConsumedCapacity` for the operation.
+ `NONE` - No `ConsumedCapacity` details are included in the response.
Type: String
Valid Values: `INDEXES | TOTAL | NONE`
Required: No
** [ReturnItemCollectionMetrics](#API_BatchWriteItem_RequestSyntax) **
Determines whether item collection metrics are returned. If set to `SIZE`, the response includes statistics about item collections, if any, that were modified during the operation are returned in the response. If set to `NONE` (the default), no statistics are returned.
Type: String
Valid Values: `SIZE | NONE`
Required: No
## Response Syntax
```
{
"ConsumedCapacity": [
{
"CapacityUnits": number,
"GlobalSecondaryIndexes": {
"string" : {
"CapacityUnits": number,
"ReadCapacityUnits": number,
"WriteCapacityUnits": number
}
},
"LocalSecondaryIndexes": {
"string" : {
"CapacityUnits": number,
"ReadCapacityUnits": number,
"WriteCapacityUnits": number
}
},
"ReadCapacityUnits": number,
"Table": {
"CapacityUnits": number,
"ReadCapacityUnits": number,
"WriteCapacityUnits": number
},
"TableName": "string",
"WriteCapacityUnits": number
}
],
"ItemCollectionMetrics": {
"string" : [
{
"ItemCollectionKey": {
"string" : {
"B": blob,
"BOOL": boolean,
"BS": [ blob ],
"L": [
"AttributeValue"
],
"M": {
"string" : "AttributeValue"
},
"N": "string",
"NS": [ "string" ],
"NULL": boolean,
"S": "string",
"SS": [ "string" ]
}
},
"SizeEstimateRangeGB": [ number ]
}
]
},
"UnprocessedItems": {
"string" : [
{
"DeleteRequest": {
"Key": {
"string" : {
"B": blob,
"BOOL": boolean,
"BS": [ blob ],
"L": [
"AttributeValue"
],
"M": {
"string" : "AttributeValue"
},
"N": "string",
"NS": [ "string" ],
"NULL": boolean,
"S": "string",
"SS": [ "string" ]
}
}
},
"PutRequest": {
"Item": {
"string" : {
"B": blob,
"BOOL": boolean,
"BS": [ blob ],
"L": [
"AttributeValue"
],
"M": {
"string" : "AttributeValue"
},
"N": "string",
"NS": [ "string" ],
"NULL": boolean,
"S": "string",
"SS": [ "string" ]
}
}
}
}
]
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [ConsumedCapacity](#API_BatchWriteItem_ResponseSyntax) **
The capacity units consumed by the entire `BatchWriteItem` operation.
Each element consists of:
+ `TableName` - The table that consumed the provisioned throughput.
+ `CapacityUnits` - The total number of capacity units consumed.
Type: Array of [ConsumedCapacity](API_ConsumedCapacity.md) objects
** [ItemCollectionMetrics](#API_BatchWriteItem_ResponseSyntax) **
A list of tables that were processed by `BatchWriteItem` and, for each table, information about any item collections that were affected by individual `DeleteItem` or `PutItem` operations.
Each entry consists of the following subelements:
+ `ItemCollectionKey` - The partition key value of the item collection. This is the same as the partition key value of the item.
+ `SizeEstimateRangeGB` - An estimate of item collection size, expressed in GB. This is a two-element array containing a lower bound and an upper bound for the estimate. The estimate includes the size of all the items in the table, plus the size of all attributes projected into all of the local secondary indexes on the table. Use this estimate to measure whether a local secondary index is approaching its size limit.
The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate.
Type: String to array of [ItemCollectionMetrics](API_ItemCollectionMetrics.md) objects map
Key Length Constraints: Minimum length of 1. Maximum length of 1024.
** [UnprocessedItems](#API_BatchWriteItem_ResponseSyntax) **
A map of tables and requests against those tables that were not processed. The `UnprocessedItems` value is in the same form as `RequestItems`, so you can provide this value directly to a subsequent `BatchWriteItem` operation. For more information, see `RequestItems` in the Request Parameters section.
Each `UnprocessedItems` entry consists of a table name or table ARN and, for that table, a list of operations to perform (`DeleteRequest` or `PutRequest`).
+ `DeleteRequest` - Perform a `DeleteItem` operation on the specified item. The item to be deleted is identified by a `Key` subelement:
+ `Key` - A map of primary key attribute values that uniquely identify the item. Each entry in this map consists of an attribute name and an attribute value.
+ `PutRequest` - Perform a `PutItem` operation on the specified item. The item to be put is identified by an `Item` subelement:
+ `Item` - A map of attributes and their values. Each entry in this map consists of an attribute name and an attribute value. Attribute values must not be null; string and binary type attributes must have lengths greater than zero; and set type attributes must not be empty. Requests that contain empty values will be rejected with a `ValidationException` exception.
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.
If there are no unprocessed items remaining, the response contains an empty `UnprocessedItems` map.
Type: String to array of [WriteRequest](API_WriteRequest.md) objects map
Map Entries: Maximum number of 25 items.
Key Length Constraints: Minimum length of 1. Maximum length of 1024.
Array Members: Minimum number of 1 item. Maximum number of 25 items.
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalServerError **
An error occurred on the server side.
** message **
The server encountered an internal error trying to fulfill the request.
HTTP Status Code: 500
** ItemCollectionSizeLimitExceededException **
An item collection is too large. This exception is only returned for tables that have one or more local secondary indexes.
** message **
The total size of an item collection has exceeded the maximum limit of 10 gigabytes.
HTTP Status Code: 400
** ProvisionedThroughputExceededException **
The request was denied due to request throttling. For detailed information about why the request was throttled and the ARN of the impacted resource, find the [ThrottlingReason](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_ThrottlingReason.html) field in the returned exception. The AWS SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to [Error Retries and Exponential Backoff](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Programming.Errors.html#Programming.Errors.RetryAndBackoff) in the *Amazon DynamoDB Developer Guide*.
** message **
You exceeded your maximum allowed provisioned throughput.
** ThrottlingReasons **
A list of [ThrottlingReason](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_ThrottlingReason.html) that provide detailed diagnostic information about why the request was throttled.
HTTP Status Code: 400
** ReplicatedWriteConflictException **
The request was rejected because one or more items in the request are being modified by a request in another Region.
HTTP Status Code: 400
** RequestLimitExceeded **
Throughput exceeds the current throughput quota for your account. For detailed information about why the request was throttled and the ARN of the impacted resource, find the [ThrottlingReason](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_ThrottlingReason.html) field in the returned exception. Contact [Support](https://aws.amazon.com/support) to request a quota increase.
** ThrottlingReasons **
A list of [ThrottlingReason](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_ThrottlingReason.html) that provide detailed diagnostic information about why the request was throttled.
HTTP Status Code: 400
** ResourceNotFoundException **
The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be `ACTIVE`.
** message **
The resource which is being requested does not exist.
HTTP Status Code: 400
** ThrottlingException **
The request was denied due to request throttling. For detailed information about why the request was throttled and the ARN of the impacted resource, find the [ThrottlingReason](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_ThrottlingReason.html) field in the returned exception.
** throttlingReasons **
A list of [ThrottlingReason](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_ThrottlingReason.html) that provide detailed diagnostic information about why the request was throttled.
HTTP Status Code: 400
## Examples
### Multiple Operations on One Table
This example writes several items to the `Forum` table. The response shows that the final put operation failed, possibly because the application exceeded the provisioned throughput on the table. The `UnprocessedItems` object shows the unsuccessful put request. The application can call `BatchWriteItem` again to address such unprocessed requests.
#### Sample Request
```
POST / HTTP/1.1
Host: dynamodb..;
Accept-Encoding: identity
Content-Length:
User-Agent:
Content-Type: application/x-amz-json-1.0
Authorization: AWS4-HMAC-SHA256 Credential=, SignedHeaders=, Signature=
X-Amz-Date:
X-Amz-Target: DynamoDB_20120810.BatchWriteItem
{
"RequestItems": {
"Forum": [
{
"PutRequest": {
"Item": {
"Name": {
"S": "Amazon DynamoDB"
},
"Category": {
"S": "Amazon Web Services"
}
}
}
},
{
"PutRequest": {
"Item": {
"Name": {
"S": "Amazon RDS"
},
"Category": {
"S": "Amazon Web Services"
}
}
}
},
{
"PutRequest": {
"Item": {
"Name": {
"S": "Amazon Redshift"
},
"Category": {
"S": "Amazon Web Services"
}
}
}
},
{
"PutRequest": {
"Item": {
"Name": {
"S": "Amazon ElastiCache"
},
"Category": {
"S": "Amazon Web Services"
}
}
}
}
]
},
"ReturnConsumedCapacity": "TOTAL"
}
```
#### Sample Response
```
HTTP/1.1 200 OK
x-amzn-RequestId:
x-amz-crc32:
Content-Type: application/x-amz-json-1.0
Content-Length:
Date:
{
"UnprocessedItems": {
"Forum": [
{
"PutRequest": {
"Item": {
"Name": {
"S": "Amazon ElastiCache"
},
"Category": {
"S": "Amazon Web Services"
}
}
}
}
]
},
"ConsumedCapacity": [
{
"TableName": "Forum",
"CapacityUnits": 3
}
]
}
```
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/dynamodb-2012-08-10/BatchWriteItem)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/dynamodb-2012-08-10/BatchWriteItem)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/BatchWriteItem)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/dynamodb-2012-08-10/BatchWriteItem)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/BatchWriteItem)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/dynamodb-2012-08-10/BatchWriteItem)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/dynamodb-2012-08-10/BatchWriteItem)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/dynamodb-2012-08-10/BatchWriteItem)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/dynamodb-2012-08-10/BatchWriteItem)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/BatchWriteItem)
# CreateBackup
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 Syntax
```
{
"BackupName": "string",
"TableName": "string"
}
```
## Request Parameters
The request accepts the following data in JSON format.
**Note**
In the following list, the required parameters are described first.
** [BackupName](#API_CreateBackup_RequestSyntax) **
Specified name for the backup.
Type: String
Length Constraints: Minimum length of 3. Maximum length of 255.
Pattern: `[a-zA-Z0-9_.-]+`
Required: Yes
** [TableName](#API_CreateBackup_RequestSyntax) **
The name of the table. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: Yes
## Response Syntax
```
{
"BackupDetails": {
"BackupArn": "string",
"BackupCreationDateTime": number,
"BackupExpiryDateTime": number,
"BackupName": "string",
"BackupSizeBytes": number,
"BackupStatus": "string",
"BackupType": "string"
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [BackupDetails](#API_CreateBackup_ResponseSyntax) **
Contains the details of the backup created for the table.
Type: [BackupDetails](API_BackupDetails.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** BackupInUseException **
There is another ongoing conflicting backup control plane operation on the table. The backup is either being created, deleted or restored to a table.
HTTP Status Code: 400
** ContinuousBackupsUnavailableException **
Backups have not yet been enabled for this table.
HTTP Status Code: 400
** InternalServerError **
An error occurred on the server side.
** message **
The server encountered an internal error trying to fulfill the request.
HTTP Status Code: 500
** LimitExceededException **
There is no limit to the number of daily on-demand backups that can be taken.
For most purposes, up to 500 simultaneous table operations are allowed per account. These operations include `CreateTable`, `UpdateTable`, `DeleteTable`,`UpdateTimeToLive`, `RestoreTableFromBackup`, and `RestoreTableToPointInTime`.
When you are creating a table with one or more secondary indexes, you can have up to 250 such requests running at a time. However, if the table or index specifications are complex, then DynamoDB might temporarily reduce the number of concurrent operations.
When importing into DynamoDB, up to 50 simultaneous import table operations are allowed per account.
There is a soft account quota of 2,500 tables.
GetRecords was called with a value of more than 1000 for the limit request parameter.
More than 2 processes are reading from the same streams shard at the same time. Exceeding this limit may result in request throttling.
** message **
Too many operations for a given subscriber.
HTTP Status Code: 400
** TableInUseException **
A target table with the specified name is either being created or deleted.
HTTP Status Code: 400
** TableNotFoundException **
A source table with the name `TableName` does not currently exist within the subscriber's account or the subscriber is operating in the wrong AWS Region.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/dynamodb-2012-08-10/CreateBackup)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/dynamodb-2012-08-10/CreateBackup)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/CreateBackup)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/dynamodb-2012-08-10/CreateBackup)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/CreateBackup)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/dynamodb-2012-08-10/CreateBackup)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/dynamodb-2012-08-10/CreateBackup)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/dynamodb-2012-08-10/CreateBackup)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/dynamodb-2012-08-10/CreateBackup)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/CreateBackup)
# CreateGlobalTable
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.
**Important**
This documentation is for version 2017.11.29 (Legacy) of global tables, which should be avoided for new global tables. Customers should use [Global Tables version 2019.11.21 (Current)](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/GlobalTables.html) when possible, because it provides greater flexibility, higher efficiency, and consumes less write capacity than 2017.11.29 (Legacy).
To determine which version you're using, see [Determining the global table version you are using](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.DetermineVersion.html). To update existing global tables from version 2017.11.29 (Legacy) to version 2019.11.21 (Current), see [Upgrading global tables](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/V2globaltables_upgrade.html).
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).
If local secondary indexes are specified, then the following conditions must also be met:
+ The local secondary indexes must have the same name.
+ The local secondary indexes must have the same hash key and sort key (if present).
**Important**
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 Syntax
```
{
"GlobalTableName": "string",
"ReplicationGroup": [
{
"RegionName": "string"
}
]
}
```
## Request Parameters
The request accepts the following data in JSON format.
**Note**
In the following list, the required parameters are described first.
** [GlobalTableName](#API_CreateGlobalTable_RequestSyntax) **
The global table name.
Type: String
Length Constraints: Minimum length of 3. Maximum length of 255.
Pattern: `[a-zA-Z0-9_.-]+`
Required: Yes
** [ReplicationGroup](#API_CreateGlobalTable_RequestSyntax) **
The Regions where the global table needs to be created.
Type: Array of [Replica](API_Replica.md) objects
Required: Yes
## Response Syntax
```
{
"GlobalTableDescription": {
"CreationDateTime": number,
"GlobalTableArn": "string",
"GlobalTableName": "string",
"GlobalTableStatus": "string",
"ReplicationGroup": [
{
"GlobalSecondaryIndexes": [
{
"IndexName": "string",
"OnDemandThroughputOverride": {
"MaxReadRequestUnits": number
},
"ProvisionedThroughputOverride": {
"ReadCapacityUnits": number
},
"WarmThroughput": {
"ReadUnitsPerSecond": number,
"Status": "string",
"WriteUnitsPerSecond": number
}
}
],
"GlobalTableSettingsReplicationMode": "string",
"KMSMasterKeyId": "string",
"OnDemandThroughputOverride": {
"MaxReadRequestUnits": number
},
"ProvisionedThroughputOverride": {
"ReadCapacityUnits": number
},
"RegionName": "string",
"ReplicaArn": "string",
"ReplicaInaccessibleDateTime": number,
"ReplicaStatus": "string",
"ReplicaStatusDescription": "string",
"ReplicaStatusPercentProgress": "string",
"ReplicaTableClassSummary": {
"LastUpdateDateTime": number,
"TableClass": "string"
},
"WarmThroughput": {
"ReadUnitsPerSecond": number,
"Status": "string",
"WriteUnitsPerSecond": number
}
}
]
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [GlobalTableDescription](#API_CreateGlobalTable_ResponseSyntax) **
Contains the details of the global table.
Type: [GlobalTableDescription](API_GlobalTableDescription.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** GlobalTableAlreadyExistsException **
The specified global table already exists.
HTTP Status Code: 400
** InternalServerError **
An error occurred on the server side.
** message **
The server encountered an internal error trying to fulfill the request.
HTTP Status Code: 500
** LimitExceededException **
There is no limit to the number of daily on-demand backups that can be taken.
For most purposes, up to 500 simultaneous table operations are allowed per account. These operations include `CreateTable`, `UpdateTable`, `DeleteTable`,`UpdateTimeToLive`, `RestoreTableFromBackup`, and `RestoreTableToPointInTime`.
When you are creating a table with one or more secondary indexes, you can have up to 250 such requests running at a time. However, if the table or index specifications are complex, then DynamoDB might temporarily reduce the number of concurrent operations.
When importing into DynamoDB, up to 50 simultaneous import table operations are allowed per account.
There is a soft account quota of 2,500 tables.
GetRecords was called with a value of more than 1000 for the limit request parameter.
More than 2 processes are reading from the same streams shard at the same time. Exceeding this limit may result in request throttling.
** message **
Too many operations for a given subscriber.
HTTP Status Code: 400
** TableNotFoundException **
A source table with the name `TableName` does not currently exist within the subscriber's account or the subscriber is operating in the wrong AWS Region.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/dynamodb-2012-08-10/CreateGlobalTable)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/dynamodb-2012-08-10/CreateGlobalTable)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/CreateGlobalTable)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/dynamodb-2012-08-10/CreateGlobalTable)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/CreateGlobalTable)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/dynamodb-2012-08-10/CreateGlobalTable)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/dynamodb-2012-08-10/CreateGlobalTable)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/dynamodb-2012-08-10/CreateGlobalTable)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/dynamodb-2012-08-10/CreateGlobalTable)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/CreateGlobalTable)
# CreateTable
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 Syntax
```
{
"AttributeDefinitions": [
{
"AttributeName": "string",
"AttributeType": "string"
}
],
"BillingMode": "string",
"DeletionProtectionEnabled": boolean,
"GlobalSecondaryIndexes": [
{
"IndexName": "string",
"KeySchema": [
{
"AttributeName": "string",
"KeyType": "string"
}
],
"OnDemandThroughput": {
"MaxReadRequestUnits": number,
"MaxWriteRequestUnits": number
},
"Projection": {
"NonKeyAttributes": [ "string" ],
"ProjectionType": "string"
},
"ProvisionedThroughput": {
"ReadCapacityUnits": number,
"WriteCapacityUnits": number
},
"WarmThroughput": {
"ReadUnitsPerSecond": number,
"WriteUnitsPerSecond": number
}
}
],
"GlobalTableSettingsReplicationMode": "string",
"GlobalTableSourceArn": "string",
"KeySchema": [
{
"AttributeName": "string",
"KeyType": "string"
}
],
"LocalSecondaryIndexes": [
{
"IndexName": "string",
"KeySchema": [
{
"AttributeName": "string",
"KeyType": "string"
}
],
"Projection": {
"NonKeyAttributes": [ "string" ],
"ProjectionType": "string"
}
}
],
"OnDemandThroughput": {
"MaxReadRequestUnits": number,
"MaxWriteRequestUnits": number
},
"ProvisionedThroughput": {
"ReadCapacityUnits": number,
"WriteCapacityUnits": number
},
"ResourcePolicy": "string",
"SSESpecification": {
"Enabled": boolean,
"KMSMasterKeyId": "string",
"SSEType": "string"
},
"StreamSpecification": {
"StreamEnabled": boolean,
"StreamViewType": "string"
},
"TableClass": "string",
"TableName": "string",
"Tags": [
{
"Key": "string",
"Value": "string"
}
],
"WarmThroughput": {
"ReadUnitsPerSecond": number,
"WriteUnitsPerSecond": number
}
}
```
## Request Parameters
The request accepts the following data in JSON format.
**Note**
In the following list, the required parameters are described first.
** [TableName](#API_CreateTable_RequestSyntax) **
The name of the table to create. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: Yes
** [AttributeDefinitions](#API_CreateTable_RequestSyntax) **
An array of attributes that describe the key schema for the table and indexes.
Type: Array of [AttributeDefinition](API_AttributeDefinition.md) objects
Required: No
** [BillingMode](#API_CreateTable_RequestSyntax) **
Controls how you are charged for read and write throughput and how you manage capacity. This setting can be changed later.
+ `PAY_PER_REQUEST` - We recommend using `PAY_PER_REQUEST` for most DynamoDB workloads. `PAY_PER_REQUEST` sets the billing mode to [On-demand capacity mode](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/on-demand-capacity-mode.html).
+ `PROVISIONED` - We recommend using `PROVISIONED` for steady workloads with predictable growth where capacity requirements can be reliably forecasted. `PROVISIONED` sets the billing mode to [Provisioned capacity mode](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/provisioned-capacity-mode.html).
Type: String
Valid Values: `PROVISIONED | PAY_PER_REQUEST`
Required: No
** [DeletionProtectionEnabled](#API_CreateTable_RequestSyntax) **
Indicates whether deletion protection is to be enabled (true) or disabled (false) on the table.
Type: Boolean
Required: No
** [GlobalSecondaryIndexes](#API_CreateTable_RequestSyntax) **
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:
+ `IndexName` - The name of the global secondary index. Must be unique only for this table.
+ `KeySchema` - Specifies the key schema for the global secondary index. Each global secondary index supports up to 4 partition keys and up to 4 sort keys.
+ `Projection` - Specifies attributes that are copied (projected) from the table into the index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Each attribute specification is composed of:
+ `ProjectionType` - One of the following:
+ `KEYS_ONLY` - Only the index and primary keys are projected into the index.
+ `INCLUDE` - Only the specified table attributes are projected into the index. The list of projected attributes is in `NonKeyAttributes`.
+ `ALL` - All of the table attributes are projected into the index.
+ `NonKeyAttributes` - A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes provided in `NonKeyAttributes`, summed across all of the secondary indexes, must not exceed 100. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total. This limit only applies when you specify the ProjectionType of `INCLUDE`. You still can specify the ProjectionType of `ALL` to project all attributes from the source table, even if the table has more than 100 attributes.
+ `ProvisionedThroughput` - The provisioned throughput settings for the global secondary index, consisting of read and write capacity units.
Type: Array of [GlobalSecondaryIndex](API_GlobalSecondaryIndex.md) objects
Required: No
** [GlobalTableSettingsReplicationMode](#API_CreateTable_RequestSyntax) **
Controls the settings synchronization mode for the global table. For multi-account global tables, this parameter is required and the only supported value is ENABLED. For same-account global tables, this parameter is set to ENABLED\$1WITH\$1OVERRIDES.
Type: String
Valid Values: `ENABLED | DISABLED | ENABLED_WITH_OVERRIDES`
Required: No
** [GlobalTableSourceArn](#API_CreateTable_RequestSyntax) **
The Amazon Resource Name (ARN) of the source table used for the creation of a multi-account global table.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: No
** [KeySchema](#API_CreateTable_RequestSyntax) **
Specifies the attributes that make up the primary key for a table or an index. The attributes in `KeySchema` must also be defined in the `AttributeDefinitions` array. For more information, see [Data Model](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DataModel.html) in the *Amazon DynamoDB Developer Guide*.
Each `KeySchemaElement` in the array is composed of:
+ `AttributeName` - The name of this key attribute.
+ `KeyType` - The role that the key attribute will assume:
+ `HASH` - partition key
+ `RANGE` - sort key
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 `KeyType` of `HASH`.
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 `KeyType` of `HASH`, and the second element must have a `KeyType` of `RANGE`.
For more information, see [Working with Tables](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#WorkingWithTables.primary.key) in the *Amazon DynamoDB Developer Guide*.
Type: Array of [KeySchemaElement](API_KeySchemaElement.md) objects
Array Members: Minimum number of 1 item.
Required: No
** [LocalSecondaryIndexes](#API_CreateTable_RequestSyntax) **
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:
+ `IndexName` - The name of the local secondary index. Must be unique only for this table.
+ `KeySchema` - Specifies the key schema for the local secondary index. The key schema must begin with the same partition key as the table.
+ `Projection` - Specifies attributes that are copied (projected) from the table into the index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Each attribute specification is composed of:
+ `ProjectionType` - One of the following:
+ `KEYS_ONLY` - Only the index and primary keys are projected into the index.
+ `INCLUDE` - Only the specified table attributes are projected into the index. The list of projected attributes is in `NonKeyAttributes`.
+ `ALL` - All of the table attributes are projected into the index.
+ `NonKeyAttributes` - A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes provided in `NonKeyAttributes`, summed across all of the secondary indexes, must not exceed 100. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total. This limit only applies when you specify the ProjectionType of `INCLUDE`. You still can specify the ProjectionType of `ALL` to project all attributes from the source table, even if the table has more than 100 attributes.
Type: Array of [LocalSecondaryIndex](API_LocalSecondaryIndex.md) objects
Required: No
** [OnDemandThroughput](#API_CreateTable_RequestSyntax) **
Sets the maximum number of read and write units for the specified table in on-demand capacity mode. If you use this parameter, you must specify `MaxReadRequestUnits`, `MaxWriteRequestUnits`, or both.
Type: [OnDemandThroughput](API_OnDemandThroughput.md) object
Required: No
** [ProvisionedThroughput](#API_CreateTable_RequestSyntax) **
Represents the provisioned throughput settings for a specified table or index. The settings can be modified using the `UpdateTable` operation.
If you set BillingMode as `PROVISIONED`, you must specify this property. If you set BillingMode as `PAY_PER_REQUEST`, you cannot specify this property.
For current minimum and maximum provisioned throughput values, see [Service, Account, and Table Quotas](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html) in the *Amazon DynamoDB Developer Guide*.
Type: [ProvisionedThroughput](API_ProvisionedThroughput.md) object
Required: No
** [ResourcePolicy](#API_CreateTable_RequestSyntax) **
An AWS resource-based policy document in JSON format that will be attached to the table.
When you attach a resource-based policy while creating a table, the policy application is *strongly consistent*.
The maximum size supported for a resource-based policy document is 20 KB. DynamoDB counts whitespaces when calculating the size of a policy against this limit. For a full list of all considerations that apply for resource-based policies, see [Resource-based policy considerations](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/rbac-considerations.html).
You need to specify the `CreateTable` and `PutResourcePolicy` IAM actions for authorizing a user to create a table with a resource-based policy.
Type: String
Required: No
** [SSESpecification](#API_CreateTable_RequestSyntax) **
Represents the settings used to enable server-side encryption.
Type: [SSESpecification](API_SSESpecification.md) object
Required: No
** [StreamSpecification](#API_CreateTable_RequestSyntax) **
The settings for DynamoDB Streams on the table. These settings consist of:
+ `StreamEnabled` - Indicates whether DynamoDB Streams is to be enabled (true) or disabled (false).
+ `StreamViewType` - When an item in the table is modified, `StreamViewType` determines what information is written to the table's stream. Valid values for `StreamViewType` are:
+ `KEYS_ONLY` - Only the key attributes of the modified item are written to the stream.
+ `NEW_IMAGE` - The entire item, as it appears after it was modified, is written to the stream.
+ `OLD_IMAGE` - The entire item, as it appeared before it was modified, is written to the stream.
+ `NEW_AND_OLD_IMAGES` - Both the new and the old item images of the item are written to the stream.
Type: [StreamSpecification](API_StreamSpecification.md) object
Required: No
** [TableClass](#API_CreateTable_RequestSyntax) **
The table class of the new table. Valid values are `STANDARD` and `STANDARD_INFREQUENT_ACCESS`.
Type: String
Valid Values: `STANDARD | STANDARD_INFREQUENT_ACCESS`
Required: No
** [Tags](#API_CreateTable_RequestSyntax) **
A list of key-value pairs to label the table. For more information, see [Tagging for DynamoDB](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Tagging.html).
Type: Array of [Tag](API_Tag.md) objects
Required: No
** [WarmThroughput](#API_CreateTable_RequestSyntax) **
Represents the warm throughput (in read units per second and write units per second) for creating a table.
Type: [WarmThroughput](API_WarmThroughput.md) object
Required: No
## Response Syntax
```
{
"TableDescription": {
"ArchivalSummary": {
"ArchivalBackupArn": "string",
"ArchivalDateTime": number,
"ArchivalReason": "string"
},
"AttributeDefinitions": [
{
"AttributeName": "string",
"AttributeType": "string"
}
],
"BillingModeSummary": {
"BillingMode": "string",
"LastUpdateToPayPerRequestDateTime": number
},
"CreationDateTime": number,
"DeletionProtectionEnabled": boolean,
"GlobalSecondaryIndexes": [
{
"Backfilling": boolean,
"IndexArn": "string",
"IndexName": "string",
"IndexSizeBytes": number,
"IndexStatus": "string",
"ItemCount": number,
"KeySchema": [
{
"AttributeName": "string",
"KeyType": "string"
}
],
"OnDemandThroughput": {
"MaxReadRequestUnits": number,
"MaxWriteRequestUnits": number
},
"Projection": {
"NonKeyAttributes": [ "string" ],
"ProjectionType": "string"
},
"ProvisionedThroughput": {
"LastDecreaseDateTime": number,
"LastIncreaseDateTime": number,
"NumberOfDecreasesToday": number,
"ReadCapacityUnits": number,
"WriteCapacityUnits": number
},
"WarmThroughput": {
"ReadUnitsPerSecond": number,
"Status": "string",
"WriteUnitsPerSecond": number
}
}
],
"GlobalTableSettingsReplicationMode": "string",
"GlobalTableVersion": "string",
"GlobalTableWitnesses": [
{
"RegionName": "string",
"WitnessStatus": "string"
}
],
"ItemCount": number,
"KeySchema": [
{
"AttributeName": "string",
"KeyType": "string"
}
],
"LatestStreamArn": "string",
"LatestStreamLabel": "string",
"LocalSecondaryIndexes": [
{
"IndexArn": "string",
"IndexName": "string",
"IndexSizeBytes": number,
"ItemCount": number,
"KeySchema": [
{
"AttributeName": "string",
"KeyType": "string"
}
],
"Projection": {
"NonKeyAttributes": [ "string" ],
"ProjectionType": "string"
}
}
],
"MultiRegionConsistency": "string",
"OnDemandThroughput": {
"MaxReadRequestUnits": number,
"MaxWriteRequestUnits": number
},
"ProvisionedThroughput": {
"LastDecreaseDateTime": number,
"LastIncreaseDateTime": number,
"NumberOfDecreasesToday": number,
"ReadCapacityUnits": number,
"WriteCapacityUnits": number
},
"Replicas": [
{
"GlobalSecondaryIndexes": [
{
"IndexName": "string",
"OnDemandThroughputOverride": {
"MaxReadRequestUnits": number
},
"ProvisionedThroughputOverride": {
"ReadCapacityUnits": number
},
"WarmThroughput": {
"ReadUnitsPerSecond": number,
"Status": "string",
"WriteUnitsPerSecond": number
}
}
],
"GlobalTableSettingsReplicationMode": "string",
"KMSMasterKeyId": "string",
"OnDemandThroughputOverride": {
"MaxReadRequestUnits": number
},
"ProvisionedThroughputOverride": {
"ReadCapacityUnits": number
},
"RegionName": "string",
"ReplicaArn": "string",
"ReplicaInaccessibleDateTime": number,
"ReplicaStatus": "string",
"ReplicaStatusDescription": "string",
"ReplicaStatusPercentProgress": "string",
"ReplicaTableClassSummary": {
"LastUpdateDateTime": number,
"TableClass": "string"
},
"WarmThroughput": {
"ReadUnitsPerSecond": number,
"Status": "string",
"WriteUnitsPerSecond": number
}
}
],
"RestoreSummary": {
"RestoreDateTime": number,
"RestoreInProgress": boolean,
"SourceBackupArn": "string",
"SourceTableArn": "string"
},
"SSEDescription": {
"InaccessibleEncryptionDateTime": number,
"KMSMasterKeyArn": "string",
"SSEType": "string",
"Status": "string"
},
"StreamSpecification": {
"StreamEnabled": boolean,
"StreamViewType": "string"
},
"TableArn": "string",
"TableClassSummary": {
"LastUpdateDateTime": number,
"TableClass": "string"
},
"TableId": "string",
"TableName": "string",
"TableSizeBytes": number,
"TableStatus": "string",
"WarmThroughput": {
"ReadUnitsPerSecond": number,
"Status": "string",
"WriteUnitsPerSecond": number
}
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [TableDescription](#API_CreateTable_ResponseSyntax) **
Represents the properties of the table.
Type: [TableDescription](API_TableDescription.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalServerError **
An error occurred on the server side.
** message **
The server encountered an internal error trying to fulfill the request.
HTTP Status Code: 500
** LimitExceededException **
There is no limit to the number of daily on-demand backups that can be taken.
For most purposes, up to 500 simultaneous table operations are allowed per account. These operations include `CreateTable`, `UpdateTable`, `DeleteTable`,`UpdateTimeToLive`, `RestoreTableFromBackup`, and `RestoreTableToPointInTime`.
When you are creating a table with one or more secondary indexes, you can have up to 250 such requests running at a time. However, if the table or index specifications are complex, then DynamoDB might temporarily reduce the number of concurrent operations.
When importing into DynamoDB, up to 50 simultaneous import table operations are allowed per account.
There is a soft account quota of 2,500 tables.
GetRecords was called with a value of more than 1000 for the limit request parameter.
More than 2 processes are reading from the same streams shard at the same time. Exceeding this limit may result in request throttling.
** message **
Too many operations for a given subscriber.
HTTP Status Code: 400
** ResourceInUseException **
The operation conflicts with the resource's availability. For example:
+ You attempted to recreate an existing table.
+ You tried to delete a table currently in the `CREATING` state.
+ You tried to update a resource that was already being updated.
When appropriate, wait for the ongoing update to complete and attempt the request again.
** message **
The resource which is being attempted to be changed is in use.
HTTP Status Code: 400
## Examples
### Create a Table
This example creates a table named `Thread`. The table primary key consists of `ForumName` (partition key) and `Subject` (sort key). A local secondary index is also created; its key consists of `ForumName` (partition key) and `LastPostDateTime` (sort key).
#### Sample Request
```
POST / HTTP/1.1
Host: dynamodb..;
Accept-Encoding: identity
Content-Length:
User-Agent:
Content-Type: application/x-amz-json-1.0
Authorization: AWS4-HMAC-SHA256 Credential=, SignedHeaders=, Signature=
X-Amz-Date:
X-Amz-Target: DynamoDB_20120810.CreateTable
{
"AttributeDefinitions": [
{
"AttributeName": "ForumName",
"AttributeType": "S"
},
{
"AttributeName": "Subject",
"AttributeType": "S"
},
{
"AttributeName": "LastPostDateTime",
"AttributeType": "S"
}
],
"TableName": "Thread",
"KeySchema": [
{
"AttributeName": "ForumName",
"KeyType": "HASH"
},
{
"AttributeName": "Subject",
"KeyType": "RANGE"
}
],
"LocalSecondaryIndexes": [
{
"IndexName": "LastPostIndex",
"KeySchema": [
{
"AttributeName": "ForumName",
"KeyType": "HASH"
},
{
"AttributeName": "LastPostDateTime",
"KeyType": "RANGE"
}
],
"Projection": {
"ProjectionType": "KEYS_ONLY"
}
}
],
"BillingMode": "PAY_PER_REQUEST",
"Tags": [
{
"Key": "Owner",
"Value": "BlueTeam"
}
]
}
```
#### Sample Response
```
HTTP/1.1 200 OK
x-amzn-RequestId:
x-amz-crc32:
Content-Type: application/x-amz-json-1.0
Content-Length:
Date:
{
"TableDescription": {
"TableArn": "arn:aws:dynamodb:us-west-2:123456789012:table/Thread",
"AttributeDefinitions": [
{
"AttributeName": "ForumName",
"AttributeType": "S"
},
{
"AttributeName": "LastPostDateTime",
"AttributeType": "S"
},
{
"AttributeName": "Subject",
"AttributeType": "S"
}
],
"CreationDateTime": 1.36372808007E9,
"ItemCount": 0,
"KeySchema": [
{
"AttributeName": "ForumName",
"KeyType": "HASH"
},
{
"AttributeName": "Subject",
"KeyType": "RANGE"
}
],
"LocalSecondaryIndexes": [
{
"IndexArn": "arn:aws:dynamodb:us-west-2:123456789012:table/Thread/index/LastPostIndex",
"IndexName": "LastPostIndex",
"IndexSizeBytes": 0,
"ItemCount": 0,
"KeySchema": [
{
"AttributeName": "ForumName",
"KeyType": "HASH"
},
{
"AttributeName": "LastPostDateTime",
"KeyType": "RANGE"
}
],
"Projection": {
"ProjectionType": "KEYS_ONLY"
}
}
],
"TableName": "Thread",
"TableSizeBytes": 0,
"TableStatus": "CREATING"
}
}
```
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/dynamodb-2012-08-10/CreateTable)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/dynamodb-2012-08-10/CreateTable)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/CreateTable)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/dynamodb-2012-08-10/CreateTable)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/CreateTable)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/dynamodb-2012-08-10/CreateTable)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/dynamodb-2012-08-10/CreateTable)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/dynamodb-2012-08-10/CreateTable)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/dynamodb-2012-08-10/CreateTable)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/CreateTable)
# DeleteBackup
Deletes an existing backup of a table.
You can call `DeleteBackup` at a maximum rate of 10 times per second.
## Request Syntax
```
{
"BackupArn": "string"
}
```
## Request Parameters
The request accepts the following data in JSON format.
**Note**
In the following list, the required parameters are described first.
** [BackupArn](#API_DeleteBackup_RequestSyntax) **
The ARN associated with the backup.
Type: String
Length Constraints: Minimum length of 37. Maximum length of 1024.
Required: Yes
## Response Syntax
```
{
"BackupDescription": {
"BackupDetails": {
"BackupArn": "string",
"BackupCreationDateTime": number,
"BackupExpiryDateTime": number,
"BackupName": "string",
"BackupSizeBytes": number,
"BackupStatus": "string",
"BackupType": "string"
},
"SourceTableDetails": {
"BillingMode": "string",
"ItemCount": number,
"KeySchema": [
{
"AttributeName": "string",
"KeyType": "string"
}
],
"OnDemandThroughput": {
"MaxReadRequestUnits": number,
"MaxWriteRequestUnits": number
},
"ProvisionedThroughput": {
"ReadCapacityUnits": number,
"WriteCapacityUnits": number
},
"TableArn": "string",
"TableCreationDateTime": number,
"TableId": "string",
"TableName": "string",
"TableSizeBytes": number
},
"SourceTableFeatureDetails": {
"GlobalSecondaryIndexes": [
{
"IndexName": "string",
"KeySchema": [
{
"AttributeName": "string",
"KeyType": "string"
}
],
"OnDemandThroughput": {
"MaxReadRequestUnits": number,
"MaxWriteRequestUnits": number
},
"Projection": {
"NonKeyAttributes": [ "string" ],
"ProjectionType": "string"
},
"ProvisionedThroughput": {
"ReadCapacityUnits": number,
"WriteCapacityUnits": number
}
}
],
"LocalSecondaryIndexes": [
{
"IndexName": "string",
"KeySchema": [
{
"AttributeName": "string",
"KeyType": "string"
}
],
"Projection": {
"NonKeyAttributes": [ "string" ],
"ProjectionType": "string"
}
}
],
"SSEDescription": {
"InaccessibleEncryptionDateTime": number,
"KMSMasterKeyArn": "string",
"SSEType": "string",
"Status": "string"
},
"StreamDescription": {
"StreamEnabled": boolean,
"StreamViewType": "string"
},
"TimeToLiveDescription": {
"AttributeName": "string",
"TimeToLiveStatus": "string"
}
}
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [BackupDescription](#API_DeleteBackup_ResponseSyntax) **
Contains the description of the backup created for the table.
Type: [BackupDescription](API_BackupDescription.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** BackupInUseException **
There is another ongoing conflicting backup control plane operation on the table. The backup is either being created, deleted or restored to a table.
HTTP Status Code: 400
** BackupNotFoundException **
Backup not found for the given BackupARN.
HTTP Status Code: 400
** InternalServerError **
An error occurred on the server side.
** message **
The server encountered an internal error trying to fulfill the request.
HTTP Status Code: 500
** LimitExceededException **
There is no limit to the number of daily on-demand backups that can be taken.
For most purposes, up to 500 simultaneous table operations are allowed per account. These operations include `CreateTable`, `UpdateTable`, `DeleteTable`,`UpdateTimeToLive`, `RestoreTableFromBackup`, and `RestoreTableToPointInTime`.
When you are creating a table with one or more secondary indexes, you can have up to 250 such requests running at a time. However, if the table or index specifications are complex, then DynamoDB might temporarily reduce the number of concurrent operations.
When importing into DynamoDB, up to 50 simultaneous import table operations are allowed per account.
There is a soft account quota of 2,500 tables.
GetRecords was called with a value of more than 1000 for the limit request parameter.
More than 2 processes are reading from the same streams shard at the same time. Exceeding this limit may result in request throttling.
** message **
Too many operations for a given subscriber.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/dynamodb-2012-08-10/DeleteBackup)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/dynamodb-2012-08-10/DeleteBackup)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/DeleteBackup)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/dynamodb-2012-08-10/DeleteBackup)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/DeleteBackup)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/dynamodb-2012-08-10/DeleteBackup)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/dynamodb-2012-08-10/DeleteBackup)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/dynamodb-2012-08-10/DeleteBackup)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/dynamodb-2012-08-10/DeleteBackup)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/DeleteBackup)
# DeleteItem
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 Syntax
```
{
"ConditionalOperator": "string",
"ConditionExpression": "string",
"Expected": {
"string" : {
"AttributeValueList": [
{
"B": blob,
"BOOL": boolean,
"BS": [ blob ],
"L": [
"AttributeValue"
],
"M": {
"string" : "AttributeValue"
},
"N": "string",
"NS": [ "string" ],
"NULL": boolean,
"S": "string",
"SS": [ "string" ]
}
],
"ComparisonOperator": "string",
"Exists": boolean,
"Value": {
"B": blob,
"BOOL": boolean,
"BS": [ blob ],
"L": [
"AttributeValue"
],
"M": {
"string" : "AttributeValue"
},
"N": "string",
"NS": [ "string" ],
"NULL": boolean,
"S": "string",
"SS": [ "string" ]
}
}
},
"ExpressionAttributeNames": {
"string" : "string"
},
"ExpressionAttributeValues": {
"string" : {
"B": blob,
"BOOL": boolean,
"BS": [ blob ],
"L": [
"AttributeValue"
],
"M": {
"string" : "AttributeValue"
},
"N": "string",
"NS": [ "string" ],
"NULL": boolean,
"S": "string",
"SS": [ "string" ]
}
},
"Key": {
"string" : {
"B": blob,
"BOOL": boolean,
"BS": [ blob ],
"L": [
"AttributeValue"
],
"M": {
"string" : "AttributeValue"
},
"N": "string",
"NS": [ "string" ],
"NULL": boolean,
"S": "string",
"SS": [ "string" ]
}
},
"ReturnConsumedCapacity": "string",
"ReturnItemCollectionMetrics": "string",
"ReturnValues": "string",
"ReturnValuesOnConditionCheckFailure": "string",
"TableName": "string"
}
```
## Request Parameters
The request accepts the following data in JSON format.
**Note**
In the following list, the required parameters are described first.
** [Key](#API_DeleteItem_RequestSyntax) **
A map of attribute names to `AttributeValue` objects, representing the primary key of the item to delete.
For the primary key, you must provide all of the key 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.
Type: String to [AttributeValue](API_AttributeValue.md) object map
Key Length Constraints: Maximum length of 65535.
Required: Yes
** [TableName](#API_DeleteItem_RequestSyntax) **
The name of the table from which to delete the item. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: Yes
** [ConditionalOperator](#API_DeleteItem_RequestSyntax) **
This is a legacy parameter. Use `ConditionExpression` instead. For more information, see [ConditionalOperator](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.ConditionalOperator.html) in the *Amazon DynamoDB Developer Guide*.
Type: String
Valid Values: `AND | OR`
Required: No
** [ConditionExpression](#API_DeleteItem_RequestSyntax) **
A condition that must be satisfied in order for a conditional `DeleteItem` to succeed.
An expression can contain any of the following:
+ Functions: `attribute_exists | attribute_not_exists | attribute_type | contains | begins_with | size`
These function names are case-sensitive.
+ Comparison operators: `= | <> | < | > | <= | >= | BETWEEN | IN `
+ Logical operators: `AND | OR | NOT`
For more information about condition expressions, see [Condition Expressions](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.SpecifyingConditions.html) in the *Amazon DynamoDB Developer Guide*.
Type: String
Required: No
** [Expected](#API_DeleteItem_RequestSyntax) **
This is a legacy parameter. Use `ConditionExpression` instead. For more information, see [Expected](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.Expected.html) in the *Amazon DynamoDB Developer Guide*.
Type: String to [ExpectedAttributeValue](API_ExpectedAttributeValue.md) object map
Key Length Constraints: Maximum length of 65535.
Required: No
** [ExpressionAttributeNames](#API_DeleteItem_RequestSyntax) **
One or more substitution tokens for attribute names in an expression. The following are some use cases for using `ExpressionAttributeNames`:
+ To access an attribute whose name conflicts with a DynamoDB reserved word.
+ To create a placeholder for repeating occurrences of an attribute name in an expression.
+ To prevent special characters in an attribute name from being misinterpreted in an expression.
Use the **\$1** character in an expression to dereference an attribute name. For example, consider the following attribute name:
+ `Percentile`
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](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ReservedWords.html) in the *Amazon DynamoDB Developer Guide*). To work around this, you could specify the following for `ExpressionAttributeNames`:
+ `{"#P":"Percentile"}`
You could then use this substitution in an expression, as in this example:
+ `#P = :val`
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](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html) in the *Amazon DynamoDB Developer Guide*.
Type: String to string map
Value Length Constraints: Maximum length of 65535.
Required: No
** [ExpressionAttributeValues](#API_DeleteItem_RequestSyntax) **
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:
`Available | Backordered | Discontinued`
You would first need to specify `ExpressionAttributeValues` as follows:
`{ ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }`
You could then use these values in an expression, such as this:
`ProductStatus IN (:avail, :back, :disc)`
For more information on expression attribute values, see [Condition Expressions](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.SpecifyingConditions.html) in the *Amazon DynamoDB Developer Guide*.
Type: String to [AttributeValue](API_AttributeValue.md) object map
Required: No
** [ReturnConsumedCapacity](#API_DeleteItem_RequestSyntax) **
Determines the level of detail about either provisioned or on-demand throughput consumption that is returned in the response:
+ `INDEXES` - The response includes the aggregate `ConsumedCapacity` for the operation, together with `ConsumedCapacity` for each table and secondary index that was accessed.
Note that some operations, such as `GetItem` and `BatchGetItem`, do not access any indexes at all. In these cases, specifying `INDEXES` will only return `ConsumedCapacity` information for table(s).
+ `TOTAL` - The response includes only the aggregate `ConsumedCapacity` for the operation.
+ `NONE` - No `ConsumedCapacity` details are included in the response.
Type: String
Valid Values: `INDEXES | TOTAL | NONE`
Required: No
** [ReturnItemCollectionMetrics](#API_DeleteItem_RequestSyntax) **
Determines whether item collection metrics are returned. If set to `SIZE`, the response includes statistics about item collections, if any, that were modified during the operation are returned in the response. If set to `NONE` (the default), no statistics are returned.
Type: String
Valid Values: `SIZE | NONE`
Required: No
** [ReturnValues](#API_DeleteItem_RequestSyntax) **
Use `ReturnValues` if you want to get the item attributes as they appeared before they were deleted. For `DeleteItem`, the valid values are:
+ `NONE` - If `ReturnValues` is not specified, or if its value is `NONE`, then nothing is returned. (This setting is the default for `ReturnValues`.)
+ `ALL_OLD` - The content of the old item is returned.
There is no additional cost associated with requesting a return value aside from the small network and processing overhead of receiving a larger response. No read capacity units are consumed.
The `ReturnValues` parameter is used by several DynamoDB operations; however, `DeleteItem` does not recognize any values other than `NONE` or `ALL_OLD`.
Type: String
Valid Values: `NONE | ALL_OLD | UPDATED_OLD | ALL_NEW | UPDATED_NEW`
Required: No
** [ReturnValuesOnConditionCheckFailure](#API_DeleteItem_RequestSyntax) **
An optional parameter that returns the item attributes for a `DeleteItem` operation that failed a condition check.
There is no additional cost associated with requesting a return value aside from the small network and processing overhead of receiving a larger response. No read capacity units are consumed.
Type: String
Valid Values: `ALL_OLD | NONE`
Required: No
## Response Syntax
```
{
"Attributes": {
"string" : {
"B": blob,
"BOOL": boolean,
"BS": [ blob ],
"L": [
"AttributeValue"
],
"M": {
"string" : "AttributeValue"
},
"N": "string",
"NS": [ "string" ],
"NULL": boolean,
"S": "string",
"SS": [ "string" ]
}
},
"ConsumedCapacity": {
"CapacityUnits": number,
"GlobalSecondaryIndexes": {
"string" : {
"CapacityUnits": number,
"ReadCapacityUnits": number,
"WriteCapacityUnits": number
}
},
"LocalSecondaryIndexes": {
"string" : {
"CapacityUnits": number,
"ReadCapacityUnits": number,
"WriteCapacityUnits": number
}
},
"ReadCapacityUnits": number,
"Table": {
"CapacityUnits": number,
"ReadCapacityUnits": number,
"WriteCapacityUnits": number
},
"TableName": "string",
"WriteCapacityUnits": number
},
"ItemCollectionMetrics": {
"ItemCollectionKey": {
"string" : {
"B": blob,
"BOOL": boolean,
"BS": [ blob ],
"L": [
"AttributeValue"
],
"M": {
"string" : "AttributeValue"
},
"N": "string",
"NS": [ "string" ],
"NULL": boolean,
"S": "string",
"SS": [ "string" ]
}
},
"SizeEstimateRangeGB": [ number ]
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [Attributes](#API_DeleteItem_ResponseSyntax) **
A map of attribute names to `AttributeValue` objects, representing the item as it appeared before the `DeleteItem` operation. This map appears in the response only if `ReturnValues` was specified as `ALL_OLD` in the request.
Type: String to [AttributeValue](API_AttributeValue.md) object map
Key Length Constraints: Maximum length of 65535.
** [ConsumedCapacity](#API_DeleteItem_ResponseSyntax) **
The capacity units consumed by the `DeleteItem` operation. The data returned includes the total provisioned throughput consumed, along with statistics for the table and any indexes involved in the operation. `ConsumedCapacity` is only returned if the `ReturnConsumedCapacity` parameter was specified. For more information, see [Provisioned capacity mode](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/provisioned-capacity-mode.html) in the *Amazon DynamoDB Developer Guide*.
Type: [ConsumedCapacity](API_ConsumedCapacity.md) object
** [ItemCollectionMetrics](#API_DeleteItem_ResponseSyntax) **
Information about item collections, if any, that were affected by the `DeleteItem` operation. `ItemCollectionMetrics` is only returned if the `ReturnItemCollectionMetrics` parameter was specified. If the table does not have any local secondary indexes, this information is not returned in the response.
Each `ItemCollectionMetrics` element consists of:
+ `ItemCollectionKey` - The partition key value of the item collection. This is the same as the partition key value of the item itself.
+ `SizeEstimateRangeGB` - An estimate of item collection size, in gigabytes. This value is a two-element array containing a lower bound and an upper bound for the estimate. The estimate includes the size of all the items in the table, plus the size of all attributes projected into all of the local secondary indexes on that table. Use this estimate to measure whether a local secondary index is approaching its size limit.
The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate.
Type: [ItemCollectionMetrics](API_ItemCollectionMetrics.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** ConditionalCheckFailedException **
A condition specified in the operation failed to be evaluated.
** Item **
Item which caused the `ConditionalCheckFailedException`.
** message **
The conditional request failed.
HTTP Status Code: 400
** InternalServerError **
An error occurred on the server side.
** message **
The server encountered an internal error trying to fulfill the request.
HTTP Status Code: 500
** ItemCollectionSizeLimitExceededException **
An item collection is too large. This exception is only returned for tables that have one or more local secondary indexes.
** message **
The total size of an item collection has exceeded the maximum limit of 10 gigabytes.
HTTP Status Code: 400
** ProvisionedThroughputExceededException **
The request was denied due to request throttling. For detailed information about why the request was throttled and the ARN of the impacted resource, find the [ThrottlingReason](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_ThrottlingReason.html) field in the returned exception. The AWS SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to [Error Retries and Exponential Backoff](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Programming.Errors.html#Programming.Errors.RetryAndBackoff) in the *Amazon DynamoDB Developer Guide*.
** message **
You exceeded your maximum allowed provisioned throughput.
** ThrottlingReasons **
A list of [ThrottlingReason](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_ThrottlingReason.html) that provide detailed diagnostic information about why the request was throttled.
HTTP Status Code: 400
** ReplicatedWriteConflictException **
The request was rejected because one or more items in the request are being modified by a request in another Region.
HTTP Status Code: 400
** RequestLimitExceeded **
Throughput exceeds the current throughput quota for your account. For detailed information about why the request was throttled and the ARN of the impacted resource, find the [ThrottlingReason](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_ThrottlingReason.html) field in the returned exception. Contact [Support](https://aws.amazon.com/support) to request a quota increase.
** ThrottlingReasons **
A list of [ThrottlingReason](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_ThrottlingReason.html) that provide detailed diagnostic information about why the request was throttled.
HTTP Status Code: 400
** ResourceNotFoundException **
The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be `ACTIVE`.
** message **
The resource which is being requested does not exist.
HTTP Status Code: 400
** ThrottlingException **
The request was denied due to request throttling. For detailed information about why the request was throttled and the ARN of the impacted resource, find the [ThrottlingReason](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_ThrottlingReason.html) field in the returned exception.
** throttlingReasons **
A list of [ThrottlingReason](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_ThrottlingReason.html) that provide detailed diagnostic information about why the request was throttled.
HTTP Status Code: 400
** TransactionConflictException **
Operation was rejected because there is an ongoing transaction for the item.
HTTP Status Code: 400
## Examples
### Delete an Item
The following example deletes an item from the `Thread` table, but only if that item does not already have an attribute named `Replies`. Because `ReturnValues` is set to `ALL_OLD`, the response contains the item as it appeared before the delete.
#### Sample Request
```
POST / HTTP/1.1
Host: dynamodb..;
Accept-Encoding: identity
Content-Length:
User-Agent:
Content-Type: application/x-amz-json-1.0
Authorization: AWS4-HMAC-SHA256 Credential=, SignedHeaders=, Signature=
X-Amz-Date:
X-Amz-Target: DynamoDB_20120810.DeleteItem
{
"TableName": "Thread",
"Key": {
"ForumName": {
"S": "Amazon DynamoDB"
},
"Subject": {
"S": "How do I update multiple items?"
}
},
"ConditionExpression": "attribute_not_exists(Replies)",
"ReturnValues": "ALL_OLD"
}
```
#### Sample Response
```
HTTP/1.1 200 OK
x-amzn-RequestId:
x-amz-crc32:
Content-Type: application/x-amz-json-1.0
Content-Length:
Date:
{
"Attributes": {
"LastPostedBy": {
"S": "fred@example.com"
},
"ForumName": {
"S": "Amazon DynamoDB"
},
"LastPostDateTime": {
"S": "201303201023"
},
"Tags": {
"SS": ["Update","Multiple Items","HelpMe"]
},
"Subject": {
"S": "How do I update multiple items?"
},
"Message": {
"S": "I want to update multiple items in a single call. What's the best way to do that?"
}
}
}
```
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/dynamodb-2012-08-10/DeleteItem)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/dynamodb-2012-08-10/DeleteItem)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/DeleteItem)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/dynamodb-2012-08-10/DeleteItem)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/DeleteItem)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/dynamodb-2012-08-10/DeleteItem)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/dynamodb-2012-08-10/DeleteItem)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/dynamodb-2012-08-10/DeleteItem)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/dynamodb-2012-08-10/DeleteItem)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/DeleteItem)
# DeleteResourcePolicy
Deletes the resource-based policy attached to the resource, which can be a table or stream.
`DeleteResourcePolicy` is an idempotent operation; running it multiple times on the same resource *doesn't* result in an error response, unless you specify an `ExpectedRevisionId`, which will then return a `PolicyNotFoundException`.
**Important**
To make sure that you don't inadvertently lock yourself out of your own resources, the root principal in your AWS account can perform `DeleteResourcePolicy` requests, even if your resource-based policy explicitly denies the root principal's access.
**Note**
`DeleteResourcePolicy` is an asynchronous operation. If you issue a `GetResourcePolicy` request immediately after running the `DeleteResourcePolicy` request, DynamoDB might still return the deleted policy. This is because the policy for your resource might not have been deleted yet. Wait for a few seconds, and then try the `GetResourcePolicy` request again.
## Request Syntax
```
{
"ExpectedRevisionId": "string",
"ResourceArn": "string"
}
```
## Request Parameters
The request accepts the following data in JSON format.
**Note**
In the following list, the required parameters are described first.
** [ResourceArn](#API_DeleteResourcePolicy_RequestSyntax) **
The Amazon Resource Name (ARN) of the DynamoDB resource from which the policy will be removed. The resources you can specify include tables and streams. If you remove the policy of a table, it will also remove the permissions for the table's indexes defined in that policy document. This is because index permissions are defined in the table's policy.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1283.
Required: Yes
** [ExpectedRevisionId](#API_DeleteResourcePolicy_RequestSyntax) **
A string value that you can use to conditionally delete your policy. When you provide an expected revision ID, if the revision ID of the existing policy on the resource doesn't match or if there's no policy attached to the resource, the request will fail and return a `PolicyNotFoundException`.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Required: No
## Response Syntax
```
{
"RevisionId": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [RevisionId](#API_DeleteResourcePolicy_ResponseSyntax) **
A unique string that represents the revision ID of the policy. If you're comparing revision IDs, make sure to always use string comparison logic.
This value will be empty if you make a request against a resource without a policy.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalServerError **
An error occurred on the server side.
** message **
The server encountered an internal error trying to fulfill the request.
HTTP Status Code: 500
** LimitExceededException **
There is no limit to the number of daily on-demand backups that can be taken.
For most purposes, up to 500 simultaneous table operations are allowed per account. These operations include `CreateTable`, `UpdateTable`, `DeleteTable`,`UpdateTimeToLive`, `RestoreTableFromBackup`, and `RestoreTableToPointInTime`.
When you are creating a table with one or more secondary indexes, you can have up to 250 such requests running at a time. However, if the table or index specifications are complex, then DynamoDB might temporarily reduce the number of concurrent operations.
When importing into DynamoDB, up to 50 simultaneous import table operations are allowed per account.
There is a soft account quota of 2,500 tables.
GetRecords was called with a value of more than 1000 for the limit request parameter.
More than 2 processes are reading from the same streams shard at the same time. Exceeding this limit may result in request throttling.
** message **
Too many operations for a given subscriber.
HTTP Status Code: 400
** PolicyNotFoundException **
The operation tried to access a nonexistent resource-based policy.
If you specified an `ExpectedRevisionId`, it's possible that a policy is present for the resource but its revision ID didn't match the expected value.
HTTP Status Code: 400
** ResourceInUseException **
The operation conflicts with the resource's availability. For example:
+ You attempted to recreate an existing table.
+ You tried to delete a table currently in the `CREATING` state.
+ You tried to update a resource that was already being updated.
When appropriate, wait for the ongoing update to complete and attempt the request again.
** message **
The resource which is being attempted to be changed is in use.
HTTP Status Code: 400
** ResourceNotFoundException **
The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be `ACTIVE`.
** message **
The resource which is being requested does not exist.
HTTP Status Code: 400
## Examples
### Delete the resource-based policy of a table
The following example deletes the resource-based policy of a table named `Thread`.
#### Sample Request
```
POST / HTTP/1.1
Host: dynamodb..;
Accept-Encoding: identity
Content-Length:
User-Agent:
Content-Type: application/x-amz-json-1.0
Authorization: AWS4-HMAC-SHA256 Credential=, SignedHeaders=, Signature=
X-Amz-Date:
X-Amz-Target: DynamoDB_20120810.DeleteResourcePolicy
{
"ResourceArn": "arn:aws:dynamodb:us-west-2:123456789012:table/Thread"
}
```
#### Sample Response
```
HTTP/1.1 200 OK
x-amzn-RequestId:
x-amz-crc32:
Content-Type: application/x-amz-json-1.0
Content-Length:
Date:
{
"RevisionId": "1683717331354"
}
```
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/dynamodb-2012-08-10/DeleteResourcePolicy)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/dynamodb-2012-08-10/DeleteResourcePolicy)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/DeleteResourcePolicy)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/dynamodb-2012-08-10/DeleteResourcePolicy)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/DeleteResourcePolicy)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/dynamodb-2012-08-10/DeleteResourcePolicy)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/dynamodb-2012-08-10/DeleteResourcePolicy)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/dynamodb-2012-08-10/DeleteResourcePolicy)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/dynamodb-2012-08-10/DeleteResourcePolicy)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/DeleteResourcePolicy)
# DeleteTable
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.
**Note**
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. For the full list of table states, see [TableStatus](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_TableDescription.html#DDB-Type-TableDescription-TableStatus).
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 Syntax
```
{
"TableName": "string"
}
```
## Request Parameters
The request accepts the following data in JSON format.
**Note**
In the following list, the required parameters are described first.
** [TableName](#API_DeleteTable_RequestSyntax) **
The name of the table to delete. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: Yes
## Response Syntax
```
{
"TableDescription": {
"ArchivalSummary": {
"ArchivalBackupArn": "string",
"ArchivalDateTime": number,
"ArchivalReason": "string"
},
"AttributeDefinitions": [
{
"AttributeName": "string",
"AttributeType": "string"
}
],
"BillingModeSummary": {
"BillingMode": "string",
"LastUpdateToPayPerRequestDateTime": number
},
"CreationDateTime": number,
"DeletionProtectionEnabled": boolean,
"GlobalSecondaryIndexes": [
{
"Backfilling": boolean,
"IndexArn": "string",
"IndexName": "string",
"IndexSizeBytes": number,
"IndexStatus": "string",
"ItemCount": number,
"KeySchema": [
{
"AttributeName": "string",
"KeyType": "string"
}
],
"OnDemandThroughput": {
"MaxReadRequestUnits": number,
"MaxWriteRequestUnits": number
},
"Projection": {
"NonKeyAttributes": [ "string" ],
"ProjectionType": "string"
},
"ProvisionedThroughput": {
"LastDecreaseDateTime": number,
"LastIncreaseDateTime": number,
"NumberOfDecreasesToday": number,
"ReadCapacityUnits": number,
"WriteCapacityUnits": number
},
"WarmThroughput": {
"ReadUnitsPerSecond": number,
"Status": "string",
"WriteUnitsPerSecond": number
}
}
],
"GlobalTableSettingsReplicationMode": "string",
"GlobalTableVersion": "string",
"GlobalTableWitnesses": [
{
"RegionName": "string",
"WitnessStatus": "string"
}
],
"ItemCount": number,
"KeySchema": [
{
"AttributeName": "string",
"KeyType": "string"
}
],
"LatestStreamArn": "string",
"LatestStreamLabel": "string",
"LocalSecondaryIndexes": [
{
"IndexArn": "string",
"IndexName": "string",
"IndexSizeBytes": number,
"ItemCount": number,
"KeySchema": [
{
"AttributeName": "string",
"KeyType": "string"
}
],
"Projection": {
"NonKeyAttributes": [ "string" ],
"ProjectionType": "string"
}
}
],
"MultiRegionConsistency": "string",
"OnDemandThroughput": {
"MaxReadRequestUnits": number,
"MaxWriteRequestUnits": number
},
"ProvisionedThroughput": {
"LastDecreaseDateTime": number,
"LastIncreaseDateTime": number,
"NumberOfDecreasesToday": number,
"ReadCapacityUnits": number,
"WriteCapacityUnits": number
},
"Replicas": [
{
"GlobalSecondaryIndexes": [
{
"IndexName": "string",
"OnDemandThroughputOverride": {
"MaxReadRequestUnits": number
},
"ProvisionedThroughputOverride": {
"ReadCapacityUnits": number
},
"WarmThroughput": {
"ReadUnitsPerSecond": number,
"Status": "string",
"WriteUnitsPerSecond": number
}
}
],
"GlobalTableSettingsReplicationMode": "string",
"KMSMasterKeyId": "string",
"OnDemandThroughputOverride": {
"MaxReadRequestUnits": number
},
"ProvisionedThroughputOverride": {
"ReadCapacityUnits": number
},
"RegionName": "string",
"ReplicaArn": "string",
"ReplicaInaccessibleDateTime": number,
"ReplicaStatus": "string",
"ReplicaStatusDescription": "string",
"ReplicaStatusPercentProgress": "string",
"ReplicaTableClassSummary": {
"LastUpdateDateTime": number,
"TableClass": "string"
},
"WarmThroughput": {
"ReadUnitsPerSecond": number,
"Status": "string",
"WriteUnitsPerSecond": number
}
}
],
"RestoreSummary": {
"RestoreDateTime": number,
"RestoreInProgress": boolean,
"SourceBackupArn": "string",
"SourceTableArn": "string"
},
"SSEDescription": {
"InaccessibleEncryptionDateTime": number,
"KMSMasterKeyArn": "string",
"SSEType": "string",
"Status": "string"
},
"StreamSpecification": {
"StreamEnabled": boolean,
"StreamViewType": "string"
},
"TableArn": "string",
"TableClassSummary": {
"LastUpdateDateTime": number,
"TableClass": "string"
},
"TableId": "string",
"TableName": "string",
"TableSizeBytes": number,
"TableStatus": "string",
"WarmThroughput": {
"ReadUnitsPerSecond": number,
"Status": "string",
"WriteUnitsPerSecond": number
}
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [TableDescription](#API_DeleteTable_ResponseSyntax) **
Represents the properties of a table.
Type: [TableDescription](API_TableDescription.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalServerError **
An error occurred on the server side.
** message **
The server encountered an internal error trying to fulfill the request.
HTTP Status Code: 500
** LimitExceededException **
There is no limit to the number of daily on-demand backups that can be taken.
For most purposes, up to 500 simultaneous table operations are allowed per account. These operations include `CreateTable`, `UpdateTable`, `DeleteTable`,`UpdateTimeToLive`, `RestoreTableFromBackup`, and `RestoreTableToPointInTime`.
When you are creating a table with one or more secondary indexes, you can have up to 250 such requests running at a time. However, if the table or index specifications are complex, then DynamoDB might temporarily reduce the number of concurrent operations.
When importing into DynamoDB, up to 50 simultaneous import table operations are allowed per account.
There is a soft account quota of 2,500 tables.
GetRecords was called with a value of more than 1000 for the limit request parameter.
More than 2 processes are reading from the same streams shard at the same time. Exceeding this limit may result in request throttling.
** message **
Too many operations for a given subscriber.
HTTP Status Code: 400
** ResourceInUseException **
The operation conflicts with the resource's availability. For example:
+ You attempted to recreate an existing table.
+ You tried to delete a table currently in the `CREATING` state.
+ You tried to update a resource that was already being updated.
When appropriate, wait for the ongoing update to complete and attempt the request again.
** message **
The resource which is being attempted to be changed is in use.
HTTP Status Code: 400
** ResourceNotFoundException **
The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be `ACTIVE`.
** message **
The resource which is being requested does not exist.
HTTP Status Code: 400
## Examples
### Delete a Table
This example deletes the Reply table.
#### Sample Request
```
POST / HTTP/1.1
Host: dynamodb..;
Accept-Encoding: identity
Content-Length:
User-Agent:
Content-Type: application/x-amz-json-1.0
Authorization: AWS4-HMAC-SHA256 Credential=, SignedHeaders=, Signature=
X-Amz-Date:
X-Amz-Target: DynamoDB_20120810.DeleteTable
{
"TableName": "Reply"
}
```
#### Sample Response
```
HTTP/1.1 200 OK
x-amzn-RequestId:
x-amz-crc32:
Content-Type: application/x-amz-json-1.0
Content-Length:
Date:
{
"TableDescription": {
"TableArn": "arn:aws:dynamodb:us-west-2:123456789012:table/Reply",
"ItemCount": 0,
"ProvisionedThroughput": {
"NumberOfDecreasesToday": 0,
"ReadCapacityUnits": 5,
"WriteCapacityUnits": 5
},
"TableName": "Reply",
"TableSizeBytes": 0,
"TableStatus": "DELETING"
}
}
```
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/dynamodb-2012-08-10/DeleteTable)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/dynamodb-2012-08-10/DeleteTable)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/DeleteTable)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/dynamodb-2012-08-10/DeleteTable)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/DeleteTable)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/dynamodb-2012-08-10/DeleteTable)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/dynamodb-2012-08-10/DeleteTable)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/dynamodb-2012-08-10/DeleteTable)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/dynamodb-2012-08-10/DeleteTable)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/DeleteTable)
# DescribeBackup
Describes an existing backup of a table.
You can call `DescribeBackup` at a maximum rate of 10 times per second.
## Request Syntax
```
{
"BackupArn": "string"
}
```
## Request Parameters
The request accepts the following data in JSON format.
**Note**
In the following list, the required parameters are described first.
** [BackupArn](#API_DescribeBackup_RequestSyntax) **
The Amazon Resource Name (ARN) associated with the backup.
Type: String
Length Constraints: Minimum length of 37. Maximum length of 1024.
Required: Yes
## Response Syntax
```
{
"BackupDescription": {
"BackupDetails": {
"BackupArn": "string",
"BackupCreationDateTime": number,
"BackupExpiryDateTime": number,
"BackupName": "string",
"BackupSizeBytes": number,
"BackupStatus": "string",
"BackupType": "string"
},
"SourceTableDetails": {
"BillingMode": "string",
"ItemCount": number,
"KeySchema": [
{
"AttributeName": "string",
"KeyType": "string"
}
],
"OnDemandThroughput": {
"MaxReadRequestUnits": number,
"MaxWriteRequestUnits": number
},
"ProvisionedThroughput": {
"ReadCapacityUnits": number,
"WriteCapacityUnits": number
},
"TableArn": "string",
"TableCreationDateTime": number,
"TableId": "string",
"TableName": "string",
"TableSizeBytes": number
},
"SourceTableFeatureDetails": {
"GlobalSecondaryIndexes": [
{
"IndexName": "string",
"KeySchema": [
{
"AttributeName": "string",
"KeyType": "string"
}
],
"OnDemandThroughput": {
"MaxReadRequestUnits": number,
"MaxWriteRequestUnits": number
},
"Projection": {
"NonKeyAttributes": [ "string" ],
"ProjectionType": "string"
},
"ProvisionedThroughput": {
"ReadCapacityUnits": number,
"WriteCapacityUnits": number
}
}
],
"LocalSecondaryIndexes": [
{
"IndexName": "string",
"KeySchema": [
{
"AttributeName": "string",
"KeyType": "string"
}
],
"Projection": {
"NonKeyAttributes": [ "string" ],
"ProjectionType": "string"
}
}
],
"SSEDescription": {
"InaccessibleEncryptionDateTime": number,
"KMSMasterKeyArn": "string",
"SSEType": "string",
"Status": "string"
},
"StreamDescription": {
"StreamEnabled": boolean,
"StreamViewType": "string"
},
"TimeToLiveDescription": {
"AttributeName": "string",
"TimeToLiveStatus": "string"
}
}
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [BackupDescription](#API_DescribeBackup_ResponseSyntax) **
Contains the description of the backup created for the table.
Type: [BackupDescription](API_BackupDescription.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** BackupNotFoundException **
Backup not found for the given BackupARN.
HTTP Status Code: 400
** InternalServerError **
An error occurred on the server side.
** message **
The server encountered an internal error trying to fulfill the request.
HTTP Status Code: 500
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/dynamodb-2012-08-10/DescribeBackup)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/dynamodb-2012-08-10/DescribeBackup)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/DescribeBackup)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/dynamodb-2012-08-10/DescribeBackup)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/DescribeBackup)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/dynamodb-2012-08-10/DescribeBackup)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/dynamodb-2012-08-10/DescribeBackup)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/dynamodb-2012-08-10/DescribeBackup)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/dynamodb-2012-08-10/DescribeBackup)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/DescribeBackup)
# DescribeContinuousBackups
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 in the last 35 days. You can set the recovery period to any value between 1 and 35 days.
You can call `DescribeContinuousBackups` at a maximum rate of 10 times per second.
## Request Syntax
```
{
"TableName": "string"
}
```
## Request Parameters
The request accepts the following data in JSON format.
**Note**
In the following list, the required parameters are described first.
** [TableName](#API_DescribeContinuousBackups_RequestSyntax) **
Name of the table for which the customer wants to check the continuous backups and point in time recovery settings.
You can also provide the Amazon Resource Name (ARN) of the table in this parameter.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: Yes
## Response Syntax
```
{
"ContinuousBackupsDescription": {
"ContinuousBackupsStatus": "string",
"PointInTimeRecoveryDescription": {
"EarliestRestorableDateTime": number,
"LatestRestorableDateTime": number,
"PointInTimeRecoveryStatus": "string",
"RecoveryPeriodInDays": number
}
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [ContinuousBackupsDescription](#API_DescribeContinuousBackups_ResponseSyntax) **
Represents the continuous backups and point in time recovery settings on the table.
Type: [ContinuousBackupsDescription](API_ContinuousBackupsDescription.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalServerError **
An error occurred on the server side.
** message **
The server encountered an internal error trying to fulfill the request.
HTTP Status Code: 500
** TableNotFoundException **
A source table with the name `TableName` does not currently exist within the subscriber's account or the subscriber is operating in the wrong AWS Region.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/dynamodb-2012-08-10/DescribeContinuousBackups)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/dynamodb-2012-08-10/DescribeContinuousBackups)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/DescribeContinuousBackups)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/dynamodb-2012-08-10/DescribeContinuousBackups)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/DescribeContinuousBackups)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/dynamodb-2012-08-10/DescribeContinuousBackups)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/dynamodb-2012-08-10/DescribeContinuousBackups)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/dynamodb-2012-08-10/DescribeContinuousBackups)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/dynamodb-2012-08-10/DescribeContinuousBackups)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/DescribeContinuousBackups)
# DescribeContributorInsights
Returns information about contributor insights for a given table or global secondary index.
## Request Syntax
```
{
"IndexName": "string",
"TableName": "string"
}
```
## Request Parameters
The request accepts the following data in JSON format.
**Note**
In the following list, the required parameters are described first.
** [TableName](#API_DescribeContributorInsights_RequestSyntax) **
The name of the table to describe. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: Yes
** [IndexName](#API_DescribeContributorInsights_RequestSyntax) **
The name of the global secondary index to describe, if applicable.
Type: String
Length Constraints: Minimum length of 3. Maximum length of 255.
Pattern: `[a-zA-Z0-9_.-]+`
Required: No
## Response Syntax
```
{
"ContributorInsightsMode": "string",
"ContributorInsightsRuleList": [ "string" ],
"ContributorInsightsStatus": "string",
"FailureException": {
"ExceptionDescription": "string",
"ExceptionName": "string"
},
"IndexName": "string",
"LastUpdateDateTime": number,
"TableName": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [ContributorInsightsMode](#API_DescribeContributorInsights_ResponseSyntax) **
The mode of CloudWatch Contributor Insights for DynamoDB that determines which events are emitted. Can be set to track all access and throttled events or throttled events only.
Type: String
Valid Values: `ACCESSED_AND_THROTTLED_KEYS | THROTTLED_KEYS`
** [ContributorInsightsRuleList](#API_DescribeContributorInsights_ResponseSyntax) **
List of names of the associated contributor insights rules.
Type: Array of strings
Pattern: `[A-Za-z0-9][A-Za-z0-9\-\_\.]{0,126}[A-Za-z0-9]`
** [ContributorInsightsStatus](#API_DescribeContributorInsights_ResponseSyntax) **
Current status of contributor insights.
Type: String
Valid Values: `ENABLING | ENABLED | DISABLING | DISABLED | FAILED`
** [FailureException](#API_DescribeContributorInsights_ResponseSyntax) **
Returns information about the last failure that was encountered.
The most common exceptions for a FAILED status are:
+ LimitExceededException - Per-account Amazon CloudWatch Contributor Insights rule limit reached. Please disable Contributor Insights for other tables/indexes OR disable Contributor Insights rules before retrying.
+ AccessDeniedException - Amazon CloudWatch Contributor Insights rules cannot be modified due to insufficient permissions.
+ AccessDeniedException - Failed to create service-linked role for Contributor Insights due to insufficient permissions.
+ InternalServerError - Failed to create Amazon CloudWatch Contributor Insights rules. Please retry request.
Type: [FailureException](API_FailureException.md) object
** [IndexName](#API_DescribeContributorInsights_ResponseSyntax) **
The name of the global secondary index being described.
Type: String
Length Constraints: Minimum length of 3. Maximum length of 255.
Pattern: `[a-zA-Z0-9_.-]+`
** [LastUpdateDateTime](#API_DescribeContributorInsights_ResponseSyntax) **
Timestamp of the last time the status was changed.
Type: Timestamp
** [TableName](#API_DescribeContributorInsights_ResponseSyntax) **
The name of the table being described.
Type: String
Length Constraints: Minimum length of 3. Maximum length of 255.
Pattern: `[a-zA-Z0-9_.-]+`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalServerError **
An error occurred on the server side.
** message **
The server encountered an internal error trying to fulfill the request.
HTTP Status Code: 500
** ResourceNotFoundException **
The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be `ACTIVE`.
** message **
The resource which is being requested does not exist.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/dynamodb-2012-08-10/DescribeContributorInsights)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/dynamodb-2012-08-10/DescribeContributorInsights)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/DescribeContributorInsights)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/dynamodb-2012-08-10/DescribeContributorInsights)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/DescribeContributorInsights)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/dynamodb-2012-08-10/DescribeContributorInsights)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/dynamodb-2012-08-10/DescribeContributorInsights)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/dynamodb-2012-08-10/DescribeContributorInsights)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/dynamodb-2012-08-10/DescribeContributorInsights)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/DescribeContributorInsights)
# DescribeEndpoints
Returns the regional endpoint information. For more information on policy permissions, please see [Internetwork traffic privacy](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/inter-network-traffic-privacy.html#inter-network-traffic-DescribeEndpoints).
## Response Syntax
```
{
"Endpoints": [
{
"Address": "string",
"CachePeriodInMinutes": number
}
]
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [Endpoints](#API_DescribeEndpoints_ResponseSyntax) **
List of endpoints.
Type: Array of [Endpoint](API_Endpoint.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/dynamodb-2012-08-10/DescribeEndpoints)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/dynamodb-2012-08-10/DescribeEndpoints)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/DescribeEndpoints)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/dynamodb-2012-08-10/DescribeEndpoints)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/DescribeEndpoints)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/dynamodb-2012-08-10/DescribeEndpoints)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/dynamodb-2012-08-10/DescribeEndpoints)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/dynamodb-2012-08-10/DescribeEndpoints)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/dynamodb-2012-08-10/DescribeEndpoints)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/DescribeEndpoints)
# DescribeExport
Describes an existing table export.
## Request Syntax
```
{
"ExportArn": "string"
}
```
## Request Parameters
The request accepts the following data in JSON format.
**Note**
In the following list, the required parameters are described first.
** [ExportArn](#API_DescribeExport_RequestSyntax) **
The Amazon Resource Name (ARN) associated with the export.
Type: String
Length Constraints: Minimum length of 37. Maximum length of 1024.
Required: Yes
## Response Syntax
```
{
"ExportDescription": {
"BilledSizeBytes": number,
"ClientToken": "string",
"EndTime": number,
"ExportArn": "string",
"ExportFormat": "string",
"ExportManifest": "string",
"ExportStatus": "string",
"ExportTime": number,
"ExportType": "string",
"FailureCode": "string",
"FailureMessage": "string",
"IncrementalExportSpecification": {
"ExportFromTime": number,
"ExportToTime": number,
"ExportViewType": "string"
},
"ItemCount": number,
"S3Bucket": "string",
"S3BucketOwner": "string",
"S3Prefix": "string",
"S3SseAlgorithm": "string",
"S3SseKmsKeyId": "string",
"StartTime": number,
"TableArn": "string",
"TableId": "string"
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [ExportDescription](#API_DescribeExport_ResponseSyntax) **
Represents the properties of the export.
Type: [ExportDescription](API_ExportDescription.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** ExportNotFoundException **
The specified export was not found.
HTTP Status Code: 400
** InternalServerError **
An error occurred on the server side.
** message **
The server encountered an internal error trying to fulfill the request.
HTTP Status Code: 500
** LimitExceededException **
There is no limit to the number of daily on-demand backups that can be taken.
For most purposes, up to 500 simultaneous table operations are allowed per account. These operations include `CreateTable`, `UpdateTable`, `DeleteTable`,`UpdateTimeToLive`, `RestoreTableFromBackup`, and `RestoreTableToPointInTime`.
When you are creating a table with one or more secondary indexes, you can have up to 250 such requests running at a time. However, if the table or index specifications are complex, then DynamoDB might temporarily reduce the number of concurrent operations.
When importing into DynamoDB, up to 50 simultaneous import table operations are allowed per account.
There is a soft account quota of 2,500 tables.
GetRecords was called with a value of more than 1000 for the limit request parameter.
More than 2 processes are reading from the same streams shard at the same time. Exceeding this limit may result in request throttling.
** message **
Too many operations for a given subscriber.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/dynamodb-2012-08-10/DescribeExport)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/dynamodb-2012-08-10/DescribeExport)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/DescribeExport)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/dynamodb-2012-08-10/DescribeExport)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/DescribeExport)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/dynamodb-2012-08-10/DescribeExport)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/dynamodb-2012-08-10/DescribeExport)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/dynamodb-2012-08-10/DescribeExport)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/dynamodb-2012-08-10/DescribeExport)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/DescribeExport)
# DescribeGlobalTable
Returns information about the specified global table.
**Important**
This documentation is for version 2017.11.29 (Legacy) of global tables, which should be avoided for new global tables. Customers should use [Global Tables version 2019.11.21 (Current)](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/GlobalTables.html) when possible, because it provides greater flexibility, higher efficiency, and consumes less write capacity than 2017.11.29 (Legacy).
To determine which version you're using, see [Determining the global table version you are using](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.DetermineVersion.html). To update existing global tables from version 2017.11.29 (Legacy) to version 2019.11.21 (Current), see [Upgrading global tables](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/V2globaltables_upgrade.html).
## Request Syntax
```
{
"GlobalTableName": "string"
}
```
## Request Parameters
The request accepts the following data in JSON format.
**Note**
In the following list, the required parameters are described first.
** [GlobalTableName](#API_DescribeGlobalTable_RequestSyntax) **
The name of the global table.
Type: String
Length Constraints: Minimum length of 3. Maximum length of 255.
Pattern: `[a-zA-Z0-9_.-]+`
Required: Yes
## Response Syntax
```
{
"GlobalTableDescription": {
"CreationDateTime": number,
"GlobalTableArn": "string",
"GlobalTableName": "string",
"GlobalTableStatus": "string",
"ReplicationGroup": [
{
"GlobalSecondaryIndexes": [
{
"IndexName": "string",
"OnDemandThroughputOverride": {
"MaxReadRequestUnits": number
},
"ProvisionedThroughputOverride": {
"ReadCapacityUnits": number
},
"WarmThroughput": {
"ReadUnitsPerSecond": number,
"Status": "string",
"WriteUnitsPerSecond": number
}
}
],
"GlobalTableSettingsReplicationMode": "string",
"KMSMasterKeyId": "string",
"OnDemandThroughputOverride": {
"MaxReadRequestUnits": number
},
"ProvisionedThroughputOverride": {
"ReadCapacityUnits": number
},
"RegionName": "string",
"ReplicaArn": "string",
"ReplicaInaccessibleDateTime": number,
"ReplicaStatus": "string",
"ReplicaStatusDescription": "string",
"ReplicaStatusPercentProgress": "string",
"ReplicaTableClassSummary": {
"LastUpdateDateTime": number,
"TableClass": "string"
},
"WarmThroughput": {
"ReadUnitsPerSecond": number,
"Status": "string",
"WriteUnitsPerSecond": number
}
}
]
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [GlobalTableDescription](#API_DescribeGlobalTable_ResponseSyntax) **
Contains the details of the global table.
Type: [GlobalTableDescription](API_GlobalTableDescription.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** GlobalTableNotFoundException **
The specified global table does not exist.
HTTP Status Code: 400
** InternalServerError **
An error occurred on the server side.
** message **
The server encountered an internal error trying to fulfill the request.
HTTP Status Code: 500
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/dynamodb-2012-08-10/DescribeGlobalTable)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/dynamodb-2012-08-10/DescribeGlobalTable)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/DescribeGlobalTable)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/dynamodb-2012-08-10/DescribeGlobalTable)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/DescribeGlobalTable)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/dynamodb-2012-08-10/DescribeGlobalTable)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/dynamodb-2012-08-10/DescribeGlobalTable)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/dynamodb-2012-08-10/DescribeGlobalTable)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/dynamodb-2012-08-10/DescribeGlobalTable)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/DescribeGlobalTable)
# DescribeGlobalTableSettings
Describes Region-specific settings for a global table.
**Important**
This documentation is for version 2017.11.29 (Legacy) of global tables, which should be avoided for new global tables. Customers should use [Global Tables version 2019.11.21 (Current)](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/GlobalTables.html) when possible, because it provides greater flexibility, higher efficiency, and consumes less write capacity than 2017.11.29 (Legacy).
To determine which version you're using, see [Determining the global table version you are using](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.DetermineVersion.html). To update existing global tables from version 2017.11.29 (Legacy) to version 2019.11.21 (Current), see [Upgrading global tables](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/V2globaltables_upgrade.html).
## Request Syntax
```
{
"GlobalTableName": "string"
}
```
## Request Parameters
The request accepts the following data in JSON format.
**Note**
In the following list, the required parameters are described first.
** [GlobalTableName](#API_DescribeGlobalTableSettings_RequestSyntax) **
The name of the global table to describe.
Type: String
Length Constraints: Minimum length of 3. Maximum length of 255.
Pattern: `[a-zA-Z0-9_.-]+`
Required: Yes
## Response Syntax
```
{
"GlobalTableName": "string",
"ReplicaSettings": [
{
"RegionName": "string",
"ReplicaBillingModeSummary": {
"BillingMode": "string",
"LastUpdateToPayPerRequestDateTime": number
},
"ReplicaGlobalSecondaryIndexSettings": [
{
"IndexName": "string",
"IndexStatus": "string",
"ProvisionedReadCapacityAutoScalingSettings": {
"AutoScalingDisabled": boolean,
"AutoScalingRoleArn": "string",
"MaximumUnits": number,
"MinimumUnits": number,
"ScalingPolicies": [
{
"PolicyName": "string",
"TargetTrackingScalingPolicyConfiguration": {
"DisableScaleIn": boolean,
"ScaleInCooldown": number,
"ScaleOutCooldown": number,
"TargetValue": number
}
}
]
},
"ProvisionedReadCapacityUnits": number,
"ProvisionedWriteCapacityAutoScalingSettings": {
"AutoScalingDisabled": boolean,
"AutoScalingRoleArn": "string",
"MaximumUnits": number,
"MinimumUnits": number,
"ScalingPolicies": [
{
"PolicyName": "string",
"TargetTrackingScalingPolicyConfiguration": {
"DisableScaleIn": boolean,
"ScaleInCooldown": number,
"ScaleOutCooldown": number,
"TargetValue": number
}
}
]
},
"ProvisionedWriteCapacityUnits": number
}
],
"ReplicaProvisionedReadCapacityAutoScalingSettings": {
"AutoScalingDisabled": boolean,
"AutoScalingRoleArn": "string",
"MaximumUnits": number,
"MinimumUnits": number,
"ScalingPolicies": [
{
"PolicyName": "string",
"TargetTrackingScalingPolicyConfiguration": {
"DisableScaleIn": boolean,
"ScaleInCooldown": number,
"ScaleOutCooldown": number,
"TargetValue": number
}
}
]
},
"ReplicaProvisionedReadCapacityUnits": number,
"ReplicaProvisionedWriteCapacityAutoScalingSettings": {
"AutoScalingDisabled": boolean,
"AutoScalingRoleArn": "string",
"MaximumUnits": number,
"MinimumUnits": number,
"ScalingPolicies": [
{
"PolicyName": "string",
"TargetTrackingScalingPolicyConfiguration": {
"DisableScaleIn": boolean,
"ScaleInCooldown": number,
"ScaleOutCooldown": number,
"TargetValue": number
}
}
]
},
"ReplicaProvisionedWriteCapacityUnits": number,
"ReplicaStatus": "string",
"ReplicaTableClassSummary": {
"LastUpdateDateTime": number,
"TableClass": "string"
}
}
]
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [GlobalTableName](#API_DescribeGlobalTableSettings_ResponseSyntax) **
The name of the global table.
Type: String
Length Constraints: Minimum length of 3. Maximum length of 255.
Pattern: `[a-zA-Z0-9_.-]+`
** [ReplicaSettings](#API_DescribeGlobalTableSettings_ResponseSyntax) **
The Region-specific settings for the global table.
Type: Array of [ReplicaSettingsDescription](API_ReplicaSettingsDescription.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** GlobalTableNotFoundException **
The specified global table does not exist.
HTTP Status Code: 400
** InternalServerError **
An error occurred on the server side.
** message **
The server encountered an internal error trying to fulfill the request.
HTTP Status Code: 500
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/dynamodb-2012-08-10/DescribeGlobalTableSettings)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/dynamodb-2012-08-10/DescribeGlobalTableSettings)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/DescribeGlobalTableSettings)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/dynamodb-2012-08-10/DescribeGlobalTableSettings)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/DescribeGlobalTableSettings)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/dynamodb-2012-08-10/DescribeGlobalTableSettings)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/dynamodb-2012-08-10/DescribeGlobalTableSettings)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/dynamodb-2012-08-10/DescribeGlobalTableSettings)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/dynamodb-2012-08-10/DescribeGlobalTableSettings)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/DescribeGlobalTableSettings)
# DescribeImport
Represents the properties of the import.
## Request Syntax
```
{
"ImportArn": "string"
}
```
## Request Parameters
The request accepts the following data in JSON format.
**Note**
In the following list, the required parameters are described first.
** [ImportArn](#API_DescribeImport_RequestSyntax) **
The Amazon Resource Name (ARN) associated with the table you're importing to.
Type: String
Length Constraints: Minimum length of 37. Maximum length of 1024.
Required: Yes
## Response Syntax
```
{
"ImportTableDescription": {
"ClientToken": "string",
"CloudWatchLogGroupArn": "string",
"EndTime": number,
"ErrorCount": number,
"FailureCode": "string",
"FailureMessage": "string",
"ImportArn": "string",
"ImportedItemCount": number,
"ImportStatus": "string",
"InputCompressionType": "string",
"InputFormat": "string",
"InputFormatOptions": {
"Csv": {
"Delimiter": "string",
"HeaderList": [ "string" ]
}
},
"ProcessedItemCount": number,
"ProcessedSizeBytes": number,
"S3BucketSource": {
"S3Bucket": "string",
"S3BucketOwner": "string",
"S3KeyPrefix": "string"
},
"StartTime": number,
"TableArn": "string",
"TableCreationParameters": {
"AttributeDefinitions": [
{
"AttributeName": "string",
"AttributeType": "string"
}
],
"BillingMode": "string",
"GlobalSecondaryIndexes": [
{
"IndexName": "string",
"KeySchema": [
{
"AttributeName": "string",
"KeyType": "string"
}
],
"OnDemandThroughput": {
"MaxReadRequestUnits": number,
"MaxWriteRequestUnits": number
},
"Projection": {
"NonKeyAttributes": [ "string" ],
"ProjectionType": "string"
},
"ProvisionedThroughput": {
"ReadCapacityUnits": number,
"WriteCapacityUnits": number
},
"WarmThroughput": {
"ReadUnitsPerSecond": number,
"WriteUnitsPerSecond": number
}
}
],
"KeySchema": [
{
"AttributeName": "string",
"KeyType": "string"
}
],
"OnDemandThroughput": {
"MaxReadRequestUnits": number,
"MaxWriteRequestUnits": number
},
"ProvisionedThroughput": {
"ReadCapacityUnits": number,
"WriteCapacityUnits": number
},
"SSESpecification": {
"Enabled": boolean,
"KMSMasterKeyId": "string",
"SSEType": "string"
},
"TableName": "string"
},
"TableId": "string"
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [ImportTableDescription](#API_DescribeImport_ResponseSyntax) **
Represents the properties of the table created for the import, and parameters of the import. The import parameters include import status, how many items were processed, and how many errors were encountered.
Type: [ImportTableDescription](API_ImportTableDescription.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** ImportNotFoundException **
The specified import was not found.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/dynamodb-2012-08-10/DescribeImport)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/dynamodb-2012-08-10/DescribeImport)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/DescribeImport)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/dynamodb-2012-08-10/DescribeImport)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/DescribeImport)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/dynamodb-2012-08-10/DescribeImport)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/dynamodb-2012-08-10/DescribeImport)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/dynamodb-2012-08-10/DescribeImport)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/dynamodb-2012-08-10/DescribeImport)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/DescribeImport)
# DescribeKinesisStreamingDestination
Returns information about the status of Kinesis streaming.
## Request Syntax
```
{
"TableName": "string"
}
```
## Request Parameters
The request accepts the following data in JSON format.
**Note**
In the following list, the required parameters are described first.
** [TableName](#API_DescribeKinesisStreamingDestination_RequestSyntax) **
The name of the table being described. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: Yes
## Response Syntax
```
{
"KinesisDataStreamDestinations": [
{
"ApproximateCreationDateTimePrecision": "string",
"DestinationStatus": "string",
"DestinationStatusDescription": "string",
"StreamArn": "string"
}
],
"TableName": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [KinesisDataStreamDestinations](#API_DescribeKinesisStreamingDestination_ResponseSyntax) **
The list of replica structures for the table being described.
Type: Array of [KinesisDataStreamDestination](API_KinesisDataStreamDestination.md) objects
** [TableName](#API_DescribeKinesisStreamingDestination_ResponseSyntax) **
The name of the table being described.
Type: String
Length Constraints: Minimum length of 3. Maximum length of 255.
Pattern: `[a-zA-Z0-9_.-]+`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalServerError **
An error occurred on the server side.
** message **
The server encountered an internal error trying to fulfill the request.
HTTP Status Code: 500
** ResourceNotFoundException **
The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be `ACTIVE`.
** message **
The resource which is being requested does not exist.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/dynamodb-2012-08-10/DescribeKinesisStreamingDestination)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/dynamodb-2012-08-10/DescribeKinesisStreamingDestination)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/DescribeKinesisStreamingDestination)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/dynamodb-2012-08-10/DescribeKinesisStreamingDestination)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/DescribeKinesisStreamingDestination)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/dynamodb-2012-08-10/DescribeKinesisStreamingDestination)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/dynamodb-2012-08-10/DescribeKinesisStreamingDestination)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/dynamodb-2012-08-10/DescribeKinesisStreamingDestination)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/dynamodb-2012-08-10/DescribeKinesisStreamingDestination)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/DescribeKinesisStreamingDestination)
# DescribeLimits
Returns the current provisioned-capacity quotas 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 quotas 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 quotas that apply when you create a table there. For more information, see [Service, Account, and Table Quotas](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html) page in the *Amazon DynamoDB Developer Guide*.
Although you can increase these quotas by filing a case at [AWS Support Center](https://console.aws.amazon.com/support/home#/), obtaining the increase is not instantaneous. The `DescribeLimits` action lets you write code to compare the capacity you are currently using to those quotas imposed by your account so that you have enough time to apply for an increase before you hit a quota.
For example, you could use one of the AWS SDKs to do the following:
1. Call `DescribeLimits` for a particular Region to obtain your current account quotas on provisioned capacity there.
1. 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.
1. Call `ListTables` to obtain a list of all your DynamoDB tables.
1. For each table name listed by `ListTables`, do the following:
+ Call `DescribeTable` with the table name.
+ Use the data returned by `DescribeTable` to 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.
1. Report the account quotas 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 quotas.
The per-table quotas 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 quota that applies is that the aggregate provisioned capacity over all your tables and GSIs cannot exceed either of the per-account quotas.
**Note**
`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.
## Response Syntax
```
{
"AccountMaxReadCapacityUnits": number,
"AccountMaxWriteCapacityUnits": number,
"TableMaxReadCapacityUnits": number,
"TableMaxWriteCapacityUnits": number
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [AccountMaxReadCapacityUnits](#API_DescribeLimits_ResponseSyntax) **
The maximum total read capacity units that your account allows you to provision across all of your tables in this Region.
Type: Long
Valid Range: Minimum value of 1.
** [AccountMaxWriteCapacityUnits](#API_DescribeLimits_ResponseSyntax) **
The maximum total write capacity units that your account allows you to provision across all of your tables in this Region.
Type: Long
Valid Range: Minimum value of 1.
** [TableMaxReadCapacityUnits](#API_DescribeLimits_ResponseSyntax) **
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).
Type: Long
Valid Range: Minimum value of 1.
** [TableMaxWriteCapacityUnits](#API_DescribeLimits_ResponseSyntax) **
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).
Type: Long
Valid Range: Minimum value of 1.
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalServerError **
An error occurred on the server side.
** message **
The server encountered an internal error trying to fulfill the request.
HTTP Status Code: 500
## Examples
### DescribeLimits
This example illustrates one usage of DescribeLimits.
#### Sample Request
```
POST / HTTP/1.1
Host: dynamodb..;
Accept-Encoding: identity
Content-Length:
User-Agent:
Content-Type: application/x-amz-json-1.0
Authorization: AWS4-HMAC-SHA256 Credential=, SignedHeaders=, Signature=
X-Amz-Date:
X-Amz-Target: DynamoDB_20120810.DescribeLimits
{ }
```
#### Sample Response
```
HTTP/1.1 200 OK
x-amzn-RequestId:
x-amz-crc32:
Content-Type: application/x-amz-json-1.0
Content-Length:
Date:
{
"AccountMaxReadCapacityUnits": 20000,
"AccountMaxWriteCapacityUnits": 20000,
"TableMaxReadCapacityUnits": 10000,
"TableMaxWriteCapacityUnits": 10000
}
```
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/dynamodb-2012-08-10/DescribeLimits)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/dynamodb-2012-08-10/DescribeLimits)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/DescribeLimits)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/dynamodb-2012-08-10/DescribeLimits)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/DescribeLimits)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/dynamodb-2012-08-10/DescribeLimits)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/dynamodb-2012-08-10/DescribeLimits)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/dynamodb-2012-08-10/DescribeLimits)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/dynamodb-2012-08-10/DescribeLimits)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/DescribeLimits)
# DescribeTable
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.
**Note**
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 Syntax
```
{
"TableName": "string"
}
```
## Request Parameters
The request accepts the following data in JSON format.
**Note**
In the following list, the required parameters are described first.
** [TableName](#API_DescribeTable_RequestSyntax) **
The name of the table to describe. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: Yes
## Response Syntax
```
{
"Table": {
"ArchivalSummary": {
"ArchivalBackupArn": "string",
"ArchivalDateTime": number,
"ArchivalReason": "string"
},
"AttributeDefinitions": [
{
"AttributeName": "string",
"AttributeType": "string"
}
],
"BillingModeSummary": {
"BillingMode": "string",
"LastUpdateToPayPerRequestDateTime": number
},
"CreationDateTime": number,
"DeletionProtectionEnabled": boolean,
"GlobalSecondaryIndexes": [
{
"Backfilling": boolean,
"IndexArn": "string",
"IndexName": "string",
"IndexSizeBytes": number,
"IndexStatus": "string",
"ItemCount": number,
"KeySchema": [
{
"AttributeName": "string",
"KeyType": "string"
}
],
"OnDemandThroughput": {
"MaxReadRequestUnits": number,
"MaxWriteRequestUnits": number
},
"Projection": {
"NonKeyAttributes": [ "string" ],
"ProjectionType": "string"
},
"ProvisionedThroughput": {
"LastDecreaseDateTime": number,
"LastIncreaseDateTime": number,
"NumberOfDecreasesToday": number,
"ReadCapacityUnits": number,
"WriteCapacityUnits": number
},
"WarmThroughput": {
"ReadUnitsPerSecond": number,
"Status": "string",
"WriteUnitsPerSecond": number
}
}
],
"GlobalTableSettingsReplicationMode": "string",
"GlobalTableVersion": "string",
"GlobalTableWitnesses": [
{
"RegionName": "string",
"WitnessStatus": "string"
}
],
"ItemCount": number,
"KeySchema": [
{
"AttributeName": "string",
"KeyType": "string"
}
],
"LatestStreamArn": "string",
"LatestStreamLabel": "string",
"LocalSecondaryIndexes": [
{
"IndexArn": "string",
"IndexName": "string",
"IndexSizeBytes": number,
"ItemCount": number,
"KeySchema": [
{
"AttributeName": "string",
"KeyType": "string"
}
],
"Projection": {
"NonKeyAttributes": [ "string" ],
"ProjectionType": "string"
}
}
],
"MultiRegionConsistency": "string",
"OnDemandThroughput": {
"MaxReadRequestUnits": number,
"MaxWriteRequestUnits": number
},
"ProvisionedThroughput": {
"LastDecreaseDateTime": number,
"LastIncreaseDateTime": number,
"NumberOfDecreasesToday": number,
"ReadCapacityUnits": number,
"WriteCapacityUnits": number
},
"Replicas": [
{
"GlobalSecondaryIndexes": [
{
"IndexName": "string",
"OnDemandThroughputOverride": {
"MaxReadRequestUnits": number
},
"ProvisionedThroughputOverride": {
"ReadCapacityUnits": number
},
"WarmThroughput": {
"ReadUnitsPerSecond": number,
"Status": "string",
"WriteUnitsPerSecond": number
}
}
],
"GlobalTableSettingsReplicationMode": "string",
"KMSMasterKeyId": "string",
"OnDemandThroughputOverride": {
"MaxReadRequestUnits": number
},
"ProvisionedThroughputOverride": {
"ReadCapacityUnits": number
},
"RegionName": "string",
"ReplicaArn": "string",
"ReplicaInaccessibleDateTime": number,
"ReplicaStatus": "string",
"ReplicaStatusDescription": "string",
"ReplicaStatusPercentProgress": "string",
"ReplicaTableClassSummary": {
"LastUpdateDateTime": number,
"TableClass": "string"
},
"WarmThroughput": {
"ReadUnitsPerSecond": number,
"Status": "string",
"WriteUnitsPerSecond": number
}
}
],
"RestoreSummary": {
"RestoreDateTime": number,
"RestoreInProgress": boolean,
"SourceBackupArn": "string",
"SourceTableArn": "string"
},
"SSEDescription": {
"InaccessibleEncryptionDateTime": number,
"KMSMasterKeyArn": "string",
"SSEType": "string",
"Status": "string"
},
"StreamSpecification": {
"StreamEnabled": boolean,
"StreamViewType": "string"
},
"TableArn": "string",
"TableClassSummary": {
"LastUpdateDateTime": number,
"TableClass": "string"
},
"TableId": "string",
"TableName": "string",
"TableSizeBytes": number,
"TableStatus": "string",
"WarmThroughput": {
"ReadUnitsPerSecond": number,
"Status": "string",
"WriteUnitsPerSecond": number
}
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [Table](#API_DescribeTable_ResponseSyntax) **
The properties of the table.
Type: [TableDescription](API_TableDescription.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalServerError **
An error occurred on the server side.
** message **
The server encountered an internal error trying to fulfill the request.
HTTP Status Code: 500
** ResourceNotFoundException **
The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be `ACTIVE`.
** message **
The resource which is being requested does not exist.
HTTP Status Code: 400
## Examples
### Describe a Table
This example describes the `Thread` table.
#### Sample Request
```
POST / HTTP/1.1
Host: dynamodb..;
Accept-Encoding: identity
Content-Length:
User-Agent:
Content-Type: application/x-amz-json-1.0
Authorization: AWS4-HMAC-SHA256 Credential=, SignedHeaders=, Signature=
X-Amz-Date:
X-Amz-Target: DynamoDB_20120810.DescribeTable
{
"TableName":"Thread"
}
```
#### Sample Response
```
HTTP/1.1 200 OK
x-amzn-RequestId:
x-amz-crc32:
Content-Type: application/x-amz-json-1.0
Content-Length:
Date:
{
"Table": {
"TableArn": "arn:aws:dynamodb:us-west-2:123456789012:table/Thread",
"AttributeDefinitions": [
{
"AttributeName": "ForumName",
"AttributeType": "S"
},
{
"AttributeName": "LastPostDateTime",
"AttributeType": "S"
},
{
"AttributeName": "Subject",
"AttributeType": "S"
}
],
"CreationDateTime": 1.363729002358E9,
"ItemCount": 0,
"KeySchema": [
{
"AttributeName": "ForumName",
"KeyType": "HASH"
},
{
"AttributeName": "Subject",
"KeyType": "RANGE"
}
],
"LocalSecondaryIndexes": [
{
"IndexArn": "arn:aws:dynamodb:us-west-2:123456789012:table/Thread/index/LastPostIndex",
"IndexName": "LastPostIndex",
"IndexSizeBytes": 0,
"ItemCount": 0,
"KeySchema": [
{
"AttributeName": "ForumName",
"KeyType": "HASH"
},
{
"AttributeName": "LastPostDateTime",
"KeyType": "RANGE"
}
],
"Projection": {
"ProjectionType": "KEYS_ONLY"
}
}
],
"ProvisionedThroughput": {
"NumberOfDecreasesToday": 0,
"ReadCapacityUnits": 5,
"WriteCapacityUnits": 5
},
"TableName": "Thread",
"TableSizeBytes": 0,
"TableStatus": "ACTIVE"
}
}
```
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/dynamodb-2012-08-10/DescribeTable)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/dynamodb-2012-08-10/DescribeTable)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/DescribeTable)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/dynamodb-2012-08-10/DescribeTable)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/DescribeTable)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/dynamodb-2012-08-10/DescribeTable)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/dynamodb-2012-08-10/DescribeTable)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/dynamodb-2012-08-10/DescribeTable)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/dynamodb-2012-08-10/DescribeTable)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/DescribeTable)
# DescribeTableReplicaAutoScaling
Describes auto scaling settings across replicas of the global table at once.
## Request Syntax
```
{
"TableName": "string"
}
```
## Request Parameters
The request accepts the following data in JSON format.
**Note**
In the following list, the required parameters are described first.
** [TableName](#API_DescribeTableReplicaAutoScaling_RequestSyntax) **
The name of the table. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: Yes
## Response Syntax
```
{
"TableAutoScalingDescription": {
"Replicas": [
{
"GlobalSecondaryIndexes": [
{
"IndexName": "string",
"IndexStatus": "string",
"ProvisionedReadCapacityAutoScalingSettings": {
"AutoScalingDisabled": boolean,
"AutoScalingRoleArn": "string",
"MaximumUnits": number,
"MinimumUnits": number,
"ScalingPolicies": [
{
"PolicyName": "string",
"TargetTrackingScalingPolicyConfiguration": {
"DisableScaleIn": boolean,
"ScaleInCooldown": number,
"ScaleOutCooldown": number,
"TargetValue": number
}
}
]
},
"ProvisionedWriteCapacityAutoScalingSettings": {
"AutoScalingDisabled": boolean,
"AutoScalingRoleArn": "string",
"MaximumUnits": number,
"MinimumUnits": number,
"ScalingPolicies": [
{
"PolicyName": "string",
"TargetTrackingScalingPolicyConfiguration": {
"DisableScaleIn": boolean,
"ScaleInCooldown": number,
"ScaleOutCooldown": number,
"TargetValue": number
}
}
]
}
}
],
"RegionName": "string",
"ReplicaProvisionedReadCapacityAutoScalingSettings": {
"AutoScalingDisabled": boolean,
"AutoScalingRoleArn": "string",
"MaximumUnits": number,
"MinimumUnits": number,
"ScalingPolicies": [
{
"PolicyName": "string",
"TargetTrackingScalingPolicyConfiguration": {
"DisableScaleIn": boolean,
"ScaleInCooldown": number,
"ScaleOutCooldown": number,
"TargetValue": number
}
}
]
},
"ReplicaProvisionedWriteCapacityAutoScalingSettings": {
"AutoScalingDisabled": boolean,
"AutoScalingRoleArn": "string",
"MaximumUnits": number,
"MinimumUnits": number,
"ScalingPolicies": [
{
"PolicyName": "string",
"TargetTrackingScalingPolicyConfiguration": {
"DisableScaleIn": boolean,
"ScaleInCooldown": number,
"ScaleOutCooldown": number,
"TargetValue": number
}
}
]
},
"ReplicaStatus": "string"
}
],
"TableName": "string",
"TableStatus": "string"
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [TableAutoScalingDescription](#API_DescribeTableReplicaAutoScaling_ResponseSyntax) **
Represents the auto scaling properties of the table.
Type: [TableAutoScalingDescription](API_TableAutoScalingDescription.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalServerError **
An error occurred on the server side.
** message **
The server encountered an internal error trying to fulfill the request.
HTTP Status Code: 500
** ResourceNotFoundException **
The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be `ACTIVE`.
** message **
The resource which is being requested does not exist.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/dynamodb-2012-08-10/DescribeTableReplicaAutoScaling)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/dynamodb-2012-08-10/DescribeTableReplicaAutoScaling)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/DescribeTableReplicaAutoScaling)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/dynamodb-2012-08-10/DescribeTableReplicaAutoScaling)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/DescribeTableReplicaAutoScaling)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/dynamodb-2012-08-10/DescribeTableReplicaAutoScaling)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/dynamodb-2012-08-10/DescribeTableReplicaAutoScaling)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/dynamodb-2012-08-10/DescribeTableReplicaAutoScaling)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/dynamodb-2012-08-10/DescribeTableReplicaAutoScaling)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/DescribeTableReplicaAutoScaling)
# DescribeTimeToLive
Gives a description of the Time to Live (TTL) status on the specified table.
## Request Syntax
```
{
"TableName": "string"
}
```
## Request Parameters
The request accepts the following data in JSON format.
**Note**
In the following list, the required parameters are described first.
** [TableName](#API_DescribeTimeToLive_RequestSyntax) **
The name of the table to be described. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: Yes
## Response Syntax
```
{
"TimeToLiveDescription": {
"AttributeName": "string",
"TimeToLiveStatus": "string"
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [TimeToLiveDescription](#API_DescribeTimeToLive_ResponseSyntax) **
Type: [TimeToLiveDescription](API_TimeToLiveDescription.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalServerError **
An error occurred on the server side.
** message **
The server encountered an internal error trying to fulfill the request.
HTTP Status Code: 500
** ResourceNotFoundException **
The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be `ACTIVE`.
** message **
The resource which is being requested does not exist.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/dynamodb-2012-08-10/DescribeTimeToLive)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/dynamodb-2012-08-10/DescribeTimeToLive)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/DescribeTimeToLive)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/dynamodb-2012-08-10/DescribeTimeToLive)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/DescribeTimeToLive)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/dynamodb-2012-08-10/DescribeTimeToLive)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/dynamodb-2012-08-10/DescribeTimeToLive)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/dynamodb-2012-08-10/DescribeTimeToLive)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/dynamodb-2012-08-10/DescribeTimeToLive)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/DescribeTimeToLive)
# DisableKinesisStreamingDestination
Stops replication from the DynamoDB table to the Kinesis data stream. This is done without deleting either of the resources.
## Request Syntax
```
{
"EnableKinesisStreamingConfiguration": {
"ApproximateCreationDateTimePrecision": "string"
},
"StreamArn": "string",
"TableName": "string"
}
```
## Request Parameters
The request accepts the following data in JSON format.
**Note**
In the following list, the required parameters are described first.
** [StreamArn](#API_DisableKinesisStreamingDestination_RequestSyntax) **
The ARN for a Kinesis data stream.
Type: String
Length Constraints: Minimum length of 37. Maximum length of 1024.
Required: Yes
** [TableName](#API_DisableKinesisStreamingDestination_RequestSyntax) **
The name of the DynamoDB table. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: Yes
** [EnableKinesisStreamingConfiguration](#API_DisableKinesisStreamingDestination_RequestSyntax) **
The source for the Kinesis streaming information that is being enabled.
Type: [EnableKinesisStreamingConfiguration](API_EnableKinesisStreamingConfiguration.md) object
Required: No
## Response Syntax
```
{
"DestinationStatus": "string",
"EnableKinesisStreamingConfiguration": {
"ApproximateCreationDateTimePrecision": "string"
},
"StreamArn": "string",
"TableName": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [DestinationStatus](#API_DisableKinesisStreamingDestination_ResponseSyntax) **
The current status of the replication.
Type: String
Valid Values: `ENABLING | ACTIVE | DISABLING | DISABLED | ENABLE_FAILED | UPDATING`
** [EnableKinesisStreamingConfiguration](#API_DisableKinesisStreamingDestination_ResponseSyntax) **
The destination for the Kinesis streaming information that is being enabled.
Type: [EnableKinesisStreamingConfiguration](API_EnableKinesisStreamingConfiguration.md) object
** [StreamArn](#API_DisableKinesisStreamingDestination_ResponseSyntax) **
The ARN for the specific Kinesis data stream.
Type: String
Length Constraints: Minimum length of 37. Maximum length of 1024.
** [TableName](#API_DisableKinesisStreamingDestination_ResponseSyntax) **
The name of the table being modified.
Type: String
Length Constraints: Minimum length of 3. Maximum length of 255.
Pattern: `[a-zA-Z0-9_.-]+`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalServerError **
An error occurred on the server side.
** message **
The server encountered an internal error trying to fulfill the request.
HTTP Status Code: 500
** LimitExceededException **
There is no limit to the number of daily on-demand backups that can be taken.
For most purposes, up to 500 simultaneous table operations are allowed per account. These operations include `CreateTable`, `UpdateTable`, `DeleteTable`,`UpdateTimeToLive`, `RestoreTableFromBackup`, and `RestoreTableToPointInTime`.
When you are creating a table with one or more secondary indexes, you can have up to 250 such requests running at a time. However, if the table or index specifications are complex, then DynamoDB might temporarily reduce the number of concurrent operations.
When importing into DynamoDB, up to 50 simultaneous import table operations are allowed per account.
There is a soft account quota of 2,500 tables.
GetRecords was called with a value of more than 1000 for the limit request parameter.
More than 2 processes are reading from the same streams shard at the same time. Exceeding this limit may result in request throttling.
** message **
Too many operations for a given subscriber.
HTTP Status Code: 400
** ResourceInUseException **
The operation conflicts with the resource's availability. For example:
+ You attempted to recreate an existing table.
+ You tried to delete a table currently in the `CREATING` state.
+ You tried to update a resource that was already being updated.
When appropriate, wait for the ongoing update to complete and attempt the request again.
** message **
The resource which is being attempted to be changed is in use.
HTTP Status Code: 400
** ResourceNotFoundException **
The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be `ACTIVE`.
** message **
The resource which is being requested does not exist.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/dynamodb-2012-08-10/DisableKinesisStreamingDestination)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/dynamodb-2012-08-10/DisableKinesisStreamingDestination)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/DisableKinesisStreamingDestination)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/dynamodb-2012-08-10/DisableKinesisStreamingDestination)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/DisableKinesisStreamingDestination)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/dynamodb-2012-08-10/DisableKinesisStreamingDestination)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/dynamodb-2012-08-10/DisableKinesisStreamingDestination)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/dynamodb-2012-08-10/DisableKinesisStreamingDestination)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/dynamodb-2012-08-10/DisableKinesisStreamingDestination)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/DisableKinesisStreamingDestination)
# EnableKinesisStreamingDestination
Starts table data replication to the specified Kinesis data stream at a timestamp chosen during the enable workflow. If this operation doesn't return results immediately, use DescribeKinesisStreamingDestination to check if streaming to the Kinesis data stream is ACTIVE.
## Request Syntax
```
{
"EnableKinesisStreamingConfiguration": {
"ApproximateCreationDateTimePrecision": "string"
},
"StreamArn": "string",
"TableName": "string"
}
```
## Request Parameters
The request accepts the following data in JSON format.
**Note**
In the following list, the required parameters are described first.
** [StreamArn](#API_EnableKinesisStreamingDestination_RequestSyntax) **
The ARN for a Kinesis data stream.
Type: String
Length Constraints: Minimum length of 37. Maximum length of 1024.
Required: Yes
** [TableName](#API_EnableKinesisStreamingDestination_RequestSyntax) **
The name of the DynamoDB table. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: Yes
** [EnableKinesisStreamingConfiguration](#API_EnableKinesisStreamingDestination_RequestSyntax) **
The source for the Kinesis streaming information that is being enabled.
Type: [EnableKinesisStreamingConfiguration](API_EnableKinesisStreamingConfiguration.md) object
Required: No
## Response Syntax
```
{
"DestinationStatus": "string",
"EnableKinesisStreamingConfiguration": {
"ApproximateCreationDateTimePrecision": "string"
},
"StreamArn": "string",
"TableName": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [DestinationStatus](#API_EnableKinesisStreamingDestination_ResponseSyntax) **
The current status of the replication.
Type: String
Valid Values: `ENABLING | ACTIVE | DISABLING | DISABLED | ENABLE_FAILED | UPDATING`
** [EnableKinesisStreamingConfiguration](#API_EnableKinesisStreamingDestination_ResponseSyntax) **
The destination for the Kinesis streaming information that is being enabled.
Type: [EnableKinesisStreamingConfiguration](API_EnableKinesisStreamingConfiguration.md) object
** [StreamArn](#API_EnableKinesisStreamingDestination_ResponseSyntax) **
The ARN for the specific Kinesis data stream.
Type: String
Length Constraints: Minimum length of 37. Maximum length of 1024.
** [TableName](#API_EnableKinesisStreamingDestination_ResponseSyntax) **
The name of the table being modified.
Type: String
Length Constraints: Minimum length of 3. Maximum length of 255.
Pattern: `[a-zA-Z0-9_.-]+`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalServerError **
An error occurred on the server side.
** message **
The server encountered an internal error trying to fulfill the request.
HTTP Status Code: 500
** LimitExceededException **
There is no limit to the number of daily on-demand backups that can be taken.
For most purposes, up to 500 simultaneous table operations are allowed per account. These operations include `CreateTable`, `UpdateTable`, `DeleteTable`,`UpdateTimeToLive`, `RestoreTableFromBackup`, and `RestoreTableToPointInTime`.
When you are creating a table with one or more secondary indexes, you can have up to 250 such requests running at a time. However, if the table or index specifications are complex, then DynamoDB might temporarily reduce the number of concurrent operations.
When importing into DynamoDB, up to 50 simultaneous import table operations are allowed per account.
There is a soft account quota of 2,500 tables.
GetRecords was called with a value of more than 1000 for the limit request parameter.
More than 2 processes are reading from the same streams shard at the same time. Exceeding this limit may result in request throttling.
** message **
Too many operations for a given subscriber.
HTTP Status Code: 400
** ResourceInUseException **
The operation conflicts with the resource's availability. For example:
+ You attempted to recreate an existing table.
+ You tried to delete a table currently in the `CREATING` state.
+ You tried to update a resource that was already being updated.
When appropriate, wait for the ongoing update to complete and attempt the request again.
** message **
The resource which is being attempted to be changed is in use.
HTTP Status Code: 400
** ResourceNotFoundException **
The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be `ACTIVE`.
** message **
The resource which is being requested does not exist.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/dynamodb-2012-08-10/EnableKinesisStreamingDestination)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/dynamodb-2012-08-10/EnableKinesisStreamingDestination)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/EnableKinesisStreamingDestination)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/dynamodb-2012-08-10/EnableKinesisStreamingDestination)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/EnableKinesisStreamingDestination)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/dynamodb-2012-08-10/EnableKinesisStreamingDestination)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/dynamodb-2012-08-10/EnableKinesisStreamingDestination)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/dynamodb-2012-08-10/EnableKinesisStreamingDestination)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/dynamodb-2012-08-10/EnableKinesisStreamingDestination)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/EnableKinesisStreamingDestination)
# ExecuteStatement
This operation allows you to perform reads and singleton writes on data stored in DynamoDB, using PartiQL.
For PartiQL reads (`SELECT` statement), if the total number of processed items exceeds the maximum dataset size limit of 1 MB, the read stops and results are returned to the user as a `LastEvaluatedKey` value to continue the read in a subsequent operation. If the filter criteria in `WHERE` clause does not match any data, the read will return an empty result set.
A single `SELECT` statement response can return up to the maximum number of items (if using the Limit parameter) or a maximum of 1 MB of data (and then apply any filtering to the results using `WHERE` clause). If `LastEvaluatedKey` is present in the response, you need to paginate the result set. If `NextToken` is present, you need to paginate the result set and include `NextToken`.
## Request Syntax
```
{
"ConsistentRead": boolean,
"Limit": number,
"NextToken": "string",
"Parameters": [
{
"B": blob,
"BOOL": boolean,
"BS": [ blob ],
"L": [
"AttributeValue"
],
"M": {
"string" : "AttributeValue"
},
"N": "string",
"NS": [ "string" ],
"NULL": boolean,
"S": "string",
"SS": [ "string" ]
}
],
"ReturnConsumedCapacity": "string",
"ReturnValuesOnConditionCheckFailure": "string",
"Statement": "string"
}
```
## Request Parameters
The request accepts the following data in JSON format.
**Note**
In the following list, the required parameters are described first.
** [Statement](#API_ExecuteStatement_RequestSyntax) **
The PartiQL statement representing the operation to run.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 8192.
Required: Yes
** [ConsistentRead](#API_ExecuteStatement_RequestSyntax) **
The consistency of a read operation. If set to `true`, then a strongly consistent read is used; otherwise, an eventually consistent read is used.
Type: Boolean
Required: No
** [Limit](#API_ExecuteStatement_RequestSyntax) **
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, along with a key in `LastEvaluatedKey` to apply in a subsequent operation so you can pick up where you left off. Also, if the processed dataset size exceeds 1 MB before DynamoDB reaches this limit, it stops the operation and returns the matching values up to the limit, and a key in `LastEvaluatedKey` to apply in a subsequent operation to continue the operation.
Type: Integer
Valid Range: Minimum value of 1.
Required: No
** [NextToken](#API_ExecuteStatement_RequestSyntax) **
Set this value to get remaining results, if `NextToken` was returned in the statement response.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 32768.
Required: No
** [Parameters](#API_ExecuteStatement_RequestSyntax) **
The parameters for the PartiQL statement, if any.
Type: Array of [AttributeValue](API_AttributeValue.md) objects
Array Members: Minimum number of 1 item.
Required: No
** [ReturnConsumedCapacity](#API_ExecuteStatement_RequestSyntax) **
Determines the level of detail about either provisioned or on-demand throughput consumption that is returned in the response:
+ `INDEXES` - The response includes the aggregate `ConsumedCapacity` for the operation, together with `ConsumedCapacity` for each table and secondary index that was accessed.
Note that some operations, such as `GetItem` and `BatchGetItem`, do not access any indexes at all. In these cases, specifying `INDEXES` will only return `ConsumedCapacity` information for table(s).
+ `TOTAL` - The response includes only the aggregate `ConsumedCapacity` for the operation.
+ `NONE` - No `ConsumedCapacity` details are included in the response.
Type: String
Valid Values: `INDEXES | TOTAL | NONE`
Required: No
** [ReturnValuesOnConditionCheckFailure](#API_ExecuteStatement_RequestSyntax) **
An optional parameter that returns the item attributes for an `ExecuteStatement` operation that failed a condition check.
There is no additional cost associated with requesting a return value aside from the small network and processing overhead of receiving a larger response. No read capacity units are consumed.
Type: String
Valid Values: `ALL_OLD | NONE`
Required: No
## Response Syntax
```
{
"ConsumedCapacity": {
"CapacityUnits": number,
"GlobalSecondaryIndexes": {
"string" : {
"CapacityUnits": number,
"ReadCapacityUnits": number,
"WriteCapacityUnits": number
}
},
"LocalSecondaryIndexes": {
"string" : {
"CapacityUnits": number,
"ReadCapacityUnits": number,
"WriteCapacityUnits": number
}
},
"ReadCapacityUnits": number,
"Table": {
"CapacityUnits": number,
"ReadCapacityUnits": number,
"WriteCapacityUnits": number
},
"TableName": "string",
"WriteCapacityUnits": number
},
"Items": [
{
"string" : {
"B": blob,
"BOOL": boolean,
"BS": [ blob ],
"L": [
"AttributeValue"
],
"M": {
"string" : "AttributeValue"
},
"N": "string",
"NS": [ "string" ],
"NULL": boolean,
"S": "string",
"SS": [ "string" ]
}
}
],
"LastEvaluatedKey": {
"string" : {
"B": blob,
"BOOL": boolean,
"BS": [ blob ],
"L": [
"AttributeValue"
],
"M": {
"string" : "AttributeValue"
},
"N": "string",
"NS": [ "string" ],
"NULL": boolean,
"S": "string",
"SS": [ "string" ]
}
},
"NextToken": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [ConsumedCapacity](#API_ExecuteStatement_ResponseSyntax) **
The capacity units consumed by an operation. The data returned includes the total provisioned throughput consumed, along with statistics for the table and any indexes involved in the operation. `ConsumedCapacity` is only returned if the request asked for it. For more information, see [Provisioned capacity mode](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/provisioned-capacity-mode.html) in the *Amazon DynamoDB Developer Guide*.
Type: [ConsumedCapacity](API_ConsumedCapacity.md) object
** [Items](#API_ExecuteStatement_ResponseSyntax) **
If a read operation was used, this property will contain the result of the read operation; a map of attribute names and their values. For the write operations this value will be empty.
Type: Array of string to [AttributeValue](API_AttributeValue.md) object maps
Key Length Constraints: Maximum length of 65535.
** [LastEvaluatedKey](#API_ExecuteStatement_ResponseSyntax) **
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 `LastEvaluatedKey` is empty, then the "last page" of results has been processed and there is no more data to be retrieved. If `LastEvaluatedKey` is not empty, it does not necessarily mean that there is more data in the result set. The only way to know when you have reached the end of the result set is when `LastEvaluatedKey` is empty.
Type: String to [AttributeValue](API_AttributeValue.md) object map
Key Length Constraints: Maximum length of 65535.
** [NextToken](#API_ExecuteStatement_ResponseSyntax) **
If the response of a read request exceeds the response payload limit DynamoDB will set this value in the response. If set, you can use that this value in the subsequent request to get the remaining results.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 32768.
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** ConditionalCheckFailedException **
A condition specified in the operation failed to be evaluated.
** Item **
Item which caused the `ConditionalCheckFailedException`.
** message **
The conditional request failed.
HTTP Status Code: 400
** DuplicateItemException **
There was an attempt to insert an item with the same primary key as an item that already exists in the DynamoDB table.
HTTP Status Code: 400
** InternalServerError **
An error occurred on the server side.
** message **
The server encountered an internal error trying to fulfill the request.
HTTP Status Code: 500
** ItemCollectionSizeLimitExceededException **
An item collection is too large. This exception is only returned for tables that have one or more local secondary indexes.
** message **
The total size of an item collection has exceeded the maximum limit of 10 gigabytes.
HTTP Status Code: 400
** ProvisionedThroughputExceededException **
The request was denied due to request throttling. For detailed information about why the request was throttled and the ARN of the impacted resource, find the [ThrottlingReason](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_ThrottlingReason.html) field in the returned exception. The AWS SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to [Error Retries and Exponential Backoff](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Programming.Errors.html#Programming.Errors.RetryAndBackoff) in the *Amazon DynamoDB Developer Guide*.
** message **
You exceeded your maximum allowed provisioned throughput.
** ThrottlingReasons **
A list of [ThrottlingReason](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_ThrottlingReason.html) that provide detailed diagnostic information about why the request was throttled.
HTTP Status Code: 400
** RequestLimitExceeded **
Throughput exceeds the current throughput quota for your account. For detailed information about why the request was throttled and the ARN of the impacted resource, find the [ThrottlingReason](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_ThrottlingReason.html) field in the returned exception. Contact [Support](https://aws.amazon.com/support) to request a quota increase.
** ThrottlingReasons **
A list of [ThrottlingReason](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_ThrottlingReason.html) that provide detailed diagnostic information about why the request was throttled.
HTTP Status Code: 400
** ResourceNotFoundException **
The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be `ACTIVE`.
** message **
The resource which is being requested does not exist.
HTTP Status Code: 400
** ThrottlingException **
The request was denied due to request throttling. For detailed information about why the request was throttled and the ARN of the impacted resource, find the [ThrottlingReason](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_ThrottlingReason.html) field in the returned exception.
** throttlingReasons **
A list of [ThrottlingReason](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_ThrottlingReason.html) that provide detailed diagnostic information about why the request was throttled.
HTTP Status Code: 400
** TransactionConflictException **
Operation was rejected because there is an ongoing transaction for the item.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/dynamodb-2012-08-10/ExecuteStatement)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/dynamodb-2012-08-10/ExecuteStatement)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/ExecuteStatement)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/dynamodb-2012-08-10/ExecuteStatement)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/ExecuteStatement)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/dynamodb-2012-08-10/ExecuteStatement)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/dynamodb-2012-08-10/ExecuteStatement)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/dynamodb-2012-08-10/ExecuteStatement)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/dynamodb-2012-08-10/ExecuteStatement)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/ExecuteStatement)
# ExecuteTransaction
This operation allows you to perform transactional reads or writes on data stored in DynamoDB, using PartiQL.
**Note**
The entire transaction must consist of either read statements or write statements, you cannot mix both in one transaction. The EXISTS function is an exception and can be used to check the condition of specific attributes of the item in a similar manner to `ConditionCheck` in the [TransactWriteItems](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/transaction-apis.html#transaction-apis-txwriteitems) API.
## Request Syntax
```
{
"ClientRequestToken": "string",
"ReturnConsumedCapacity": "string",
"TransactStatements": [
{
"Parameters": [
{
"B": blob,
"BOOL": boolean,
"BS": [ blob ],
"L": [
"AttributeValue"
],
"M": {
"string" : "AttributeValue"
},
"N": "string",
"NS": [ "string" ],
"NULL": boolean,
"S": "string",
"SS": [ "string" ]
}
],
"ReturnValuesOnConditionCheckFailure": "string",
"Statement": "string"
}
]
}
```
## Request Parameters
The request accepts the following data in JSON format.
**Note**
In the following list, the required parameters are described first.
** [TransactStatements](#API_ExecuteTransaction_RequestSyntax) **
The list of PartiQL statements representing the transaction to run.
Type: Array of [ParameterizedStatement](API_ParameterizedStatement.md) objects
Array Members: Minimum number of 1 item. Maximum number of 100 items.
Required: Yes
** [ClientRequestToken](#API_ExecuteTransaction_RequestSyntax) **
Set this value to get remaining results, if `NextToken` was returned in the statement response.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 36.
Required: No
** [ReturnConsumedCapacity](#API_ExecuteTransaction_RequestSyntax) **
Determines the level of detail about either provisioned or on-demand throughput consumption that is returned in the response. For more information, see [TransactGetItems](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_TransactGetItems.html) and [TransactWriteItems](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_TransactWriteItems.html).
Type: String
Valid Values: `INDEXES | TOTAL | NONE`
Required: No
## Response Syntax
```
{
"ConsumedCapacity": [
{
"CapacityUnits": number,
"GlobalSecondaryIndexes": {
"string" : {
"CapacityUnits": number,
"ReadCapacityUnits": number,
"WriteCapacityUnits": number
}
},
"LocalSecondaryIndexes": {
"string" : {
"CapacityUnits": number,
"ReadCapacityUnits": number,
"WriteCapacityUnits": number
}
},
"ReadCapacityUnits": number,
"Table": {
"CapacityUnits": number,
"ReadCapacityUnits": number,
"WriteCapacityUnits": number
},
"TableName": "string",
"WriteCapacityUnits": number
}
],
"Responses": [
{
"Item": {
"string" : {
"B": blob,
"BOOL": boolean,
"BS": [ blob ],
"L": [
"AttributeValue"
],
"M": {
"string" : "AttributeValue"
},
"N": "string",
"NS": [ "string" ],
"NULL": boolean,
"S": "string",
"SS": [ "string" ]
}
}
}
]
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [ConsumedCapacity](#API_ExecuteTransaction_ResponseSyntax) **
The capacity units consumed by the entire operation. The values of the list are ordered according to the ordering of the statements.
Type: Array of [ConsumedCapacity](API_ConsumedCapacity.md) objects
** [Responses](#API_ExecuteTransaction_ResponseSyntax) **
The response to a PartiQL transaction.
Type: Array of [ItemResponse](API_ItemResponse.md) objects
Array Members: Minimum number of 1 item. Maximum number of 100 items.
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** IdempotentParameterMismatchException **
DynamoDB rejected the request because you retried a request with a different payload but with an idempotent token that was already used.
HTTP Status Code: 400
** InternalServerError **
An error occurred on the server side.
** message **
The server encountered an internal error trying to fulfill the request.
HTTP Status Code: 500
** ProvisionedThroughputExceededException **
The request was denied due to request throttling. For detailed information about why the request was throttled and the ARN of the impacted resource, find the [ThrottlingReason](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_ThrottlingReason.html) field in the returned exception. The AWS SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to [Error Retries and Exponential Backoff](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Programming.Errors.html#Programming.Errors.RetryAndBackoff) in the *Amazon DynamoDB Developer Guide*.
** message **
You exceeded your maximum allowed provisioned throughput.
** ThrottlingReasons **
A list of [ThrottlingReason](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_ThrottlingReason.html) that provide detailed diagnostic information about why the request was throttled.
HTTP Status Code: 400
** RequestLimitExceeded **
Throughput exceeds the current throughput quota for your account. For detailed information about why the request was throttled and the ARN of the impacted resource, find the [ThrottlingReason](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_ThrottlingReason.html) field in the returned exception. Contact [Support](https://aws.amazon.com/support) to request a quota increase.
** ThrottlingReasons **
A list of [ThrottlingReason](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_ThrottlingReason.html) that provide detailed diagnostic information about why the request was throttled.
HTTP Status Code: 400
** ResourceNotFoundException **
The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be `ACTIVE`.
** message **
The resource which is being requested does not exist.
HTTP Status Code: 400
** ThrottlingException **
The request was denied due to request throttling. For detailed information about why the request was throttled and the ARN of the impacted resource, find the [ThrottlingReason](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_ThrottlingReason.html) field in the returned exception.
** throttlingReasons **
A list of [ThrottlingReason](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_ThrottlingReason.html) that provide detailed diagnostic information about why the request was throttled.
HTTP Status Code: 400
** TransactionCanceledException **
The entire transaction request was canceled.
DynamoDB cancels a `TransactWriteItems` request under the following circumstances:
+ A condition in one of the condition expressions is not met.
+ A table in the `TransactWriteItems` request is in a different account or region.
+ More than one action in the `TransactWriteItems` operation targets the same item.
+ There is insufficient provisioned capacity for the transaction to be completed.
+ An item size becomes too large (larger than 400 KB), or a local secondary index (LSI) becomes too large, or a similar validation error occurs because of changes made by the transaction.
+ There is a user error, such as an invalid data format.
+ There is an ongoing `TransactWriteItems` operation that conflicts with a concurrent `TransactWriteItems` request. In this case the `TransactWriteItems` operation fails with a `TransactionCanceledException`.
DynamoDB cancels a `TransactGetItems` request under the following circumstances:
+ There is an ongoing `TransactGetItems` operation that conflicts with a concurrent `PutItem`, `UpdateItem`, `DeleteItem` or `TransactWriteItems` request. In this case the `TransactGetItems` operation fails with a `TransactionCanceledException`.
+ A table in the `TransactGetItems` request is in a different account or region.
+ There is insufficient provisioned capacity for the transaction to be completed.
+ There is a user error, such as an invalid data format.
DynamoDB lists the cancellation reasons on the `CancellationReasons` property. Transaction cancellation reasons are ordered in the order of requested items, if an item has no error it will have `None` code and `Null` message.
Cancellation reason codes and possible error messages:
+ No Errors:
+ Code: `None`
+ Message: `null`
+ Conditional Check Failed:
+ Code: `ConditionalCheckFailed`
+ Message: The conditional request failed.
+ Item Collection Size Limit Exceeded:
+ Code: `ItemCollectionSizeLimitExceeded`
+ Message: Collection size exceeded.
+ Transaction Conflict:
+ Code: `TransactionConflict`
+ Message: Transaction is ongoing for the item.
+ Provisioned Throughput Exceeded:
+ Code: `ProvisionedThroughputExceeded`
+ Messages:
+ The level of configured provisioned throughput for the table was exceeded. Consider increasing your provisioning level with the UpdateTable API.
**Note**
This Message is received when provisioned throughput is exceeded is on a provisioned DynamoDB table.
+ The level of configured provisioned throughput for one or more global secondary indexes of the table was exceeded. Consider increasing your provisioning level for the under-provisioned global secondary indexes with the UpdateTable API.
**Note**
This message is returned when provisioned throughput is exceeded is on a provisioned GSI.
+ Throttling Error:
+ Code: `ThrottlingError`
+ Messages:
+ Throughput exceeds the current capacity of your table or index. DynamoDB is automatically scaling your table or index so please try again shortly. If exceptions persist, check if you have a hot key: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/bp-partition-key-design.html.
**Note**
This message is returned when writes get throttled on an On-Demand table as DynamoDB is automatically scaling the table.
+ Throughput exceeds the current capacity for one or more global secondary indexes. DynamoDB is automatically scaling your index so please try again shortly.
**Note**
This message is returned when writes get throttled on an On-Demand GSI as DynamoDB is automatically scaling the GSI.
+ Validation Error:
+ Code: `ValidationError`
+ Messages:
+ One or more parameter values were invalid.
+ The update expression attempted to update the secondary index key beyond allowed size limits.
+ The update expression attempted to update the secondary index key to unsupported type.
+ An operand in the update expression has an incorrect data type.
+ Item size to update has exceeded the maximum allowed size.
+ Number overflow. Attempting to store a number with magnitude larger than supported range.
+ Type mismatch for attribute to update.
+ Nesting Levels have exceeded supported limits.
+ The document path provided in the update expression is invalid for update.
+ The provided expression refers to an attribute that does not exist in the item.
** CancellationReasons **
A list of cancellation reasons.
HTTP Status Code: 400
** TransactionInProgressException **
The transaction with the given request token is already in progress.
Recommended Settings
This is a general recommendation for handling the `TransactionInProgressException`. These settings help ensure that the client retries will trigger completion of the ongoing `TransactWriteItems` request.
+ Set `clientExecutionTimeout` to a value that allows at least one retry to be processed after 5 seconds have elapsed since the first attempt for the `TransactWriteItems` operation.
+ Set `socketTimeout` to a value a little lower than the `requestTimeout` setting.
+ `requestTimeout` should be set based on the time taken for the individual retries of a single HTTP request for your use case, but setting it to 1 second or higher should work well to reduce chances of retries and `TransactionInProgressException` errors.
+ Use exponential backoff when retrying and tune backoff if needed.
Assuming [default retry policy](https://github.com/aws/aws-sdk-java/blob/fd409dee8ae23fb8953e0bb4dbde65536a7e0514/aws-java-sdk-core/src/main/java/com/amazonaws/retry/PredefinedRetryPolicies.java#L97), example timeout settings based on the guidelines above are as follows:
Example timeline:
+ 0-1000 first attempt
+ 1000-1500 first sleep/delay (default retry policy uses 500 ms as base delay for 4xx errors)
+ 1500-2500 second attempt
+ 2500-3500 second sleep/delay (500 \$1 2, exponential backoff)
+ 3500-4500 third attempt
+ 4500-6500 third sleep/delay (500 \$1 2^2)
+ 6500-7500 fourth attempt (this can trigger inline recovery since 5 seconds have elapsed since the first attempt reached TC)
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/dynamodb-2012-08-10/ExecuteTransaction)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/dynamodb-2012-08-10/ExecuteTransaction)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/ExecuteTransaction)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/dynamodb-2012-08-10/ExecuteTransaction)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/ExecuteTransaction)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/dynamodb-2012-08-10/ExecuteTransaction)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/dynamodb-2012-08-10/ExecuteTransaction)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/dynamodb-2012-08-10/ExecuteTransaction)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/dynamodb-2012-08-10/ExecuteTransaction)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/ExecuteTransaction)
# ExportTableToPointInTime
Exports table data to an S3 bucket. The table must have point in time recovery enabled, and you can export data from any time within the point in time recovery window.
## Request Syntax
```
{
"ClientToken": "string",
"ExportFormat": "string",
"ExportTime": number,
"ExportType": "string",
"IncrementalExportSpecification": {
"ExportFromTime": number,
"ExportToTime": number,
"ExportViewType": "string"
},
"S3Bucket": "string",
"S3BucketOwner": "string",
"S3Prefix": "string",
"S3SseAlgorithm": "string",
"S3SseKmsKeyId": "string",
"TableArn": "string"
}
```
## Request Parameters
The request accepts the following data in JSON format.
**Note**
In the following list, the required parameters are described first.
** [S3Bucket](#API_ExportTableToPointInTime_RequestSyntax) **
The name of the Amazon S3 bucket to export the snapshot to.
Type: String
Length Constraints: Maximum length of 255.
Pattern: `^[a-z0-9A-Z]+[\.\-\w]*[a-z0-9A-Z]+$`
Required: Yes
** [TableArn](#API_ExportTableToPointInTime_RequestSyntax) **
The Amazon Resource Name (ARN) associated with the table to export.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: Yes
** [ClientToken](#API_ExportTableToPointInTime_RequestSyntax) **
Providing a `ClientToken` makes the call to `ExportTableToPointInTimeInput` idempotent, meaning that multiple identical calls have the same effect as one single call.
A client token is valid for 8 hours after the first request that uses it is completed. After 8 hours, any request with the same client token is treated as a new request. Do not resubmit the same request with the same client token for more than 8 hours, or the result might not be idempotent.
If you submit a request with the same client token but a change in other parameters within the 8-hour idempotency window, DynamoDB returns an `ExportConflictException`.
Type: String
Pattern: `^[^\$]+$`
Required: No
** [ExportFormat](#API_ExportTableToPointInTime_RequestSyntax) **
The format for the exported data. Valid values for `ExportFormat` are `DYNAMODB_JSON` or `ION`.
Type: String
Valid Values: `DYNAMODB_JSON | ION`
Required: No
** [ExportTime](#API_ExportTableToPointInTime_RequestSyntax) **
Time in the past from which to export table data, counted in seconds from the start of the Unix epoch. The table export will be a snapshot of the table's state at this point in time.
Type: Timestamp
Required: No
** [ExportType](#API_ExportTableToPointInTime_RequestSyntax) **
Choice of whether to execute as a full export or incremental export. Valid values are FULL\$1EXPORT or INCREMENTAL\$1EXPORT. The default value is FULL\$1EXPORT. If INCREMENTAL\$1EXPORT is provided, the IncrementalExportSpecification must also be used.
Type: String
Valid Values: `FULL_EXPORT | INCREMENTAL_EXPORT`
Required: No
** [IncrementalExportSpecification](#API_ExportTableToPointInTime_RequestSyntax) **
Optional object containing the parameters specific to an incremental export.
Type: [IncrementalExportSpecification](API_IncrementalExportSpecification.md) object
Required: No
** [S3BucketOwner](#API_ExportTableToPointInTime_RequestSyntax) **
The ID of the AWS account that owns the bucket the export will be stored in.
S3BucketOwner is a required parameter when exporting to a S3 bucket in another account.
Type: String
Pattern: `[0-9]{12}`
Required: No
** [S3Prefix](#API_ExportTableToPointInTime_RequestSyntax) **
The Amazon S3 bucket prefix to use as the file name and path of the exported snapshot.
Type: String
Length Constraints: Maximum length of 1024.
Required: No
** [S3SseAlgorithm](#API_ExportTableToPointInTime_RequestSyntax) **
Type of encryption used on the bucket where export data will be stored. Valid values for `S3SseAlgorithm` are:
+ `AES256` - server-side encryption with Amazon S3 managed keys
+ `KMS` - server-side encryption with AWS KMS managed keys
Type: String
Valid Values: `AES256 | KMS`
Required: No
** [S3SseKmsKeyId](#API_ExportTableToPointInTime_RequestSyntax) **
The ID of the AWS KMS managed key used to encrypt the S3 bucket where export data will be stored (if applicable).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Required: No
## Response Syntax
```
{
"ExportDescription": {
"BilledSizeBytes": number,
"ClientToken": "string",
"EndTime": number,
"ExportArn": "string",
"ExportFormat": "string",
"ExportManifest": "string",
"ExportStatus": "string",
"ExportTime": number,
"ExportType": "string",
"FailureCode": "string",
"FailureMessage": "string",
"IncrementalExportSpecification": {
"ExportFromTime": number,
"ExportToTime": number,
"ExportViewType": "string"
},
"ItemCount": number,
"S3Bucket": "string",
"S3BucketOwner": "string",
"S3Prefix": "string",
"S3SseAlgorithm": "string",
"S3SseKmsKeyId": "string",
"StartTime": number,
"TableArn": "string",
"TableId": "string"
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [ExportDescription](#API_ExportTableToPointInTime_ResponseSyntax) **
Contains a description of the table export.
Type: [ExportDescription](API_ExportDescription.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** ExportConflictException **
There was a conflict when writing to the specified S3 bucket.
HTTP Status Code: 400
** InternalServerError **
An error occurred on the server side.
** message **
The server encountered an internal error trying to fulfill the request.
HTTP Status Code: 500
** InvalidExportTimeException **
The specified `ExportTime` is outside of the point in time recovery window.
HTTP Status Code: 400
** LimitExceededException **
There is no limit to the number of daily on-demand backups that can be taken.
For most purposes, up to 500 simultaneous table operations are allowed per account. These operations include `CreateTable`, `UpdateTable`, `DeleteTable`,`UpdateTimeToLive`, `RestoreTableFromBackup`, and `RestoreTableToPointInTime`.
When you are creating a table with one or more secondary indexes, you can have up to 250 such requests running at a time. However, if the table or index specifications are complex, then DynamoDB might temporarily reduce the number of concurrent operations.
When importing into DynamoDB, up to 50 simultaneous import table operations are allowed per account.
There is a soft account quota of 2,500 tables.
GetRecords was called with a value of more than 1000 for the limit request parameter.
More than 2 processes are reading from the same streams shard at the same time. Exceeding this limit may result in request throttling.
** message **
Too many operations for a given subscriber.
HTTP Status Code: 400
** PointInTimeRecoveryUnavailableException **
Point in time recovery has not yet been enabled for this source table.
HTTP Status Code: 400
** TableNotFoundException **
A source table with the name `TableName` does not currently exist within the subscriber's account or the subscriber is operating in the wrong AWS Region.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/dynamodb-2012-08-10/ExportTableToPointInTime)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/dynamodb-2012-08-10/ExportTableToPointInTime)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/ExportTableToPointInTime)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/dynamodb-2012-08-10/ExportTableToPointInTime)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/ExportTableToPointInTime)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/dynamodb-2012-08-10/ExportTableToPointInTime)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/dynamodb-2012-08-10/ExportTableToPointInTime)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/dynamodb-2012-08-10/ExportTableToPointInTime)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/dynamodb-2012-08-10/ExportTableToPointInTime)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/ExportTableToPointInTime)
# GetItem
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 Syntax
```
{
"AttributesToGet": [ "string" ],
"ConsistentRead": boolean,
"ExpressionAttributeNames": {
"string" : "string"
},
"Key": {
"string" : {
"B": blob,
"BOOL": boolean,
"BS": [ blob ],
"L": [
"AttributeValue"
],
"M": {
"string" : "AttributeValue"
},
"N": "string",
"NS": [ "string" ],
"NULL": boolean,
"S": "string",
"SS": [ "string" ]
}
},
"ProjectionExpression": "string",
"ReturnConsumedCapacity": "string",
"TableName": "string"
}
```
## Request Parameters
The request accepts the following data in JSON format.
**Note**
In the following list, the required parameters are described first.
** [Key](#API_GetItem_RequestSyntax) **
A map of attribute names to `AttributeValue` objects, representing the primary key of the item to retrieve.
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.
Type: String to [AttributeValue](API_AttributeValue.md) object map
Key Length Constraints: Maximum length of 65535.
Required: Yes
** [TableName](#API_GetItem_RequestSyntax) **
The name of the table containing the requested item. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: Yes
** [AttributesToGet](#API_GetItem_RequestSyntax) **
This is a legacy parameter. Use `ProjectionExpression` instead. For more information, see [AttributesToGet](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.AttributesToGet.html) in the *Amazon DynamoDB Developer Guide*.
Type: Array of strings
Array Members: Minimum number of 1 item.
Length Constraints: Maximum length of 65535.
Required: No
** [ConsistentRead](#API_GetItem_RequestSyntax) **
Determines the read consistency model: If set to `true`, then the operation uses strongly consistent reads; otherwise, the operation uses eventually consistent reads.
Type: Boolean
Required: No
** [ExpressionAttributeNames](#API_GetItem_RequestSyntax) **
One or more substitution tokens for attribute names in an expression. The following are some use cases for using `ExpressionAttributeNames`:
+ To access an attribute whose name conflicts with a DynamoDB reserved word.
+ To create a placeholder for repeating occurrences of an attribute name in an expression.
+ To prevent special characters in an attribute name from being misinterpreted in an expression.
Use the **\$1** character in an expression to dereference an attribute name. For example, consider the following attribute name:
+ `Percentile`
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](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ReservedWords.html) in the *Amazon DynamoDB Developer Guide*). To work around this, you could specify the following for `ExpressionAttributeNames`:
+ `{"#P":"Percentile"}`
You could then use this substitution in an expression, as in this example:
+ `#P = :val`
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](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html) in the *Amazon DynamoDB Developer Guide*.
Type: String to string map
Value Length Constraints: Maximum length of 65535.
Required: No
** [ProjectionExpression](#API_GetItem_RequestSyntax) **
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](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html) in the *Amazon DynamoDB Developer Guide*.
Type: String
Required: No
** [ReturnConsumedCapacity](#API_GetItem_RequestSyntax) **
Determines the level of detail about either provisioned or on-demand throughput consumption that is returned in the response:
+ `INDEXES` - The response includes the aggregate `ConsumedCapacity` for the operation, together with `ConsumedCapacity` for each table and secondary index that was accessed.
Note that some operations, such as `GetItem` and `BatchGetItem`, do not access any indexes at all. In these cases, specifying `INDEXES` will only return `ConsumedCapacity` information for table(s).
+ `TOTAL` - The response includes only the aggregate `ConsumedCapacity` for the operation.
+ `NONE` - No `ConsumedCapacity` details are included in the response.
Type: String
Valid Values: `INDEXES | TOTAL | NONE`
Required: No
## Response Syntax
```
{
"ConsumedCapacity": {
"CapacityUnits": number,
"GlobalSecondaryIndexes": {
"string" : {
"CapacityUnits": number,
"ReadCapacityUnits": number,
"WriteCapacityUnits": number
}
},
"LocalSecondaryIndexes": {
"string" : {
"CapacityUnits": number,
"ReadCapacityUnits": number,
"WriteCapacityUnits": number
}
},
"ReadCapacityUnits": number,
"Table": {
"CapacityUnits": number,
"ReadCapacityUnits": number,
"WriteCapacityUnits": number
},
"TableName": "string",
"WriteCapacityUnits": number
},
"Item": {
"string" : {
"B": blob,
"BOOL": boolean,
"BS": [ blob ],
"L": [
"AttributeValue"
],
"M": {
"string" : "AttributeValue"
},
"N": "string",
"NS": [ "string" ],
"NULL": boolean,
"S": "string",
"SS": [ "string" ]
}
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [ConsumedCapacity](#API_GetItem_ResponseSyntax) **
The capacity units consumed by the `GetItem` operation. The data returned includes the total provisioned throughput consumed, along with statistics for the table and any indexes involved in the operation. `ConsumedCapacity` is only returned if the `ReturnConsumedCapacity` parameter was specified. For more information, see [Capacity unit consumption for read operations](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/read-write-operations.html#read-operation-consumption) in the *Amazon DynamoDB Developer Guide*.
Type: [ConsumedCapacity](API_ConsumedCapacity.md) object
** [Item](#API_GetItem_ResponseSyntax) **
A map of attribute names to `AttributeValue` objects, as specified by `ProjectionExpression`.
Type: String to [AttributeValue](API_AttributeValue.md) object map
Key Length Constraints: Maximum length of 65535.
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalServerError **
An error occurred on the server side.
** message **
The server encountered an internal error trying to fulfill the request.
HTTP Status Code: 500
** ProvisionedThroughputExceededException **
The request was denied due to request throttling. For detailed information about why the request was throttled and the ARN of the impacted resource, find the [ThrottlingReason](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_ThrottlingReason.html) field in the returned exception. The AWS SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to [Error Retries and Exponential Backoff](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Programming.Errors.html#Programming.Errors.RetryAndBackoff) in the *Amazon DynamoDB Developer Guide*.
** message **
You exceeded your maximum allowed provisioned throughput.
** ThrottlingReasons **
A list of [ThrottlingReason](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_ThrottlingReason.html) that provide detailed diagnostic information about why the request was throttled.
HTTP Status Code: 400
** RequestLimitExceeded **
Throughput exceeds the current throughput quota for your account. For detailed information about why the request was throttled and the ARN of the impacted resource, find the [ThrottlingReason](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_ThrottlingReason.html) field in the returned exception. Contact [Support](https://aws.amazon.com/support) to request a quota increase.
** ThrottlingReasons **
A list of [ThrottlingReason](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_ThrottlingReason.html) that provide detailed diagnostic information about why the request was throttled.
HTTP Status Code: 400
** ResourceNotFoundException **
The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be `ACTIVE`.
** message **
The resource which is being requested does not exist.
HTTP Status Code: 400
** ThrottlingException **
The request was denied due to request throttling. For detailed information about why the request was throttled and the ARN of the impacted resource, find the [ThrottlingReason](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_ThrottlingReason.html) field in the returned exception.
** throttlingReasons **
A list of [ThrottlingReason](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_ThrottlingReason.html) that provide detailed diagnostic information about why the request was throttled.
HTTP Status Code: 400
## Examples
### Retrieve Item Attributes
The following example retrieves three attributes from the `Thread` table. In the response, the `ConsumedCapacityUnits` value is 1, because `ConsistentRead` is set to true. If `ConsistentRead` had been set to false (or not specified) for the same request, an eventually consistent read would have been used and `ConsumedCapacityUnits` would have been 0.5.
#### Sample Request
```
POST / HTTP/1.1
Host: dynamodb..;
Accept-Encoding: identity
Content-Length:
User-Agent:
Content-Type: application/x-amz-json-1.0
Authorization: AWS4-HMAC-SHA256 Credential=, SignedHeaders=, Signature=
X-Amz-Date:
X-Amz-Target: DynamoDB_20120810.GetItem
{
"TableName": "Thread",
"Key": {
"ForumName": {
"S": "Amazon DynamoDB"
},
"Subject": {
"S": "How do I update multiple items?"
}
},
"ProjectionExpression":"LastPostDateTime, Message, Tags",
"ConsistentRead": true,
"ReturnConsumedCapacity": "TOTAL"
}
```
#### Sample Response
```
HTTP/1.1 200 OK
x-amzn-RequestId:
x-amz-crc32:
Content-Type: application/x-amz-json-1.0
Content-Length:
Date:
{
"ConsumedCapacity": {
"CapacityUnits": 1,
"TableName": "Thread"
},
"Item": {
"Tags": {
"SS": ["Update","Multiple Items","HelpMe"]
},
"LastPostDateTime": {
"S": "201303190436"
},
"Message": {
"S": "I want to update multiple items in a single call. What's the best way to do that?"
}
}
}
```
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/dynamodb-2012-08-10/GetItem)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/dynamodb-2012-08-10/GetItem)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/GetItem)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/dynamodb-2012-08-10/GetItem)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/GetItem)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/dynamodb-2012-08-10/GetItem)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/dynamodb-2012-08-10/GetItem)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/dynamodb-2012-08-10/GetItem)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/dynamodb-2012-08-10/GetItem)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/GetItem)
# GetResourcePolicy
Returns the resource-based policy document attached to the resource, which can be a table or stream, in JSON format.
`GetResourcePolicy` follows an [https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadConsistency.html](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadConsistency.html) model. The following list describes the outcomes when you issue the `GetResourcePolicy` request immediately after issuing another request:
+ If you issue a `GetResourcePolicy` request immediately after a `PutResourcePolicy` request, DynamoDB might return a `PolicyNotFoundException`.
+ If you issue a `GetResourcePolicy`request immediately after a `DeleteResourcePolicy` request, DynamoDB might return the policy that was present before the deletion request.
+ If you issue a `GetResourcePolicy` request immediately after a `CreateTable` request, which includes a resource-based policy, DynamoDB might return a `ResourceNotFoundException` or a `PolicyNotFoundException`.
Because `GetResourcePolicy` uses an *eventually consistent* query, the metadata for your policy or table might not be available at that moment. Wait for a few seconds, and then retry the `GetResourcePolicy` request.
After a `GetResourcePolicy` request returns a policy created using the `PutResourcePolicy` request, the policy will be applied in the authorization of requests to the resource. Because this process is eventually consistent, it will take some time to apply the policy to all requests to a resource. Policies that you attach while creating a table using the `CreateTable` request will always be applied to all requests for that table.
## Request Syntax
```
{
"ResourceArn": "string"
}
```
## Request Parameters
The request accepts the following data in JSON format.
**Note**
In the following list, the required parameters are described first.
** [ResourceArn](#API_GetResourcePolicy_RequestSyntax) **
The Amazon Resource Name (ARN) of the DynamoDB resource to which the policy is attached. The resources you can specify include tables and streams.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1283.
Required: Yes
## Response Syntax
```
{
"Policy": "string",
"RevisionId": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [Policy](#API_GetResourcePolicy_ResponseSyntax) **
The resource-based policy document attached to the resource, which can be a table or stream, in JSON format.
Type: String
** [RevisionId](#API_GetResourcePolicy_ResponseSyntax) **
A unique string that represents the revision ID of the policy. If you're comparing revision IDs, make sure to always use string comparison logic.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalServerError **
An error occurred on the server side.
** message **
The server encountered an internal error trying to fulfill the request.
HTTP Status Code: 500
** PolicyNotFoundException **
The operation tried to access a nonexistent resource-based policy.
If you specified an `ExpectedRevisionId`, it's possible that a policy is present for the resource but its revision ID didn't match the expected value.
HTTP Status Code: 400
** ResourceNotFoundException **
The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be `ACTIVE`.
** message **
The resource which is being requested does not exist.
HTTP Status Code: 400
## Examples
### Get the resource-based policy of a table
The following example retrieves the resource-based policy of a table named `Thread`.
#### Sample Request
```
GET / HTTP/1.1
Host: dynamodb..;
Accept-Encoding: identity
Content-Length:
User-Agent:
Content-Type: application/x-amz-json-1.0
Authorization: AWS4-HMAC-SHA256 Credential=, SignedHeaders=, Signature=
X-Amz-Date:
X-Amz-Target: DynamoDB_20120810.GetResourcePolicy
{
"ResourceArn": "arn:aws:dynamodb:us-west-2:123456789012:table/Thread"
}
```
#### Sample Response
```
HTTP/1.1 200 OK
x-amzn-RequestId:
x-amz-crc32:
Content-Type: application/x-amz-json-1.0
Content-Length:
Date:
{
"Policy": "{\"Version\":\"2012-10-17\",\"Statement\":{\"Effect\":\"Allow\",\"Principal\":{\"AWS\":[\"arn:aws:iam::111122223333:root\",\"arn:aws:iam::444455556666:root\"]},\"Action\":[\"dynamodb:GetItem\"],\"Resource\":\"arn:aws:dynamodb:us-west-2:123456789012:table/Thread\"}}",
"RevisionId": "1683717331354"
}
```
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/dynamodb-2012-08-10/GetResourcePolicy)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/dynamodb-2012-08-10/GetResourcePolicy)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/GetResourcePolicy)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/dynamodb-2012-08-10/GetResourcePolicy)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/GetResourcePolicy)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/dynamodb-2012-08-10/GetResourcePolicy)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/dynamodb-2012-08-10/GetResourcePolicy)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/dynamodb-2012-08-10/GetResourcePolicy)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/dynamodb-2012-08-10/GetResourcePolicy)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/GetResourcePolicy)
# ImportTable
Imports table data from an S3 bucket.
## Request Syntax
```
{
"ClientToken": "string",
"InputCompressionType": "string",
"InputFormat": "string",
"InputFormatOptions": {
"Csv": {
"Delimiter": "string",
"HeaderList": [ "string" ]
}
},
"S3BucketSource": {
"S3Bucket": "string",
"S3BucketOwner": "string",
"S3KeyPrefix": "string"
},
"TableCreationParameters": {
"AttributeDefinitions": [
{
"AttributeName": "string",
"AttributeType": "string"
}
],
"BillingMode": "string",
"GlobalSecondaryIndexes": [
{
"IndexName": "string",
"KeySchema": [
{
"AttributeName": "string",
"KeyType": "string"
}
],
"OnDemandThroughput": {
"MaxReadRequestUnits": number,
"MaxWriteRequestUnits": number
},
"Projection": {
"NonKeyAttributes": [ "string" ],
"ProjectionType": "string"
},
"ProvisionedThroughput": {
"ReadCapacityUnits": number,
"WriteCapacityUnits": number
},
"WarmThroughput": {
"ReadUnitsPerSecond": number,
"WriteUnitsPerSecond": number
}
}
],
"KeySchema": [
{
"AttributeName": "string",
"KeyType": "string"
}
],
"OnDemandThroughput": {
"MaxReadRequestUnits": number,
"MaxWriteRequestUnits": number
},
"ProvisionedThroughput": {
"ReadCapacityUnits": number,
"WriteCapacityUnits": number
},
"SSESpecification": {
"Enabled": boolean,
"KMSMasterKeyId": "string",
"SSEType": "string"
},
"TableName": "string"
}
}
```
## Request Parameters
The request accepts the following data in JSON format.
**Note**
In the following list, the required parameters are described first.
** [InputFormat](#API_ImportTable_RequestSyntax) **
The format of the source data. Valid values for `ImportFormat` are `CSV`, `DYNAMODB_JSON` or `ION`.
Type: String
Valid Values: `DYNAMODB_JSON | ION | CSV`
Required: Yes
** [S3BucketSource](#API_ImportTable_RequestSyntax) **
The S3 bucket that provides the source for the import.
Type: [S3BucketSource](API_S3BucketSource.md) object
Required: Yes
** [TableCreationParameters](#API_ImportTable_RequestSyntax) **
Parameters for the table to import the data into.
Type: [TableCreationParameters](API_TableCreationParameters.md) object
Required: Yes
** [ClientToken](#API_ImportTable_RequestSyntax) **
Providing a `ClientToken` makes the call to `ImportTableInput` idempotent, meaning that multiple identical calls have the same effect as one single call.
A client token is valid for 8 hours after the first request that uses it is completed. After 8 hours, any request with the same client token is treated as a new request. Do not resubmit the same request with the same client token for more than 8 hours, or the result might not be idempotent.
If you submit a request with the same client token but a change in other parameters within the 8-hour idempotency window, DynamoDB returns an `IdempotentParameterMismatch` exception.
Type: String
Pattern: `^[^\$]+$`
Required: No
** [InputCompressionType](#API_ImportTable_RequestSyntax) **
Type of compression to be used on the input coming from the imported table.
Type: String
Valid Values: `GZIP | ZSTD | NONE`
Required: No
** [InputFormatOptions](#API_ImportTable_RequestSyntax) **
Additional properties that specify how the input is formatted,
Type: [InputFormatOptions](API_InputFormatOptions.md) object
Required: No
## Response Syntax
```
{
"ImportTableDescription": {
"ClientToken": "string",
"CloudWatchLogGroupArn": "string",
"EndTime": number,
"ErrorCount": number,
"FailureCode": "string",
"FailureMessage": "string",
"ImportArn": "string",
"ImportedItemCount": number,
"ImportStatus": "string",
"InputCompressionType": "string",
"InputFormat": "string",
"InputFormatOptions": {
"Csv": {
"Delimiter": "string",
"HeaderList": [ "string" ]
}
},
"ProcessedItemCount": number,
"ProcessedSizeBytes": number,
"S3BucketSource": {
"S3Bucket": "string",
"S3BucketOwner": "string",
"S3KeyPrefix": "string"
},
"StartTime": number,
"TableArn": "string",
"TableCreationParameters": {
"AttributeDefinitions": [
{
"AttributeName": "string",
"AttributeType": "string"
}
],
"BillingMode": "string",
"GlobalSecondaryIndexes": [
{
"IndexName": "string",
"KeySchema": [
{
"AttributeName": "string",
"KeyType": "string"
}
],
"OnDemandThroughput": {
"MaxReadRequestUnits": number,
"MaxWriteRequestUnits": number
},
"Projection": {
"NonKeyAttributes": [ "string" ],
"ProjectionType": "string"
},
"ProvisionedThroughput": {
"ReadCapacityUnits": number,
"WriteCapacityUnits": number
},
"WarmThroughput": {
"ReadUnitsPerSecond": number,
"WriteUnitsPerSecond": number
}
}
],
"KeySchema": [
{
"AttributeName": "string",
"KeyType": "string"
}
],
"OnDemandThroughput": {
"MaxReadRequestUnits": number,
"MaxWriteRequestUnits": number
},
"ProvisionedThroughput": {
"ReadCapacityUnits": number,
"WriteCapacityUnits": number
},
"SSESpecification": {
"Enabled": boolean,
"KMSMasterKeyId": "string",
"SSEType": "string"
},
"TableName": "string"
},
"TableId": "string"
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [ImportTableDescription](#API_ImportTable_ResponseSyntax) **
Represents the properties of the table created for the import, and parameters of the import. The import parameters include import status, how many items were processed, and how many errors were encountered.
Type: [ImportTableDescription](API_ImportTableDescription.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** ImportConflictException **
There was a conflict when importing from the specified S3 source. This can occur when the current import conflicts with a previous import request that had the same client token.
HTTP Status Code: 400
** LimitExceededException **
There is no limit to the number of daily on-demand backups that can be taken.
For most purposes, up to 500 simultaneous table operations are allowed per account. These operations include `CreateTable`, `UpdateTable`, `DeleteTable`,`UpdateTimeToLive`, `RestoreTableFromBackup`, and `RestoreTableToPointInTime`.
When you are creating a table with one or more secondary indexes, you can have up to 250 such requests running at a time. However, if the table or index specifications are complex, then DynamoDB might temporarily reduce the number of concurrent operations.
When importing into DynamoDB, up to 50 simultaneous import table operations are allowed per account.
There is a soft account quota of 2,500 tables.
GetRecords was called with a value of more than 1000 for the limit request parameter.
More than 2 processes are reading from the same streams shard at the same time. Exceeding this limit may result in request throttling.
** message **
Too many operations for a given subscriber.
HTTP Status Code: 400
** ResourceInUseException **
The operation conflicts with the resource's availability. For example:
+ You attempted to recreate an existing table.
+ You tried to delete a table currently in the `CREATING` state.
+ You tried to update a resource that was already being updated.
When appropriate, wait for the ongoing update to complete and attempt the request again.
** message **
The resource which is being attempted to be changed is in use.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/dynamodb-2012-08-10/ImportTable)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/dynamodb-2012-08-10/ImportTable)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/ImportTable)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/dynamodb-2012-08-10/ImportTable)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/ImportTable)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/dynamodb-2012-08-10/ImportTable)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/dynamodb-2012-08-10/ImportTable)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/dynamodb-2012-08-10/ImportTable)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/dynamodb-2012-08-10/ImportTable)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/ImportTable)
# ListBackups
List DynamoDB backups that are associated with an AWS account and weren't made with AWS Backup. To list these 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 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 boundaries are for the time at which the original backup was requested.
You can call `ListBackups` a maximum of five times per second.
If you want to retrieve the complete list of backups made with AWS Backup, use the [AWS Backup list API.](https://docs.aws.amazon.com/aws-backup/latest/devguide/API_ListBackupJobs.html)
## Request Syntax
```
{
"BackupType": "string",
"ExclusiveStartBackupArn": "string",
"Limit": number,
"TableName": "string",
"TimeRangeLowerBound": number,
"TimeRangeUpperBound": number
}
```
## Request Parameters
The request accepts the following data in JSON format.
**Note**
In the following list, the required parameters are described first.
** [BackupType](#API_ListBackups_RequestSyntax) **
The backups from the table specified by `BackupType` are listed.
Where `BackupType` can be:
+ `USER` - On-demand backup created by you. (The default setting if no other backup types are specified.)
+ `SYSTEM` - On-demand backup automatically created by DynamoDB.
+ `ALL` - All types of on-demand backups (USER and SYSTEM).
Type: String
Valid Values: `USER | SYSTEM | AWS_BACKUP | ALL`
Required: No
** [ExclusiveStartBackupArn](#API_ListBackups_RequestSyntax) **
`LastEvaluatedBackupArn` is the Amazon Resource Name (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 `ExclusiveStartBackupArn` of a new `ListBackups` operation in order to fetch the next page of results.
Type: String
Length Constraints: Minimum length of 37. Maximum length of 1024.
Required: No
** [Limit](#API_ListBackups_RequestSyntax) **
Maximum number of backups to return at once.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No
** [TableName](#API_ListBackups_RequestSyntax) **
Lists the backups from the table specified in `TableName`. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: No
** [TimeRangeLowerBound](#API_ListBackups_RequestSyntax) **
Only backups created after this time are listed. `TimeRangeLowerBound` is inclusive.
Type: Timestamp
Required: No
** [TimeRangeUpperBound](#API_ListBackups_RequestSyntax) **
Only backups created before this time are listed. `TimeRangeUpperBound` is exclusive.
Type: Timestamp
Required: No
## Response Syntax
```
{
"BackupSummaries": [
{
"BackupArn": "string",
"BackupCreationDateTime": number,
"BackupExpiryDateTime": number,
"BackupName": "string",
"BackupSizeBytes": number,
"BackupStatus": "string",
"BackupType": "string",
"TableArn": "string",
"TableId": "string",
"TableName": "string"
}
],
"LastEvaluatedBackupArn": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [BackupSummaries](#API_ListBackups_ResponseSyntax) **
List of `BackupSummary` objects.
Type: Array of [BackupSummary](API_BackupSummary.md) objects
** [LastEvaluatedBackupArn](#API_ListBackups_ResponseSyntax) **
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 `ExclusiveStartBackupArn` of a new `ListBackups` operation in order to fetch the next page of results.
If `LastEvaluatedBackupArn` is empty, then the last page of results has been processed and there are no more results to be retrieved.
If `LastEvaluatedBackupArn` is not empty, this may or may not indicate that there is more data to be returned. All results are guaranteed to have been returned if and only if no value for `LastEvaluatedBackupArn` is returned.
Type: String
Length Constraints: Minimum length of 37. Maximum length of 1024.
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalServerError **
An error occurred on the server side.
** message **
The server encountered an internal error trying to fulfill the request.
HTTP Status Code: 500
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/dynamodb-2012-08-10/ListBackups)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/dynamodb-2012-08-10/ListBackups)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/ListBackups)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/dynamodb-2012-08-10/ListBackups)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/ListBackups)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/dynamodb-2012-08-10/ListBackups)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/dynamodb-2012-08-10/ListBackups)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/dynamodb-2012-08-10/ListBackups)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/dynamodb-2012-08-10/ListBackups)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/ListBackups)
# ListContributorInsights
Returns a list of ContributorInsightsSummary for a table and all its global secondary indexes.
## Request Syntax
```
{
"MaxResults": number,
"NextToken": "string",
"TableName": "string"
}
```
## Request Parameters
The request accepts the following data in JSON format.
**Note**
In the following list, the required parameters are described first.
** [MaxResults](#API_ListContributorInsights_RequestSyntax) **
Maximum number of results to return per page.
Type: Integer
Valid Range: Maximum value of 100.
Required: No
** [NextToken](#API_ListContributorInsights_RequestSyntax) **
A token to for the desired page, if there is one.
Type: String
Required: No
** [TableName](#API_ListContributorInsights_RequestSyntax) **
The name of the table. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: No
## Response Syntax
```
{
"ContributorInsightsSummaries": [
{
"ContributorInsightsMode": "string",
"ContributorInsightsStatus": "string",
"IndexName": "string",
"TableName": "string"
}
],
"NextToken": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [ContributorInsightsSummaries](#API_ListContributorInsights_ResponseSyntax) **
A list of ContributorInsightsSummary.
Type: Array of [ContributorInsightsSummary](API_ContributorInsightsSummary.md) objects
** [NextToken](#API_ListContributorInsights_ResponseSyntax) **
A token to go to the next page if there is one.
Type: String
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalServerError **
An error occurred on the server side.
** message **
The server encountered an internal error trying to fulfill the request.
HTTP Status Code: 500
** ResourceNotFoundException **
The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be `ACTIVE`.
** message **
The resource which is being requested does not exist.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/dynamodb-2012-08-10/ListContributorInsights)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/dynamodb-2012-08-10/ListContributorInsights)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/ListContributorInsights)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/dynamodb-2012-08-10/ListContributorInsights)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/ListContributorInsights)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/dynamodb-2012-08-10/ListContributorInsights)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/dynamodb-2012-08-10/ListContributorInsights)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/dynamodb-2012-08-10/ListContributorInsights)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/dynamodb-2012-08-10/ListContributorInsights)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/ListContributorInsights)
# ListExports
Lists completed exports within the past 90 days, in reverse alphanumeric order of `ExportArn`.
## Request Syntax
```
{
"MaxResults": number,
"NextToken": "string",
"TableArn": "string"
}
```
## Request Parameters
The request accepts the following data in JSON format.
**Note**
In the following list, the required parameters are described first.
** [MaxResults](#API_ListExports_RequestSyntax) **
Maximum number of results to return per page.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 25.
Required: No
** [NextToken](#API_ListExports_RequestSyntax) **
An optional string that, if supplied, must be copied from the output of a previous call to `ListExports`. When provided in this manner, the API fetches the next page of results.
Type: String
Required: No
** [TableArn](#API_ListExports_RequestSyntax) **
The Amazon Resource Name (ARN) associated with the exported table.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: No
## Response Syntax
```
{
"ExportSummaries": [
{
"ExportArn": "string",
"ExportStatus": "string",
"ExportType": "string"
}
],
"NextToken": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [ExportSummaries](#API_ListExports_ResponseSyntax) **
A list of `ExportSummary` objects.
Type: Array of [ExportSummary](API_ExportSummary.md) objects
** [NextToken](#API_ListExports_ResponseSyntax) **
If this value is returned, there are additional results to be displayed. To retrieve them, call `ListExports` again, with `NextToken` set to this value.
Type: String
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalServerError **
An error occurred on the server side.
** message **
The server encountered an internal error trying to fulfill the request.
HTTP Status Code: 500
** LimitExceededException **
There is no limit to the number of daily on-demand backups that can be taken.
For most purposes, up to 500 simultaneous table operations are allowed per account. These operations include `CreateTable`, `UpdateTable`, `DeleteTable`,`UpdateTimeToLive`, `RestoreTableFromBackup`, and `RestoreTableToPointInTime`.
When you are creating a table with one or more secondary indexes, you can have up to 250 such requests running at a time. However, if the table or index specifications are complex, then DynamoDB might temporarily reduce the number of concurrent operations.
When importing into DynamoDB, up to 50 simultaneous import table operations are allowed per account.
There is a soft account quota of 2,500 tables.
GetRecords was called with a value of more than 1000 for the limit request parameter.
More than 2 processes are reading from the same streams shard at the same time. Exceeding this limit may result in request throttling.
** message **
Too many operations for a given subscriber.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/dynamodb-2012-08-10/ListExports)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/dynamodb-2012-08-10/ListExports)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/ListExports)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/dynamodb-2012-08-10/ListExports)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/ListExports)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/dynamodb-2012-08-10/ListExports)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/dynamodb-2012-08-10/ListExports)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/dynamodb-2012-08-10/ListExports)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/dynamodb-2012-08-10/ListExports)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/ListExports)
# ListGlobalTables
Lists all global tables that have a replica in the specified Region.
**Important**
This documentation is for version 2017.11.29 (Legacy) of global tables, which should be avoided for new global tables. Customers should use [Global Tables version 2019.11.21 (Current)](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/GlobalTables.html) when possible, because it provides greater flexibility, higher efficiency, and consumes less write capacity than 2017.11.29 (Legacy).
To determine which version you're using, see [Determining the global table version you are using](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.DetermineVersion.html). To update existing global tables from version 2017.11.29 (Legacy) to version 2019.11.21 (Current), see [Upgrading global tables](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/V2globaltables_upgrade.html).
## Request Syntax
```
{
"ExclusiveStartGlobalTableName": "string",
"Limit": number,
"RegionName": "string"
}
```
## Request Parameters
The request accepts the following data in JSON format.
**Note**
In the following list, the required parameters are described first.
** [ExclusiveStartGlobalTableName](#API_ListGlobalTables_RequestSyntax) **
The first global table name that this operation will evaluate.
Type: String
Length Constraints: Minimum length of 3. Maximum length of 255.
Pattern: `[a-zA-Z0-9_.-]+`
Required: No
** [Limit](#API_ListGlobalTables_RequestSyntax) **
The maximum number of table names to return, if the parameter is not specified DynamoDB defaults to 100.
If the number of global tables DynamoDB finds reaches this limit, it stops the operation and returns the table names collected up to that point, with a table name in the `LastEvaluatedGlobalTableName` to apply in a subsequent operation to the `ExclusiveStartGlobalTableName` parameter.
Type: Integer
Valid Range: Minimum value of 1.
Required: No
** [RegionName](#API_ListGlobalTables_RequestSyntax) **
Lists the global tables in a specific Region.
Type: String
Required: No
## Response Syntax
```
{
"GlobalTables": [
{
"GlobalTableName": "string",
"ReplicationGroup": [
{
"RegionName": "string"
}
]
}
],
"LastEvaluatedGlobalTableName": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [GlobalTables](#API_ListGlobalTables_ResponseSyntax) **
List of global table names.
Type: Array of [GlobalTable](API_GlobalTable.md) objects
** [LastEvaluatedGlobalTableName](#API_ListGlobalTables_ResponseSyntax) **
Last evaluated global table name.
Type: String
Length Constraints: Minimum length of 3. Maximum length of 255.
Pattern: `[a-zA-Z0-9_.-]+`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalServerError **
An error occurred on the server side.
** message **
The server encountered an internal error trying to fulfill the request.
HTTP Status Code: 500
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/dynamodb-2012-08-10/ListGlobalTables)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/dynamodb-2012-08-10/ListGlobalTables)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/ListGlobalTables)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/dynamodb-2012-08-10/ListGlobalTables)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/ListGlobalTables)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/dynamodb-2012-08-10/ListGlobalTables)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/dynamodb-2012-08-10/ListGlobalTables)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/dynamodb-2012-08-10/ListGlobalTables)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/dynamodb-2012-08-10/ListGlobalTables)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/ListGlobalTables)
# ListImports
Lists completed imports within the past 90 days.
## Request Syntax
```
{
"NextToken": "string",
"PageSize": number,
"TableArn": "string"
}
```
## Request Parameters
The request accepts the following data in JSON format.
**Note**
In the following list, the required parameters are described first.
** [NextToken](#API_ListImports_RequestSyntax) **
An optional string that, if supplied, must be copied from the output of a previous call to `ListImports`. When provided in this manner, the API fetches the next page of results.
Type: String
Length Constraints: Minimum length of 112. Maximum length of 1024.
Pattern: `([0-9a-f]{16})+`
Required: No
** [PageSize](#API_ListImports_RequestSyntax) **
The number of `ImportSummary `objects returned in a single page.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 25.
Required: No
** [TableArn](#API_ListImports_RequestSyntax) **
The Amazon Resource Name (ARN) associated with the table that was imported to.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: No
## Response Syntax
```
{
"ImportSummaryList": [
{
"CloudWatchLogGroupArn": "string",
"EndTime": number,
"ImportArn": "string",
"ImportStatus": "string",
"InputFormat": "string",
"S3BucketSource": {
"S3Bucket": "string",
"S3BucketOwner": "string",
"S3KeyPrefix": "string"
},
"StartTime": number,
"TableArn": "string"
}
],
"NextToken": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [ImportSummaryList](#API_ListImports_ResponseSyntax) **
A list of `ImportSummary` objects.
Type: Array of [ImportSummary](API_ImportSummary.md) objects
** [NextToken](#API_ListImports_ResponseSyntax) **
If this value is returned, there are additional results to be displayed. To retrieve them, call `ListImports` again, with `NextToken` set to this value.
Type: String
Length Constraints: Minimum length of 112. Maximum length of 1024.
Pattern: `([0-9a-f]{16})+`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** LimitExceededException **
There is no limit to the number of daily on-demand backups that can be taken.
For most purposes, up to 500 simultaneous table operations are allowed per account. These operations include `CreateTable`, `UpdateTable`, `DeleteTable`,`UpdateTimeToLive`, `RestoreTableFromBackup`, and `RestoreTableToPointInTime`.
When you are creating a table with one or more secondary indexes, you can have up to 250 such requests running at a time. However, if the table or index specifications are complex, then DynamoDB might temporarily reduce the number of concurrent operations.
When importing into DynamoDB, up to 50 simultaneous import table operations are allowed per account.
There is a soft account quota of 2,500 tables.
GetRecords was called with a value of more than 1000 for the limit request parameter.
More than 2 processes are reading from the same streams shard at the same time. Exceeding this limit may result in request throttling.
** message **
Too many operations for a given subscriber.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/dynamodb-2012-08-10/ListImports)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/dynamodb-2012-08-10/ListImports)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/ListImports)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/dynamodb-2012-08-10/ListImports)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/ListImports)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/dynamodb-2012-08-10/ListImports)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/dynamodb-2012-08-10/ListImports)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/dynamodb-2012-08-10/ListImports)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/dynamodb-2012-08-10/ListImports)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/ListImports)
# ListTables
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 Syntax
```
{
"ExclusiveStartTableName": "string",
"Limit": number
}
```
## Request Parameters
The request accepts the following data in JSON format.
**Note**
In the following list, the required parameters are described first.
** [ExclusiveStartTableName](#API_ListTables_RequestSyntax) **
The first table name that this operation will evaluate. Use the value that was returned for `LastEvaluatedTableName` in a previous operation, so that you can obtain the next page of results.
Type: String
Length Constraints: Minimum length of 3. Maximum length of 255.
Pattern: `[a-zA-Z0-9_.-]+`
Required: No
** [Limit](#API_ListTables_RequestSyntax) **
A maximum number of table names to return. If this parameter is not specified, the limit is 100.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No
## Response Syntax
```
{
"LastEvaluatedTableName": "string",
"TableNames": [ "string" ]
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [LastEvaluatedTableName](#API_ListTables_ResponseSyntax) **
The name of the last table in the current page of results. Use this value as the `ExclusiveStartTableName` in a new request to obtain the next page of results, until all the table names are returned.
If you do not receive a `LastEvaluatedTableName` value in the response, this means that there are no more table names to be retrieved.
Type: String
Length Constraints: Minimum length of 3. Maximum length of 255.
Pattern: `[a-zA-Z0-9_.-]+`
** [TableNames](#API_ListTables_ResponseSyntax) **
The names of the tables associated with the current account at the current endpoint. The maximum size of this array is 100.
If `LastEvaluatedTableName` also appears in the output, you can use this value as the `ExclusiveStartTableName` parameter in a subsequent `ListTables` request and obtain the next page of results.
Type: Array of strings
Length Constraints: Minimum length of 3. Maximum length of 255.
Pattern: `[a-zA-Z0-9_.-]+`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalServerError **
An error occurred on the server side.
** message **
The server encountered an internal error trying to fulfill the request.
HTTP Status Code: 500
## Examples
### List Tables
This example requests a list of tables, starting with a table named `Forum` and ending after three table names have been returned.
#### Sample Request
```
POST / HTTP/1.1
Host: dynamodb..;
Accept-Encoding: identity
Content-Length:
User-Agent:
Content-Type: application/x-amz-json-1.0
Authorization: AWS4-HMAC-SHA256 Credential=, SignedHeaders=, Signature=
X-Amz-Date:
X-Amz-Target: DynamoDB_20120810.ListTables
{
"ExclusiveStartTableName": "Forum",
"Limit": 3
}
```
#### Sample Response
```
HTTP/1.1 200 OK
x-amzn-RequestId:
x-amz-crc32:
Content-Type: application/x-amz-json-1.0
Content-Length:
Date:
{
"LastEvaluatedTableName": "Thread",
"TableNames": ["Forum","Reply","Thread"]
}
```
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/dynamodb-2012-08-10/ListTables)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/dynamodb-2012-08-10/ListTables)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/ListTables)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/dynamodb-2012-08-10/ListTables)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/ListTables)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/dynamodb-2012-08-10/ListTables)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/dynamodb-2012-08-10/ListTables)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/dynamodb-2012-08-10/ListTables)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/dynamodb-2012-08-10/ListTables)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/ListTables)
# ListTagsOfResource
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](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Tagging.html) in the *Amazon DynamoDB Developer Guide*.
## Request Syntax
```
{
"NextToken": "string",
"ResourceArn": "string"
}
```
## Request Parameters
The request accepts the following data in JSON format.
**Note**
In the following list, the required parameters are described first.
** [ResourceArn](#API_ListTagsOfResource_RequestSyntax) **
The Amazon DynamoDB resource with tags to be listed. This value is an Amazon Resource Name (ARN).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1283.
Required: Yes
** [NextToken](#API_ListTagsOfResource_RequestSyntax) **
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.
Type: String
Required: No
## Response Syntax
```
{
"NextToken": "string",
"Tags": [
{
"Key": "string",
"Value": "string"
}
]
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [NextToken](#API_ListTagsOfResource_ResponseSyntax) **
If this value is returned, there are additional results to be displayed. To retrieve them, call ListTagsOfResource again, with NextToken set to this value.
Type: String
** [Tags](#API_ListTagsOfResource_ResponseSyntax) **
The tags currently associated with the Amazon DynamoDB resource.
Type: Array of [Tag](API_Tag.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalServerError **
An error occurred on the server side.
** message **
The server encountered an internal error trying to fulfill the request.
HTTP Status Code: 500
** ResourceNotFoundException **
The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be `ACTIVE`.
** message **
The resource which is being requested does not exist.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/dynamodb-2012-08-10/ListTagsOfResource)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/dynamodb-2012-08-10/ListTagsOfResource)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/ListTagsOfResource)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/dynamodb-2012-08-10/ListTagsOfResource)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/ListTagsOfResource)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/dynamodb-2012-08-10/ListTagsOfResource)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/dynamodb-2012-08-10/ListTagsOfResource)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/dynamodb-2012-08-10/ListTagsOfResource)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/dynamodb-2012-08-10/ListTagsOfResource)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/ListTagsOfResource)
# PutItem
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.
When you add an item, the primary key attributes are the only required attributes.
Empty String and Binary attribute values are allowed. Attribute values of type String and Binary must have a length greater than zero if the attribute is used as a key attribute for a table or index. Set type attributes cannot be empty.
Invalid Requests with empty values will be rejected with a `ValidationException` exception.
**Note**
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.
**Note**
To determine whether `PutItem` overwrote an existing item, use `ReturnValues` set to `ALL_OLD`. If the response includes the `Attributes` element, an existing item was overwritten.
For more information about `PutItem`, see [Working with Items](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithItems.html) in the *Amazon DynamoDB Developer Guide*.
## Request Syntax
```
{
"ConditionalOperator": "string",
"ConditionExpression": "string",
"Expected": {
"string" : {
"AttributeValueList": [
{
"B": blob,
"BOOL": boolean,
"BS": [ blob ],
"L": [
"AttributeValue"
],
"M": {
"string" : "AttributeValue"
},
"N": "string",
"NS": [ "string" ],
"NULL": boolean,
"S": "string",
"SS": [ "string" ]
}
],
"ComparisonOperator": "string",
"Exists": boolean,
"Value": {
"B": blob,
"BOOL": boolean,
"BS": [ blob ],
"L": [
"AttributeValue"
],
"M": {
"string" : "AttributeValue"
},
"N": "string",
"NS": [ "string" ],
"NULL": boolean,
"S": "string",
"SS": [ "string" ]
}
}
},
"ExpressionAttributeNames": {
"string" : "string"
},
"ExpressionAttributeValues": {
"string" : {
"B": blob,
"BOOL": boolean,
"BS": [ blob ],
"L": [
"AttributeValue"
],
"M": {
"string" : "AttributeValue"
},
"N": "string",
"NS": [ "string" ],
"NULL": boolean,
"S": "string",
"SS": [ "string" ]
}
},
"Item": {
"string" : {
"B": blob,
"BOOL": boolean,
"BS": [ blob ],
"L": [
"AttributeValue"
],
"M": {
"string" : "AttributeValue"
},
"N": "string",
"NS": [ "string" ],
"NULL": boolean,
"S": "string",
"SS": [ "string" ]
}
},
"ReturnConsumedCapacity": "string",
"ReturnItemCollectionMetrics": "string",
"ReturnValues": "string",
"ReturnValuesOnConditionCheckFailure": "string",
"TableName": "string"
}
```
## Request Parameters
The request accepts the following data in JSON format.
**Note**
In the following list, the required parameters are described first.
** [Item](#API_PutItem_RequestSyntax) **
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.
Empty String and Binary attribute values are allowed. Attribute values of type String and Binary must have a length greater than zero if the attribute is used as a key attribute for a table or index.
For more information about primary keys, see [Primary Key](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.CoreComponents.html#HowItWorks.CoreComponents.PrimaryKey) in the *Amazon DynamoDB Developer Guide*.
Each element in the `Item` map is an `AttributeValue` object.
Type: String to [AttributeValue](API_AttributeValue.md) object map
Key Length Constraints: Maximum length of 65535.
Required: Yes
** [TableName](#API_PutItem_RequestSyntax) **
The name of the table to contain the item. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: Yes
** [ConditionalOperator](#API_PutItem_RequestSyntax) **
This is a legacy parameter. Use `ConditionExpression` instead. For more information, see [ConditionalOperator](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.ConditionalOperator.html) in the *Amazon DynamoDB Developer Guide*.
Type: String
Valid Values: `AND | OR`
Required: No
** [ConditionExpression](#API_PutItem_RequestSyntax) **
A condition that must be satisfied in order for a conditional `PutItem` operation to succeed.
An expression can contain any of the following:
+ Functions: `attribute_exists | attribute_not_exists | attribute_type | contains | begins_with | size`
These function names are case-sensitive.
+ Comparison operators: `= | <> | < | > | <= | >= | BETWEEN | IN `
+ Logical operators: `AND | OR | NOT`
For more information on condition expressions, see [Condition Expressions](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.SpecifyingConditions.html) in the *Amazon DynamoDB Developer Guide*.
Type: String
Required: No
** [Expected](#API_PutItem_RequestSyntax) **
This is a legacy parameter. Use `ConditionExpression` instead. For more information, see [Expected](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.Expected.html) in the *Amazon DynamoDB Developer Guide*.
Type: String to [ExpectedAttributeValue](API_ExpectedAttributeValue.md) object map
Key Length Constraints: Maximum length of 65535.
Required: No
** [ExpressionAttributeNames](#API_PutItem_RequestSyntax) **
One or more substitution tokens for attribute names in an expression. The following are some use cases for using `ExpressionAttributeNames`:
+ To access an attribute whose name conflicts with a DynamoDB reserved word.
+ To create a placeholder for repeating occurrences of an attribute name in an expression.
+ To prevent special characters in an attribute name from being misinterpreted in an expression.
Use the **\$1** character in an expression to dereference an attribute name. For example, consider the following attribute name:
+ `Percentile`
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](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ReservedWords.html) in the *Amazon DynamoDB Developer Guide*). To work around this, you could specify the following for `ExpressionAttributeNames`:
+ `{"#P":"Percentile"}`
You could then use this substitution in an expression, as in this example:
+ `#P = :val`
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](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html) in the *Amazon DynamoDB Developer Guide*.
Type: String to string map
Value Length Constraints: Maximum length of 65535.
Required: No
** [ExpressionAttributeValues](#API_PutItem_RequestSyntax) **
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:
`Available | Backordered | Discontinued`
You would first need to specify `ExpressionAttributeValues` as follows:
`{ ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }`
You could then use these values in an expression, such as this:
`ProductStatus IN (:avail, :back, :disc)`
For more information on expression attribute values, see [Condition Expressions](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.SpecifyingConditions.html) in the *Amazon DynamoDB Developer Guide*.
Type: String to [AttributeValue](API_AttributeValue.md) object map
Required: No
** [ReturnConsumedCapacity](#API_PutItem_RequestSyntax) **
Determines the level of detail about either provisioned or on-demand throughput consumption that is returned in the response:
+ `INDEXES` - The response includes the aggregate `ConsumedCapacity` for the operation, together with `ConsumedCapacity` for each table and secondary index that was accessed.
Note that some operations, such as `GetItem` and `BatchGetItem`, do not access any indexes at all. In these cases, specifying `INDEXES` will only return `ConsumedCapacity` information for table(s).
+ `TOTAL` - The response includes only the aggregate `ConsumedCapacity` for the operation.
+ `NONE` - No `ConsumedCapacity` details are included in the response.
Type: String
Valid Values: `INDEXES | TOTAL | NONE`
Required: No
** [ReturnItemCollectionMetrics](#API_PutItem_RequestSyntax) **
Determines whether item collection metrics are returned. If set to `SIZE`, the response includes statistics about item collections, if any, that were modified during the operation are returned in the response. If set to `NONE` (the default), no statistics are returned.
Type: String
Valid Values: `SIZE | NONE`
Required: No
** [ReturnValues](#API_PutItem_RequestSyntax) **
Use `ReturnValues` if you want to get the item attributes as they appeared before they were updated with the `PutItem` request. For `PutItem`, the valid values are:
+ `NONE` - If `ReturnValues` is not specified, or if its value is `NONE`, then nothing is returned. (This setting is the default for `ReturnValues`.)
+ `ALL_OLD` - If `PutItem` overwrote an attribute name-value pair, then the content of the old item is returned.
The values returned are strongly consistent.
There is no additional cost associated with requesting a return value aside from the small network and processing overhead of receiving a larger response. No read capacity units are consumed.
The `ReturnValues` parameter is used by several DynamoDB operations; however, `PutItem` does not recognize any values other than `NONE` or `ALL_OLD`.
Type: String
Valid Values: `NONE | ALL_OLD | UPDATED_OLD | ALL_NEW | UPDATED_NEW`
Required: No
** [ReturnValuesOnConditionCheckFailure](#API_PutItem_RequestSyntax) **
An optional parameter that returns the item attributes for a `PutItem` operation that failed a condition check.
There is no additional cost associated with requesting a return value aside from the small network and processing overhead of receiving a larger response. No read capacity units are consumed.
Type: String
Valid Values: `ALL_OLD | NONE`
Required: No
## Response Syntax
```
{
"Attributes": {
"string" : {
"B": blob,
"BOOL": boolean,
"BS": [ blob ],
"L": [
"AttributeValue"
],
"M": {
"string" : "AttributeValue"
},
"N": "string",
"NS": [ "string" ],
"NULL": boolean,
"S": "string",
"SS": [ "string" ]
}
},
"ConsumedCapacity": {
"CapacityUnits": number,
"GlobalSecondaryIndexes": {
"string" : {
"CapacityUnits": number,
"ReadCapacityUnits": number,
"WriteCapacityUnits": number
}
},
"LocalSecondaryIndexes": {
"string" : {
"CapacityUnits": number,
"ReadCapacityUnits": number,
"WriteCapacityUnits": number
}
},
"ReadCapacityUnits": number,
"Table": {
"CapacityUnits": number,
"ReadCapacityUnits": number,
"WriteCapacityUnits": number
},
"TableName": "string",
"WriteCapacityUnits": number
},
"ItemCollectionMetrics": {
"ItemCollectionKey": {
"string" : {
"B": blob,
"BOOL": boolean,
"BS": [ blob ],
"L": [
"AttributeValue"
],
"M": {
"string" : "AttributeValue"
},
"N": "string",
"NS": [ "string" ],
"NULL": boolean,
"S": "string",
"SS": [ "string" ]
}
},
"SizeEstimateRangeGB": [ number ]
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [Attributes](#API_PutItem_ResponseSyntax) **
The attribute values as they appeared before the `PutItem` operation, but only if `ReturnValues` is specified as `ALL_OLD` in the request. Each element consists of an attribute name and an attribute value.
Type: String to [AttributeValue](API_AttributeValue.md) object map
Key Length Constraints: Maximum length of 65535.
** [ConsumedCapacity](#API_PutItem_ResponseSyntax) **
The capacity units consumed by the `PutItem` operation. The data returned includes the total provisioned throughput consumed, along with statistics for the table and any indexes involved in the operation. `ConsumedCapacity` is only returned if the `ReturnConsumedCapacity` parameter was specified. For more information, see [Capacity unity consumption for write operations](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/read-write-operations.html#write-operation-consumption) in the *Amazon DynamoDB Developer Guide*.
Type: [ConsumedCapacity](API_ConsumedCapacity.md) object
** [ItemCollectionMetrics](#API_PutItem_ResponseSyntax) **
Information about item collections, if any, that were affected by the `PutItem` operation. `ItemCollectionMetrics` is only returned if the `ReturnItemCollectionMetrics` parameter was specified. If the table does not have any local secondary indexes, this information is not returned in the response.
Each `ItemCollectionMetrics` element consists of:
+ `ItemCollectionKey` - The partition key value of the item collection. This is the same as the partition key value of the item itself.
+ `SizeEstimateRangeGB` - An estimate of item collection size, in gigabytes. This value is a two-element array containing a lower bound and an upper bound for the estimate. The estimate includes the size of all the items in the table, plus the size of all attributes projected into all of the local secondary indexes on that table. Use this estimate to measure whether a local secondary index is approaching its size limit.
The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate.
Type: [ItemCollectionMetrics](API_ItemCollectionMetrics.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** ConditionalCheckFailedException **
A condition specified in the operation failed to be evaluated.
** Item **
Item which caused the `ConditionalCheckFailedException`.
** message **
The conditional request failed.
HTTP Status Code: 400
** InternalServerError **
An error occurred on the server side.
** message **
The server encountered an internal error trying to fulfill the request.
HTTP Status Code: 500
** ItemCollectionSizeLimitExceededException **
An item collection is too large. This exception is only returned for tables that have one or more local secondary indexes.
** message **
The total size of an item collection has exceeded the maximum limit of 10 gigabytes.
HTTP Status Code: 400
** ProvisionedThroughputExceededException **
The request was denied due to request throttling. For detailed information about why the request was throttled and the ARN of the impacted resource, find the [ThrottlingReason](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_ThrottlingReason.html) field in the returned exception. The AWS SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to [Error Retries and Exponential Backoff](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Programming.Errors.html#Programming.Errors.RetryAndBackoff) in the *Amazon DynamoDB Developer Guide*.
** message **
You exceeded your maximum allowed provisioned throughput.
** ThrottlingReasons **
A list of [ThrottlingReason](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_ThrottlingReason.html) that provide detailed diagnostic information about why the request was throttled.
HTTP Status Code: 400
** ReplicatedWriteConflictException **
The request was rejected because one or more items in the request are being modified by a request in another Region.
HTTP Status Code: 400
** RequestLimitExceeded **
Throughput exceeds the current throughput quota for your account. For detailed information about why the request was throttled and the ARN of the impacted resource, find the [ThrottlingReason](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_ThrottlingReason.html) field in the returned exception. Contact [Support](https://aws.amazon.com/support) to request a quota increase.
** ThrottlingReasons **
A list of [ThrottlingReason](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_ThrottlingReason.html) that provide detailed diagnostic information about why the request was throttled.
HTTP Status Code: 400
** ResourceNotFoundException **
The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be `ACTIVE`.
** message **
The resource which is being requested does not exist.
HTTP Status Code: 400
** ThrottlingException **
The request was denied due to request throttling. For detailed information about why the request was throttled and the ARN of the impacted resource, find the [ThrottlingReason](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_ThrottlingReason.html) field in the returned exception.
** throttlingReasons **
A list of [ThrottlingReason](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_ThrottlingReason.html) that provide detailed diagnostic information about why the request was throttled.
HTTP Status Code: 400
** TransactionConflictException **
Operation was rejected because there is an ongoing transaction for the item.
HTTP Status Code: 400
## Examples
### Put an Item
The following example puts a new item into the `Thread` table, but only if there is not already an item in the table with the same key.
#### Sample Request
```
POST / HTTP/1.1
Host: dynamodb..;
Accept-Encoding: identity
Content-Length:
User-Agent:
Content-Type: application/x-amz-json-1.0
Authorization: AWS4-HMAC-SHA256 Credential=, SignedHeaders=, Signature=
X-Amz-Date:
X-Amz-Target: DynamoDB_20120810.PutItem
{
"TableName": "Thread",
"Item": {
"LastPostDateTime": {
"S": "201303190422"
},
"Tags": {
"SS": ["Update","Multiple Items","HelpMe"]
},
"ForumName": {
"S": "Amazon DynamoDB"
},
"Message": {
"S": "I want to update multiple items in a single call. What's the best way to do that?"
},
"Subject": {
"S": "How do I update multiple items?"
},
"LastPostedBy": {
"S": "fred@example.com"
}
},
"ConditionExpression": "ForumName <> :f and Subject <> :s",
"ExpressionAttributeValues": {
":f": {"S": "Amazon DynamoDB"},
":s": {"S": "How do I update multiple items?"}
}
}
```
#### Sample Response
```
HTTP/1.1 200 OK
x-amzn-RequestId:
x-amz-crc32:
Content-Type: application/x-amz-json-1.0
Content-Length:
Date:
{
}
```
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/dynamodb-2012-08-10/PutItem)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/dynamodb-2012-08-10/PutItem)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/PutItem)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/dynamodb-2012-08-10/PutItem)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/PutItem)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/dynamodb-2012-08-10/PutItem)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/dynamodb-2012-08-10/PutItem)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/dynamodb-2012-08-10/PutItem)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/dynamodb-2012-08-10/PutItem)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/PutItem)
# PutResourcePolicy
Attaches a resource-based policy document to the resource, which can be a table or stream. When you attach a resource-based policy using this API, the policy application is [https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadConsistency.html](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadConsistency.html).
`PutResourcePolicy` is an idempotent operation; running it multiple times on the same resource using the same policy document will return the same revision ID. If you specify an `ExpectedRevisionId` that doesn't match the current policy's `RevisionId`, the `PolicyNotFoundException` will be returned.
**Note**
`PutResourcePolicy` is an asynchronous operation. If you issue a `GetResourcePolicy` request immediately after a `PutResourcePolicy` request, DynamoDB might return your previous policy, if there was one, or return the `PolicyNotFoundException`. This is because `GetResourcePolicy` uses an eventually consistent query, and the metadata for your policy or table might not be available at that moment. Wait for a few seconds, and then try the `GetResourcePolicy` request again.
## Request Syntax
```
{
"ConfirmRemoveSelfResourceAccess": boolean,
"ExpectedRevisionId": "string",
"Policy": "string",
"ResourceArn": "string"
}
```
## Request Parameters
The request accepts the following data in JSON format.
**Note**
In the following list, the required parameters are described first.
** [Policy](#API_PutResourcePolicy_RequestSyntax) **
An AWS resource-based policy document in JSON format.
+ The maximum size supported for a resource-based policy document is 20 KB. DynamoDB counts whitespaces when calculating the size of a policy against this limit.
+ Within a resource-based policy, if the action for a DynamoDB service-linked role (SLR) to replicate data for a global table is denied, adding or deleting a replica will fail with an error.
For a full list of all considerations that apply while attaching a resource-based policy, see [Resource-based policy considerations](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/rbac-considerations.html).
Type: String
Required: Yes
** [ResourceArn](#API_PutResourcePolicy_RequestSyntax) **
The Amazon Resource Name (ARN) of the DynamoDB resource to which the policy will be attached. The resources you can specify include tables and streams.
You can control index permissions using the base table's policy. To specify the same permission level for your table and its indexes, you can provide both the table and index Amazon Resource Name (ARN)s in the `Resource` field of a given `Statement` in your policy document. Alternatively, to specify different permissions for your table, indexes, or both, you can define multiple `Statement` fields in your policy document.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1283.
Required: Yes
** [ConfirmRemoveSelfResourceAccess](#API_PutResourcePolicy_RequestSyntax) **
Set this parameter to `true` to confirm that you want to remove your permissions to change the policy of this resource in the future.
Type: Boolean
Required: No
** [ExpectedRevisionId](#API_PutResourcePolicy_RequestSyntax) **
A string value that you can use to conditionally update your policy. You can provide the revision ID of your existing policy to make mutating requests against that policy.
When you provide an expected revision ID, if the revision ID of the existing policy on the resource doesn't match or if there's no policy attached to the resource, your request will be rejected with a `PolicyNotFoundException`.
To conditionally attach a policy when no policy exists for the resource, specify `NO_POLICY` for the revision ID.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Required: No
## Response Syntax
```
{
"RevisionId": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [RevisionId](#API_PutResourcePolicy_ResponseSyntax) **
A unique string that represents the revision ID of the policy. If you're comparing revision IDs, make sure to always use string comparison logic.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalServerError **
An error occurred on the server side.
** message **
The server encountered an internal error trying to fulfill the request.
HTTP Status Code: 500
** LimitExceededException **
There is no limit to the number of daily on-demand backups that can be taken.
For most purposes, up to 500 simultaneous table operations are allowed per account. These operations include `CreateTable`, `UpdateTable`, `DeleteTable`,`UpdateTimeToLive`, `RestoreTableFromBackup`, and `RestoreTableToPointInTime`.
When you are creating a table with one or more secondary indexes, you can have up to 250 such requests running at a time. However, if the table or index specifications are complex, then DynamoDB might temporarily reduce the number of concurrent operations.
When importing into DynamoDB, up to 50 simultaneous import table operations are allowed per account.
There is a soft account quota of 2,500 tables.
GetRecords was called with a value of more than 1000 for the limit request parameter.
More than 2 processes are reading from the same streams shard at the same time. Exceeding this limit may result in request throttling.
** message **
Too many operations for a given subscriber.
HTTP Status Code: 400
** PolicyNotFoundException **
The operation tried to access a nonexistent resource-based policy.
If you specified an `ExpectedRevisionId`, it's possible that a policy is present for the resource but its revision ID didn't match the expected value.
HTTP Status Code: 400
** ResourceInUseException **
The operation conflicts with the resource's availability. For example:
+ You attempted to recreate an existing table.
+ You tried to delete a table currently in the `CREATING` state.
+ You tried to update a resource that was already being updated.
When appropriate, wait for the ongoing update to complete and attempt the request again.
** message **
The resource which is being attempted to be changed is in use.
HTTP Status Code: 400
** ResourceNotFoundException **
The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be `ACTIVE`.
** message **
The resource which is being requested does not exist.
HTTP Status Code: 400
## Examples
### Attach a resource-based policy to a table
The following example attaches a resource-based policy to a table named `Thread`.
To view more examples of resource-based policies, see [Resource-based policy examples](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/rbac-examples.html).
#### Sample Request
```
POST / HTTP/1.1
Host: dynamodb..;
Accept-Encoding: identity
Content-Length:
User-Agent:
Content-Type: application/x-amz-json-1.0
Authorization: AWS4-HMAC-SHA256 Credential=, SignedHeaders=, Signature=
X-Amz-Date:
X-Amz-Target: DynamoDB_20120810.PutResourcePolicy
{
"ResourceArn": "arn:aws:dynamodb:us-west-2:123456789012:table/Thread",
"Policy": "{\"Version\":\"2012-10-17\",\"Statement\":{\"Effect\":\"Allow\",\"Principal\":{\"AWS\":[\"arn:aws:iam::111122223333:root\",\"arn:aws:iam::444455556666:root\"]},\"Action\":[\"dynamodb:GetItem\"],\"Resource\":\"arn:aws:dynamodb:us-west-2:123456789012:table/Thread\"}}"
}
```
#### Sample Response
```
HTTP/1.1 200 OK
x-amzn-RequestId:
x-amz-crc32:
Content-Type: application/x-amz-json-1.0
Content-Length:
Date:
{
"RevisionId": "1683717331354"
}
```
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/dynamodb-2012-08-10/PutResourcePolicy)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/dynamodb-2012-08-10/PutResourcePolicy)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/PutResourcePolicy)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/dynamodb-2012-08-10/PutResourcePolicy)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/PutResourcePolicy)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/dynamodb-2012-08-10/PutResourcePolicy)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/dynamodb-2012-08-10/PutResourcePolicy)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/dynamodb-2012-08-10/PutResourcePolicy)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/dynamodb-2012-08-10/PutResourcePolicy)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/PutResourcePolicy)
# Query
You must provide the name of the partition key attribute and a single value for that attribute. `Query` returns all items with that partition key value. Optionally, you can provide a sort key attribute and use a comparison operator to refine the search results.
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.
**Note**
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](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Query.html#Query.Pagination) 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`.
**Note**
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.
For additional information on how to use the Query API, please see [Working with Queries](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Query.html).
## Request Syntax
```
{
"AttributesToGet": [ "string" ],
"ConditionalOperator": "string",
"ConsistentRead": boolean,
"ExclusiveStartKey": {
"string" : {
"B": blob,
"BOOL": boolean,
"BS": [ blob ],
"L": [
"AttributeValue"
],
"M": {
"string" : "AttributeValue"
},
"N": "string",
"NS": [ "string" ],
"NULL": boolean,
"S": "string",
"SS": [ "string" ]
}
},
"ExpressionAttributeNames": {
"string" : "string"
},
"ExpressionAttributeValues": {
"string" : {
"B": blob,
"BOOL": boolean,
"BS": [ blob ],
"L": [
"AttributeValue"
],
"M": {
"string" : "AttributeValue"
},
"N": "string",
"NS": [ "string" ],
"NULL": boolean,
"S": "string",
"SS": [ "string" ]
}
},
"FilterExpression": "string",
"IndexName": "string",
"KeyConditionExpression": "string",
"KeyConditions": {
"string" : {
"AttributeValueList": [
{
"B": blob,
"BOOL": boolean,
"BS": [ blob ],
"L": [
"AttributeValue"
],
"M": {
"string" : "AttributeValue"
},
"N": "string",
"NS": [ "string" ],
"NULL": boolean,
"S": "string",
"SS": [ "string" ]
}
],
"ComparisonOperator": "string"
}
},
"Limit": number,
"ProjectionExpression": "string",
"QueryFilter": {
"string" : {
"AttributeValueList": [
{
"B": blob,
"BOOL": boolean,
"BS": [ blob ],
"L": [
"AttributeValue"
],
"M": {
"string" : "AttributeValue"
},
"N": "string",
"NS": [ "string" ],
"NULL": boolean,
"S": "string",
"SS": [ "string" ]
}
],
"ComparisonOperator": "string"
}
},
"ReturnConsumedCapacity": "string",
"ScanIndexForward": boolean,
"Select": "string",
"TableName": "string"
}
```
## Request Parameters
The request accepts the following data in JSON format.
**Note**
In the following list, the required parameters are described first.
** [TableName](#API_Query_RequestSyntax) **
The name of the table containing the requested items. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: Yes
** [AttributesToGet](#API_Query_RequestSyntax) **
This is a legacy parameter. Use `ProjectionExpression` instead. For more information, see [AttributesToGet](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.AttributesToGet.html) in the *Amazon DynamoDB Developer Guide*.
Type: Array of strings
Array Members: Minimum number of 1 item.
Length Constraints: Maximum length of 65535.
Required: No
** [ConditionalOperator](#API_Query_RequestSyntax) **
This is a legacy parameter. Use `FilterExpression` instead. For more information, see [ConditionalOperator](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.ConditionalOperator.html) in the *Amazon DynamoDB Developer Guide*.
Type: String
Valid Values: `AND | OR`
Required: No
** [ConsistentRead](#API_Query_RequestSyntax) **
Determines the read consistency model: If set to `true`, then the operation uses strongly consistent reads; otherwise, the operation uses eventually consistent reads.
Strongly consistent reads are not supported on global secondary indexes. If you query a global secondary index with `ConsistentRead` set to `true`, you will receive a `ValidationException`.
Type: Boolean
Required: No
** [ExclusiveStartKey](#API_Query_RequestSyntax) **
The primary key of the first item that this operation will evaluate. Use the value that was returned for `LastEvaluatedKey` in the previous operation.
The data type for `ExclusiveStartKey` must be String, Number, or Binary. No set data types are allowed.
Type: String to [AttributeValue](API_AttributeValue.md) object map
Key Length Constraints: Maximum length of 65535.
Required: No
** [ExpressionAttributeNames](#API_Query_RequestSyntax) **
One or more substitution tokens for attribute names in an expression. The following are some use cases for using `ExpressionAttributeNames`:
+ To access an attribute whose name conflicts with a DynamoDB reserved word.
+ To create a placeholder for repeating occurrences of an attribute name in an expression.
+ To prevent special characters in an attribute name from being misinterpreted in an expression.
Use the **\$1** character in an expression to dereference an attribute name. For example, consider the following attribute name:
+ `Percentile`
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](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ReservedWords.html) in the *Amazon DynamoDB Developer Guide*). To work around this, you could specify the following for `ExpressionAttributeNames`:
+ `{"#P":"Percentile"}`
You could then use this substitution in an expression, as in this example:
+ `#P = :val`
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](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html) in the *Amazon DynamoDB Developer Guide*.
Type: String to string map
Value Length Constraints: Maximum length of 65535.
Required: No
** [ExpressionAttributeValues](#API_Query_RequestSyntax) **
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:
`Available | Backordered | Discontinued`
You would first need to specify `ExpressionAttributeValues` as follows:
`{ ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }`
You could then use these values in an expression, such as this:
`ProductStatus IN (:avail, :back, :disc)`
For more information on expression attribute values, see [Specifying Conditions](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.SpecifyingConditions.html) in the *Amazon DynamoDB Developer Guide*.
Type: String to [AttributeValue](API_AttributeValue.md) object map
Required: No
** [FilterExpression](#API_Query_RequestSyntax) **
A string that contains conditions that DynamoDB applies after the `Query` operation, but before the data is returned to you. Items that do not satisfy the `FilterExpression` criteria are not returned.
A `FilterExpression` does not allow key attributes. You cannot define a filter expression based on a partition key or a sort key.
A `FilterExpression` is applied after the items have already been read; the process of filtering does not consume any additional read capacity units.
For more information, see [Filter Expressions](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Query.FilterExpression.html) in the *Amazon DynamoDB Developer Guide*.
Type: String
Required: No
** [IndexName](#API_Query_RequestSyntax) **
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 `IndexName` parameter, you must also provide `TableName.`
Type: String
Length Constraints: Minimum length of 3. Maximum length of 255.
Pattern: `[a-zA-Z0-9_.-]+`
Required: No
** [KeyConditionExpression](#API_Query_RequestSyntax) **
The condition that specifies the key values for items to be retrieved by the `Query` action.
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 `Query` to retrieve one item with a given partition key value and sort key value, or several items that have the same partition key value but different sort key values.
The partition key equality test is required, and must be specified in the following format:
`partitionKeyName` *=* `:partitionkeyval`
If you also want to provide a condition for the sort key, it must be combined using `AND` with the condition for the sort key. Following is an example, using the **=** comparison operator for the sort key:
`partitionKeyName` `=` `:partitionkeyval` `AND` `sortKeyName` `=` `:sortkeyval`
Valid comparisons for the sort key condition are as follows:
+ `sortKeyName` `=` `:sortkeyval` - true if the sort key value is equal to `:sortkeyval`.
+ `sortKeyName` `<` `:sortkeyval` - true if the sort key value is less than `:sortkeyval`.
+ `sortKeyName` `<=` `:sortkeyval` - true if the sort key value is less than or equal to `:sortkeyval`.
+ `sortKeyName` `>` `:sortkeyval` - true if the sort key value is greater than `:sortkeyval`.
+ `sortKeyName` `>= ` `:sortkeyval` - true if the sort key value is greater than or equal to `:sortkeyval`.
+ `sortKeyName` `BETWEEN` `:sortkeyval1` `AND` `:sortkeyval2` - true if the sort key value is greater than or equal to `:sortkeyval1`, and less than or equal to `:sortkeyval2`.
+ `begins_with (` `sortKeyName`, `:sortkeyval` `)` - true if the sort key value begins with a particular operand. (You cannot use this function with a sort key that is of type Number.) Note that the function name `begins_with` is case-sensitive.
Use the `ExpressionAttributeValues` parameter to replace tokens such as `:partitionval` and `:sortval` with actual values at runtime.
You can optionally use the `ExpressionAttributeNames` parameter to replace the names of the partition key and sort key with placeholder tokens. This option might be necessary if an attribute name conflicts with a DynamoDB reserved word. For example, the following `KeyConditionExpression` parameter causes an error because *Size* is a reserved word:
+ `Size = :myval`
To work around this, define a placeholder (such a `#S`) to represent the attribute name *Size*. `KeyConditionExpression` then is as follows:
+ `#S = :myval`
For a list of reserved words, see [Reserved Words](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ReservedWords.html) in the *Amazon DynamoDB Developer Guide*.
For more information on `ExpressionAttributeNames` and `ExpressionAttributeValues`, see [Using Placeholders for Attribute Names and Values](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ExpressionPlaceholders.html) in the *Amazon DynamoDB Developer Guide*.
Type: String
Required: No
** [KeyConditions](#API_Query_RequestSyntax) **
This is a legacy parameter. Use `KeyConditionExpression` instead. For more information, see [KeyConditions](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.KeyConditions.html) in the *Amazon DynamoDB Developer Guide*.
Type: String to [Condition](API_Condition.md) object map
Key Length Constraints: Maximum length of 65535.
Required: No
** [Limit](#API_Query_RequestSyntax) **
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 `LastEvaluatedKey` to apply in a subsequent operation, so that you can pick up where you left off. Also, if the processed dataset size exceeds 1 MB before DynamoDB reaches this limit, it stops the operation and returns the matching values up to the limit, and a key in `LastEvaluatedKey` to apply in a subsequent operation to continue the operation. For more information, see [Query and Scan](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/QueryAndScan.html) in the *Amazon DynamoDB Developer Guide*.
Type: Integer
Valid Range: Minimum value of 1.
Required: No
** [ProjectionExpression](#API_Query_RequestSyntax) **
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](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html) in the *Amazon DynamoDB Developer Guide*.
Type: String
Required: No
** [QueryFilter](#API_Query_RequestSyntax) **
This is a legacy parameter. Use `FilterExpression` instead. For more information, see [QueryFilter](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.QueryFilter.html) in the *Amazon DynamoDB Developer Guide*.
Type: String to [Condition](API_Condition.md) object map
Key Length Constraints: Maximum length of 65535.
Required: No
** [ReturnConsumedCapacity](#API_Query_RequestSyntax) **
Determines the level of detail about either provisioned or on-demand throughput consumption that is returned in the response:
+ `INDEXES` - The response includes the aggregate `ConsumedCapacity` for the operation, together with `ConsumedCapacity` for each table and secondary index that was accessed.
Note that some operations, such as `GetItem` and `BatchGetItem`, do not access any indexes at all. In these cases, specifying `INDEXES` will only return `ConsumedCapacity` information for table(s).
+ `TOTAL` - The response includes only the aggregate `ConsumedCapacity` for the operation.
+ `NONE` - No `ConsumedCapacity` details are included in the response.
Type: String
Valid Values: `INDEXES | TOTAL | NONE`
Required: No
** [ScanIndexForward](#API_Query_RequestSyntax) **
Specifies the order for index traversal: If `true` (default), the traversal is performed in ascending order; if `false`, the traversal is performed in descending order.
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 `ScanIndexForward` is `true`, DynamoDB returns the results in the order in which they are stored (by sort key value). This is the default behavior. If `ScanIndexForward` is `false`, DynamoDB reads the results in reverse order by sort key value, and then returns the results to the client.
Type: Boolean
Required: No
** [Select](#API_Query_RequestSyntax) **
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.
+ `ALL_ATTRIBUTES` - Returns all of the item attributes from the specified table or index. If you query a local secondary index, then for each matching item in the index, DynamoDB fetches the entire item from the parent table. If the index is configured to project all item attributes, then all of the data can be obtained from the local secondary index, and no fetching is required.
+ `ALL_PROJECTED_ATTRIBUTES` - Allowed only when querying an index. Retrieves all attributes that have been projected into the index. If the index is configured to project all attributes, this return value is equivalent to specifying `ALL_ATTRIBUTES`.
+ `COUNT` - Returns the number of matching items, rather than the matching items themselves. Note that this uses the same quantity of read capacity units as getting the items, and is subject to the same item size calculations.
+ `SPECIFIC_ATTRIBUTES` - Returns only the attributes listed in `ProjectionExpression`. This return value is equivalent to specifying `ProjectionExpression` without specifying any value for `Select`.
If you query or scan a local secondary index and request only attributes that are projected into that index, the operation will read only the index and not the table. If any of the requested attributes are not projected into the local secondary index, DynamoDB fetches each of these attributes from the parent table. This extra fetching incurs additional throughput cost and latency.
If you query or scan a global secondary index, you can only request attributes that are projected into the index. Global secondary index queries cannot fetch attributes from the parent table.
If neither `Select` nor `ProjectionExpression` are specified, DynamoDB defaults to `ALL_ATTRIBUTES` when accessing a table, and `ALL_PROJECTED_ATTRIBUTES` when accessing an index. You cannot use both `Select` and `ProjectionExpression` together in a single request, unless the value for `Select` is `SPECIFIC_ATTRIBUTES`. (This usage is equivalent to specifying `ProjectionExpression` without any value for `Select`.)
If you use the `ProjectionExpression` parameter, then the value for `Select` can only be `SPECIFIC_ATTRIBUTES`. Any other value for `Select` will return an error.
Type: String
Valid Values: `ALL_ATTRIBUTES | ALL_PROJECTED_ATTRIBUTES | SPECIFIC_ATTRIBUTES | COUNT`
Required: No
## Response Syntax
```
{
"ConsumedCapacity": {
"CapacityUnits": number,
"GlobalSecondaryIndexes": {
"string" : {
"CapacityUnits": number,
"ReadCapacityUnits": number,
"WriteCapacityUnits": number
}
},
"LocalSecondaryIndexes": {
"string" : {
"CapacityUnits": number,
"ReadCapacityUnits": number,
"WriteCapacityUnits": number
}
},
"ReadCapacityUnits": number,
"Table": {
"CapacityUnits": number,
"ReadCapacityUnits": number,
"WriteCapacityUnits": number
},
"TableName": "string",
"WriteCapacityUnits": number
},
"Count": number,
"Items": [
{
"string" : {
"B": blob,
"BOOL": boolean,
"BS": [ blob ],
"L": [
"AttributeValue"
],
"M": {
"string" : "AttributeValue"
},
"N": "string",
"NS": [ "string" ],
"NULL": boolean,
"S": "string",
"SS": [ "string" ]
}
}
],
"LastEvaluatedKey": {
"string" : {
"B": blob,
"BOOL": boolean,
"BS": [ blob ],
"L": [
"AttributeValue"
],
"M": {
"string" : "AttributeValue"
},
"N": "string",
"NS": [ "string" ],
"NULL": boolean,
"S": "string",
"SS": [ "string" ]
}
},
"ScannedCount": number
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [ConsumedCapacity](#API_Query_ResponseSyntax) **
The capacity units consumed by the `Query` operation. The data returned includes the total provisioned throughput consumed, along with statistics for the table and any indexes involved in the operation. `ConsumedCapacity` is only returned if the `ReturnConsumedCapacity` parameter was specified. For more information, see [Capacity unit consumption for read operations](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/read-write-operations.html#read-operation-consumption) in the *Amazon DynamoDB Developer Guide*.
Type: [ConsumedCapacity](API_ConsumedCapacity.md) object
** [Count](#API_Query_ResponseSyntax) **
The number of items in the response.
If you used a `QueryFilter` in the request, then `Count` is the number of items returned after the filter was applied, and `ScannedCount` is the number of matching items before the filter was applied.
If you did not use a filter in the request, then `Count` and `ScannedCount` are the same.
Type: Integer
** [Items](#API_Query_ResponseSyntax) **
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.
Type: Array of string to [AttributeValue](API_AttributeValue.md) object maps
Key Length Constraints: Maximum length of 65535.
** [LastEvaluatedKey](#API_Query_ResponseSyntax) **
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 `LastEvaluatedKey` is empty, then the "last page" of results has been processed and there is no more data to be retrieved.
If `LastEvaluatedKey` is not empty, it does not necessarily mean that there is more data in the result set. The only way to know when you have reached the end of the result set is when `LastEvaluatedKey` is empty.
Type: String to [AttributeValue](API_AttributeValue.md) object map
Key Length Constraints: Maximum length of 65535.
** [ScannedCount](#API_Query_ResponseSyntax) **
The number of items evaluated, before any `QueryFilter` is applied. A high `ScannedCount` value with few, or no, `Count` results indicates an inefficient `Query` operation. For more information, see [Count and ScannedCount](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Scan.html#Scan.Count) in the *Amazon DynamoDB Developer Guide*.
If you did not use a filter in the request, then `ScannedCount` is the same as `Count`.
Type: Integer
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalServerError **
An error occurred on the server side.
** message **
The server encountered an internal error trying to fulfill the request.
HTTP Status Code: 500
** ProvisionedThroughputExceededException **
The request was denied due to request throttling. For detailed information about why the request was throttled and the ARN of the impacted resource, find the [ThrottlingReason](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_ThrottlingReason.html) field in the returned exception. The AWS SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to [Error Retries and Exponential Backoff](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Programming.Errors.html#Programming.Errors.RetryAndBackoff) in the *Amazon DynamoDB Developer Guide*.
** message **
You exceeded your maximum allowed provisioned throughput.
** ThrottlingReasons **
A list of [ThrottlingReason](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_ThrottlingReason.html) that provide detailed diagnostic information about why the request was throttled.
HTTP Status Code: 400
** RequestLimitExceeded **
Throughput exceeds the current throughput quota for your account. For detailed information about why the request was throttled and the ARN of the impacted resource, find the [ThrottlingReason](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_ThrottlingReason.html) field in the returned exception. Contact [Support](https://aws.amazon.com/support) to request a quota increase.
** ThrottlingReasons **
A list of [ThrottlingReason](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_ThrottlingReason.html) that provide detailed diagnostic information about why the request was throttled.
HTTP Status Code: 400
** ResourceNotFoundException **
The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be `ACTIVE`.
** message **
The resource which is being requested does not exist.
HTTP Status Code: 400
** ThrottlingException **
The request was denied due to request throttling. For detailed information about why the request was throttled and the ARN of the impacted resource, find the [ThrottlingReason](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_ThrottlingReason.html) field in the returned exception.
** throttlingReasons **
A list of [ThrottlingReason](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_ThrottlingReason.html) that provide detailed diagnostic information about why the request was throttled.
HTTP Status Code: 400
## Examples
### Retrieve a Range of Items
The following example queries the `Reply` table for replies in a forum that were posted by particular users. There is a local secondary index on the *Reply* table, `PostedBy-Index`, to facilitate fast lookups on these attributes.
The `ProjectionExpression` parameter determines which attributes are returned.
#### Sample Request
```
POST / HTTP/1.1
Host: dynamodb..;
Accept-Encoding: identity
Content-Length:
User-Agent:
Content-Type: application/x-amz-json-1.0
Authorization: AWS4-HMAC-SHA256 Credential=, SignedHeaders=, Signature=
X-Amz-Date:
X-Amz-Target: DynamoDB_20120810.Query
{
"TableName": "Reply",
"IndexName": "PostedBy-Index",
"Limit": 3,
"ConsistentRead": true,
"ProjectionExpression": "Id, PostedBy, ReplyDateTime",
"KeyConditionExpression": "Id = :v1 AND PostedBy BETWEEN :v2a AND :v2b",
"ExpressionAttributeValues": {
":v1": {"S": "Amazon DynamoDB#DynamoDB Thread 1"},
":v2a": {"S": "User A"},
":v2b": {"S": "User C"}
},
"ReturnConsumedCapacity": "TOTAL"
}
```
#### Sample Response
```
HTTP/1.1 200 OK
x-amzn-RequestId:
x-amz-crc32:
Content-Type: application/x-amz-json-1.0
Content-Length:
Date:
{
"ConsumedCapacity": {
"CapacityUnits": 1,
"TableName": "Reply"
},
"Count": 2,
"Items": [
{
"ReplyDateTime": {"S": "2015-02-18T20:27:36.165Z"},
"PostedBy": {"S": "User A"},
"Id": {"S": "Amazon DynamoDB#DynamoDB Thread 1"}
},
{
"ReplyDateTime": {"S": "2015-02-25T20:27:36.165Z"},
"PostedBy": {"S": "User B"},
"Id": {"S": "Amazon DynamoDB#DynamoDB Thread 1"}
}
],
"ScannedCount": 2
}
```
### Count Items
The following example returns the number of items in the `Thread` table for a particular forum.
#### Sample Request
```
POST / HTTP/1.1
Host: dynamodb..;
Accept-Encoding: identity
Content-Length:
User-Agent:
Content-Type: application/x-amz-json-1.0
Authorization: AWS4-HMAC-SHA256 Credential=, SignedHeaders=, Signature=
X-Amz-Date:
X-Amz-Target: DynamoDB_20120810.Query
{
"TableName": "Thread",
"ConsistentRead": true,
"KeyConditionExpression": "ForumName = :val",
"ExpressionAttributeValues": {":val": {"S": "Amazon DynamoDB"}}
}
```
#### Sample Response
```
HTTP/1.1 200 OK
x-amzn-RequestId:
x-amz-crc32:
Content-Type: application/x-amz-json-1.0
Content-Length:
Date:
{
"Count":2,
"ScannedCount":2
}
```
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/dynamodb-2012-08-10/Query)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/dynamodb-2012-08-10/Query)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/Query)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/dynamodb-2012-08-10/Query)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/Query)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/dynamodb-2012-08-10/Query)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/dynamodb-2012-08-10/Query)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/dynamodb-2012-08-10/Query)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/dynamodb-2012-08-10/Query)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/Query)
# RestoreTableFromBackup
Creates a new table from an existing backup. Any number of users can execute up to 50 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 Syntax
```
{
"BackupArn": "string",
"BillingModeOverride": "string",
"GlobalSecondaryIndexOverride": [
{
"IndexName": "string",
"KeySchema": [
{
"AttributeName": "string",
"KeyType": "string"
}
],
"OnDemandThroughput": {
"MaxReadRequestUnits": number,
"MaxWriteRequestUnits": number
},
"Projection": {
"NonKeyAttributes": [ "string" ],
"ProjectionType": "string"
},
"ProvisionedThroughput": {
"ReadCapacityUnits": number,
"WriteCapacityUnits": number
},
"WarmThroughput": {
"ReadUnitsPerSecond": number,
"WriteUnitsPerSecond": number
}
}
],
"LocalSecondaryIndexOverride": [
{
"IndexName": "string",
"KeySchema": [
{
"AttributeName": "string",
"KeyType": "string"
}
],
"Projection": {
"NonKeyAttributes": [ "string" ],
"ProjectionType": "string"
}
}
],
"OnDemandThroughputOverride": {
"MaxReadRequestUnits": number,
"MaxWriteRequestUnits": number
},
"ProvisionedThroughputOverride": {
"ReadCapacityUnits": number,
"WriteCapacityUnits": number
},
"SSESpecificationOverride": {
"Enabled": boolean,
"KMSMasterKeyId": "string",
"SSEType": "string"
},
"TargetTableName": "string"
}
```
## Request Parameters
The request accepts the following data in JSON format.
**Note**
In the following list, the required parameters are described first.
** [BackupArn](#API_RestoreTableFromBackup_RequestSyntax) **
The Amazon Resource Name (ARN) associated with the backup.
Type: String
Length Constraints: Minimum length of 37. Maximum length of 1024.
Required: Yes
** [TargetTableName](#API_RestoreTableFromBackup_RequestSyntax) **
The name of the new table to which the backup must be restored.
Type: String
Length Constraints: Minimum length of 3. Maximum length of 255.
Pattern: `[a-zA-Z0-9_.-]+`
Required: Yes
** [BillingModeOverride](#API_RestoreTableFromBackup_RequestSyntax) **
The billing mode of the restored table.
Type: String
Valid Values: `PROVISIONED | PAY_PER_REQUEST`
Required: No
** [GlobalSecondaryIndexOverride](#API_RestoreTableFromBackup_RequestSyntax) **
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.
Type: Array of [GlobalSecondaryIndex](API_GlobalSecondaryIndex.md) objects
Required: No
** [LocalSecondaryIndexOverride](#API_RestoreTableFromBackup_RequestSyntax) **
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.
Type: Array of [LocalSecondaryIndex](API_LocalSecondaryIndex.md) objects
Required: No
** [OnDemandThroughputOverride](#API_RestoreTableFromBackup_RequestSyntax) **
Sets the maximum number of read and write units for the specified on-demand table. If you use this parameter, you must specify `MaxReadRequestUnits`, `MaxWriteRequestUnits`, or both.
Type: [OnDemandThroughput](API_OnDemandThroughput.md) object
Required: No
** [ProvisionedThroughputOverride](#API_RestoreTableFromBackup_RequestSyntax) **
Provisioned throughput settings for the restored table.
Type: [ProvisionedThroughput](API_ProvisionedThroughput.md) object
Required: No
** [SSESpecificationOverride](#API_RestoreTableFromBackup_RequestSyntax) **
The new server-side encryption settings for the restored table.
Type: [SSESpecification](API_SSESpecification.md) object
Required: No
## Response Syntax
```
{
"TableDescription": {
"ArchivalSummary": {
"ArchivalBackupArn": "string",
"ArchivalDateTime": number,
"ArchivalReason": "string"
},
"AttributeDefinitions": [
{
"AttributeName": "string",
"AttributeType": "string"
}
],
"BillingModeSummary": {
"BillingMode": "string",
"LastUpdateToPayPerRequestDateTime": number
},
"CreationDateTime": number,
"DeletionProtectionEnabled": boolean,
"GlobalSecondaryIndexes": [
{
"Backfilling": boolean,
"IndexArn": "string",
"IndexName": "string",
"IndexSizeBytes": number,
"IndexStatus": "string",
"ItemCount": number,
"KeySchema": [
{
"AttributeName": "string",
"KeyType": "string"
}
],
"OnDemandThroughput": {
"MaxReadRequestUnits": number,
"MaxWriteRequestUnits": number
},
"Projection": {
"NonKeyAttributes": [ "string" ],
"ProjectionType": "string"
},
"ProvisionedThroughput": {
"LastDecreaseDateTime": number,
"LastIncreaseDateTime": number,
"NumberOfDecreasesToday": number,
"ReadCapacityUnits": number,
"WriteCapacityUnits": number
},
"WarmThroughput": {
"ReadUnitsPerSecond": number,
"Status": "string",
"WriteUnitsPerSecond": number
}
}
],
"GlobalTableSettingsReplicationMode": "string",
"GlobalTableVersion": "string",
"GlobalTableWitnesses": [
{
"RegionName": "string",
"WitnessStatus": "string"
}
],
"ItemCount": number,
"KeySchema": [
{
"AttributeName": "string",
"KeyType": "string"
}
],
"LatestStreamArn": "string",
"LatestStreamLabel": "string",
"LocalSecondaryIndexes": [
{
"IndexArn": "string",
"IndexName": "string",
"IndexSizeBytes": number,
"ItemCount": number,
"KeySchema": [
{
"AttributeName": "string",
"KeyType": "string"
}
],
"Projection": {
"NonKeyAttributes": [ "string" ],
"ProjectionType": "string"
}
}
],
"MultiRegionConsistency": "string",
"OnDemandThroughput": {
"MaxReadRequestUnits": number,
"MaxWriteRequestUnits": number
},
"ProvisionedThroughput": {
"LastDecreaseDateTime": number,
"LastIncreaseDateTime": number,
"NumberOfDecreasesToday": number,
"ReadCapacityUnits": number,
"WriteCapacityUnits": number
},
"Replicas": [
{
"GlobalSecondaryIndexes": [
{
"IndexName": "string",
"OnDemandThroughputOverride": {
"MaxReadRequestUnits": number
},
"ProvisionedThroughputOverride": {
"ReadCapacityUnits": number
},
"WarmThroughput": {
"ReadUnitsPerSecond": number,
"Status": "string",
"WriteUnitsPerSecond": number
}
}
],
"GlobalTableSettingsReplicationMode": "string",
"KMSMasterKeyId": "string",
"OnDemandThroughputOverride": {
"MaxReadRequestUnits": number
},
"ProvisionedThroughputOverride": {
"ReadCapacityUnits": number
},
"RegionName": "string",
"ReplicaArn": "string",
"ReplicaInaccessibleDateTime": number,
"ReplicaStatus": "string",
"ReplicaStatusDescription": "string",
"ReplicaStatusPercentProgress": "string",
"ReplicaTableClassSummary": {
"LastUpdateDateTime": number,
"TableClass": "string"
},
"WarmThroughput": {
"ReadUnitsPerSecond": number,
"Status": "string",
"WriteUnitsPerSecond": number
}
}
],
"RestoreSummary": {
"RestoreDateTime": number,
"RestoreInProgress": boolean,
"SourceBackupArn": "string",
"SourceTableArn": "string"
},
"SSEDescription": {
"InaccessibleEncryptionDateTime": number,
"KMSMasterKeyArn": "string",
"SSEType": "string",
"Status": "string"
},
"StreamSpecification": {
"StreamEnabled": boolean,
"StreamViewType": "string"
},
"TableArn": "string",
"TableClassSummary": {
"LastUpdateDateTime": number,
"TableClass": "string"
},
"TableId": "string",
"TableName": "string",
"TableSizeBytes": number,
"TableStatus": "string",
"WarmThroughput": {
"ReadUnitsPerSecond": number,
"Status": "string",
"WriteUnitsPerSecond": number
}
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [TableDescription](#API_RestoreTableFromBackup_ResponseSyntax) **
The description of the table created from an existing backup.
Type: [TableDescription](API_TableDescription.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** BackupInUseException **
There is another ongoing conflicting backup control plane operation on the table. The backup is either being created, deleted or restored to a table.
HTTP Status Code: 400
** BackupNotFoundException **
Backup not found for the given BackupARN.
HTTP Status Code: 400
** InternalServerError **
An error occurred on the server side.
** message **
The server encountered an internal error trying to fulfill the request.
HTTP Status Code: 500
** LimitExceededException **
There is no limit to the number of daily on-demand backups that can be taken.
For most purposes, up to 500 simultaneous table operations are allowed per account. These operations include `CreateTable`, `UpdateTable`, `DeleteTable`,`UpdateTimeToLive`, `RestoreTableFromBackup`, and `RestoreTableToPointInTime`.
When you are creating a table with one or more secondary indexes, you can have up to 250 such requests running at a time. However, if the table or index specifications are complex, then DynamoDB might temporarily reduce the number of concurrent operations.
When importing into DynamoDB, up to 50 simultaneous import table operations are allowed per account.
There is a soft account quota of 2,500 tables.
GetRecords was called with a value of more than 1000 for the limit request parameter.
More than 2 processes are reading from the same streams shard at the same time. Exceeding this limit may result in request throttling.
** message **
Too many operations for a given subscriber.
HTTP Status Code: 400
** TableAlreadyExistsException **
A target table with the specified name already exists.
HTTP Status Code: 400
** TableInUseException **
A target table with the specified name is either being created or deleted.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/dynamodb-2012-08-10/RestoreTableFromBackup)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/dynamodb-2012-08-10/RestoreTableFromBackup)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/RestoreTableFromBackup)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/dynamodb-2012-08-10/RestoreTableFromBackup)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/RestoreTableFromBackup)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/dynamodb-2012-08-10/RestoreTableFromBackup)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/dynamodb-2012-08-10/RestoreTableFromBackup)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/dynamodb-2012-08-10/RestoreTableFromBackup)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/dynamodb-2012-08-10/RestoreTableFromBackup)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/RestoreTableFromBackup)
# RestoreTableToPointInTime
Restores the specified table to the specified point in time within `EarliestRestorableDateTime` and `LatestRestorableDateTime`. You can restore your table to any point in time in the last 35 days. You can set the recovery period to any value between 1 and 35 days. Any number of users can execute up to 50 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
**Important**
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 Syntax
```
{
"BillingModeOverride": "string",
"GlobalSecondaryIndexOverride": [
{
"IndexName": "string",
"KeySchema": [
{
"AttributeName": "string",
"KeyType": "string"
}
],
"OnDemandThroughput": {
"MaxReadRequestUnits": number,
"MaxWriteRequestUnits": number
},
"Projection": {
"NonKeyAttributes": [ "string" ],
"ProjectionType": "string"
},
"ProvisionedThroughput": {
"ReadCapacityUnits": number,
"WriteCapacityUnits": number
},
"WarmThroughput": {
"ReadUnitsPerSecond": number,
"WriteUnitsPerSecond": number
}
}
],
"LocalSecondaryIndexOverride": [
{
"IndexName": "string",
"KeySchema": [
{
"AttributeName": "string",
"KeyType": "string"
}
],
"Projection": {
"NonKeyAttributes": [ "string" ],
"ProjectionType": "string"
}
}
],
"OnDemandThroughputOverride": {
"MaxReadRequestUnits": number,
"MaxWriteRequestUnits": number
},
"ProvisionedThroughputOverride": {
"ReadCapacityUnits": number,
"WriteCapacityUnits": number
},
"RestoreDateTime": number,
"SourceTableArn": "string",
"SourceTableName": "string",
"SSESpecificationOverride": {
"Enabled": boolean,
"KMSMasterKeyId": "string",
"SSEType": "string"
},
"TargetTableName": "string",
"UseLatestRestorableTime": boolean
}
```
## Request Parameters
The request accepts the following data in JSON format.
**Note**
In the following list, the required parameters are described first.
** [TargetTableName](#API_RestoreTableToPointInTime_RequestSyntax) **
The name of the new table to which it must be restored to.
Type: String
Length Constraints: Minimum length of 3. Maximum length of 255.
Pattern: `[a-zA-Z0-9_.-]+`
Required: Yes
** [BillingModeOverride](#API_RestoreTableToPointInTime_RequestSyntax) **
The billing mode of the restored table.
Type: String
Valid Values: `PROVISIONED | PAY_PER_REQUEST`
Required: No
** [GlobalSecondaryIndexOverride](#API_RestoreTableToPointInTime_RequestSyntax) **
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.
Type: Array of [GlobalSecondaryIndex](API_GlobalSecondaryIndex.md) objects
Required: No
** [LocalSecondaryIndexOverride](#API_RestoreTableToPointInTime_RequestSyntax) **
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.
Type: Array of [LocalSecondaryIndex](API_LocalSecondaryIndex.md) objects
Required: No
** [OnDemandThroughputOverride](#API_RestoreTableToPointInTime_RequestSyntax) **
Sets the maximum number of read and write units for the specified on-demand table. If you use this parameter, you must specify `MaxReadRequestUnits`, `MaxWriteRequestUnits`, or both.
Type: [OnDemandThroughput](API_OnDemandThroughput.md) object
Required: No
** [ProvisionedThroughputOverride](#API_RestoreTableToPointInTime_RequestSyntax) **
Provisioned throughput settings for the restored table.
Type: [ProvisionedThroughput](API_ProvisionedThroughput.md) object
Required: No
** [RestoreDateTime](#API_RestoreTableToPointInTime_RequestSyntax) **
Time in the past to restore the table to.
Type: Timestamp
Required: No
** [SourceTableArn](#API_RestoreTableToPointInTime_RequestSyntax) **
The DynamoDB table that will be restored. This value is an Amazon Resource Name (ARN).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: No
** [SourceTableName](#API_RestoreTableToPointInTime_RequestSyntax) **
Name of the source table that is being restored.
Type: String
Length Constraints: Minimum length of 3. Maximum length of 255.
Pattern: `[a-zA-Z0-9_.-]+`
Required: No
** [SSESpecificationOverride](#API_RestoreTableToPointInTime_RequestSyntax) **
The new server-side encryption settings for the restored table.
Type: [SSESpecification](API_SSESpecification.md) object
Required: No
** [UseLatestRestorableTime](#API_RestoreTableToPointInTime_RequestSyntax) **
Restore the table to the latest possible time. `LatestRestorableDateTime` is typically 5 minutes before the current time.
Type: Boolean
Required: No
## Response Syntax
```
{
"TableDescription": {
"ArchivalSummary": {
"ArchivalBackupArn": "string",
"ArchivalDateTime": number,
"ArchivalReason": "string"
},
"AttributeDefinitions": [
{
"AttributeName": "string",
"AttributeType": "string"
}
],
"BillingModeSummary": {
"BillingMode": "string",
"LastUpdateToPayPerRequestDateTime": number
},
"CreationDateTime": number,
"DeletionProtectionEnabled": boolean,
"GlobalSecondaryIndexes": [
{
"Backfilling": boolean,
"IndexArn": "string",
"IndexName": "string",
"IndexSizeBytes": number,
"IndexStatus": "string",
"ItemCount": number,
"KeySchema": [
{
"AttributeName": "string",
"KeyType": "string"
}
],
"OnDemandThroughput": {
"MaxReadRequestUnits": number,
"MaxWriteRequestUnits": number
},
"Projection": {
"NonKeyAttributes": [ "string" ],
"ProjectionType": "string"
},
"ProvisionedThroughput": {
"LastDecreaseDateTime": number,
"LastIncreaseDateTime": number,
"NumberOfDecreasesToday": number,
"ReadCapacityUnits": number,
"WriteCapacityUnits": number
},
"WarmThroughput": {
"ReadUnitsPerSecond": number,
"Status": "string",
"WriteUnitsPerSecond": number
}
}
],
"GlobalTableSettingsReplicationMode": "string",
"GlobalTableVersion": "string",
"GlobalTableWitnesses": [
{
"RegionName": "string",
"WitnessStatus": "string"
}
],
"ItemCount": number,
"KeySchema": [
{
"AttributeName": "string",
"KeyType": "string"
}
],
"LatestStreamArn": "string",
"LatestStreamLabel": "string",
"LocalSecondaryIndexes": [
{
"IndexArn": "string",
"IndexName": "string",
"IndexSizeBytes": number,
"ItemCount": number,
"KeySchema": [
{
"AttributeName": "string",
"KeyType": "string"
}
],
"Projection": {
"NonKeyAttributes": [ "string" ],
"ProjectionType": "string"
}
}
],
"MultiRegionConsistency": "string",
"OnDemandThroughput": {
"MaxReadRequestUnits": number,
"MaxWriteRequestUnits": number
},
"ProvisionedThroughput": {
"LastDecreaseDateTime": number,
"LastIncreaseDateTime": number,
"NumberOfDecreasesToday": number,
"ReadCapacityUnits": number,
"WriteCapacityUnits": number
},
"Replicas": [
{
"GlobalSecondaryIndexes": [
{
"IndexName": "string",
"OnDemandThroughputOverride": {
"MaxReadRequestUnits": number
},
"ProvisionedThroughputOverride": {
"ReadCapacityUnits": number
},
"WarmThroughput": {
"ReadUnitsPerSecond": number,
"Status": "string",
"WriteUnitsPerSecond": number
}
}
],
"GlobalTableSettingsReplicationMode": "string",
"KMSMasterKeyId": "string",
"OnDemandThroughputOverride": {
"MaxReadRequestUnits": number
},
"ProvisionedThroughputOverride": {
"ReadCapacityUnits": number
},
"RegionName": "string",
"ReplicaArn": "string",
"ReplicaInaccessibleDateTime": number,
"ReplicaStatus": "string",
"ReplicaStatusDescription": "string",
"ReplicaStatusPercentProgress": "string",
"ReplicaTableClassSummary": {
"LastUpdateDateTime": number,
"TableClass": "string"
},
"WarmThroughput": {
"ReadUnitsPerSecond": number,
"Status": "string",
"WriteUnitsPerSecond": number
}
}
],
"RestoreSummary": {
"RestoreDateTime": number,
"RestoreInProgress": boolean,
"SourceBackupArn": "string",
"SourceTableArn": "string"
},
"SSEDescription": {
"InaccessibleEncryptionDateTime": number,
"KMSMasterKeyArn": "string",
"SSEType": "string",
"Status": "string"
},
"StreamSpecification": {
"StreamEnabled": boolean,
"StreamViewType": "string"
},
"TableArn": "string",
"TableClassSummary": {
"LastUpdateDateTime": number,
"TableClass": "string"
},
"TableId": "string",
"TableName": "string",
"TableSizeBytes": number,
"TableStatus": "string",
"WarmThroughput": {
"ReadUnitsPerSecond": number,
"Status": "string",
"WriteUnitsPerSecond": number
}
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [TableDescription](#API_RestoreTableToPointInTime_ResponseSyntax) **
Represents the properties of a table.
Type: [TableDescription](API_TableDescription.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalServerError **
An error occurred on the server side.
** message **
The server encountered an internal error trying to fulfill the request.
HTTP Status Code: 500
** InvalidRestoreTimeException **
An invalid restore time was specified. RestoreDateTime must be between EarliestRestorableDateTime and LatestRestorableDateTime.
HTTP Status Code: 400
** LimitExceededException **
There is no limit to the number of daily on-demand backups that can be taken.
For most purposes, up to 500 simultaneous table operations are allowed per account. These operations include `CreateTable`, `UpdateTable`, `DeleteTable`,`UpdateTimeToLive`, `RestoreTableFromBackup`, and `RestoreTableToPointInTime`.
When you are creating a table with one or more secondary indexes, you can have up to 250 such requests running at a time. However, if the table or index specifications are complex, then DynamoDB might temporarily reduce the number of concurrent operations.
When importing into DynamoDB, up to 50 simultaneous import table operations are allowed per account.
There is a soft account quota of 2,500 tables.
GetRecords was called with a value of more than 1000 for the limit request parameter.
More than 2 processes are reading from the same streams shard at the same time. Exceeding this limit may result in request throttling.
** message **
Too many operations for a given subscriber.
HTTP Status Code: 400
** PointInTimeRecoveryUnavailableException **
Point in time recovery has not yet been enabled for this source table.
HTTP Status Code: 400
** TableAlreadyExistsException **
A target table with the specified name already exists.
HTTP Status Code: 400
** TableInUseException **
A target table with the specified name is either being created or deleted.
HTTP Status Code: 400
** TableNotFoundException **
A source table with the name `TableName` does not currently exist within the subscriber's account or the subscriber is operating in the wrong AWS Region.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/dynamodb-2012-08-10/RestoreTableToPointInTime)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/dynamodb-2012-08-10/RestoreTableToPointInTime)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/RestoreTableToPointInTime)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/dynamodb-2012-08-10/RestoreTableToPointInTime)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/RestoreTableToPointInTime)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/dynamodb-2012-08-10/RestoreTableToPointInTime)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/dynamodb-2012-08-10/RestoreTableToPointInTime)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/dynamodb-2012-08-10/RestoreTableToPointInTime)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/dynamodb-2012-08-10/RestoreTableToPointInTime)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/RestoreTableToPointInTime)
# Scan
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 size of scanned items exceeds the maximum dataset size limit of 1 MB, the scan completes and results are returned to the user. The `LastEvaluatedKey` value is also returned and the requestor can use the `LastEvaluatedKey` to continue the scan in a subsequent operation. Each scan response also includes number of items that were scanned (ScannedCount) as part of the request. If using a `FilterExpression`, a scan result can result in no items meeting the criteria and the `Count` will result in zero. If you did not use a `FilterExpression` in the scan request, then `Count` is the same as `ScannedCount`.
**Note**
`Count` and `ScannedCount` only return the count of items specific to a single scan request and, unless the table is less than 1MB, do not represent the total number of items in the table.
A single `Scan` operation first reads up to the maximum number of items set (if using the `Limit` parameter) or a maximum of 1 MB of data and then applies any filtering to the results if a `FilterExpression` is provided. If `LastEvaluatedKey` is present in the response, pagination is required to complete the full table scan. For more information, see [Paginating the Results](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Scan.html#Scan.Pagination) 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](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Scan.html#Scan.ParallelScan) in the *Amazon DynamoDB Developer Guide*.
By default, a `Scan` uses eventually consistent reads when accessing the items in a table. Therefore, the results from an eventually consistent `Scan` may not include the latest item changes at the time the scan iterates through each item in the table. If you require a strongly consistent read of each item as the scan iterates through the items in the table, you can set the `ConsistentRead` parameter to true. Strong consistency only relates to the consistency of the read at the item level.
**Note**
DynamoDB does not provide snapshot isolation for a scan operation when the `ConsistentRead` parameter is set to true. Thus, a DynamoDB scan operation does not guarantee that all reads in a scan see a consistent snapshot of the table when the scan operation was requested.
## Request Syntax
```
{
"AttributesToGet": [ "string" ],
"ConditionalOperator": "string",
"ConsistentRead": boolean,
"ExclusiveStartKey": {
"string" : {
"B": blob,
"BOOL": boolean,
"BS": [ blob ],
"L": [
"AttributeValue"
],
"M": {
"string" : "AttributeValue"
},
"N": "string",
"NS": [ "string" ],
"NULL": boolean,
"S": "string",
"SS": [ "string" ]
}
},
"ExpressionAttributeNames": {
"string" : "string"
},
"ExpressionAttributeValues": {
"string" : {
"B": blob,
"BOOL": boolean,
"BS": [ blob ],
"L": [
"AttributeValue"
],
"M": {
"string" : "AttributeValue"
},
"N": "string",
"NS": [ "string" ],
"NULL": boolean,
"S": "string",
"SS": [ "string" ]
}
},
"FilterExpression": "string",
"IndexName": "string",
"Limit": number,
"ProjectionExpression": "string",
"ReturnConsumedCapacity": "string",
"ScanFilter": {
"string" : {
"AttributeValueList": [
{
"B": blob,
"BOOL": boolean,
"BS": [ blob ],
"L": [
"AttributeValue"
],
"M": {
"string" : "AttributeValue"
},
"N": "string",
"NS": [ "string" ],
"NULL": boolean,
"S": "string",
"SS": [ "string" ]
}
],
"ComparisonOperator": "string"
}
},
"Segment": number,
"Select": "string",
"TableName": "string",
"TotalSegments": number
}
```
## Request Parameters
The request accepts the following data in JSON format.
**Note**
In the following list, the required parameters are described first.
** [TableName](#API_Scan_RequestSyntax) **
The name of the table containing the requested items or if you provide `IndexName`, the name of the table to which that index belongs.
You can also provide the Amazon Resource Name (ARN) of the table in this parameter.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: Yes
** [AttributesToGet](#API_Scan_RequestSyntax) **
This is a legacy parameter. Use `ProjectionExpression` instead. For more information, see [AttributesToGet](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.AttributesToGet.html) in the *Amazon DynamoDB Developer Guide*.
Type: Array of strings
Array Members: Minimum number of 1 item.
Length Constraints: Maximum length of 65535.
Required: No
** [ConditionalOperator](#API_Scan_RequestSyntax) **
This is a legacy parameter. Use `FilterExpression` instead. For more information, see [ConditionalOperator](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.ConditionalOperator.html) in the *Amazon DynamoDB Developer Guide*.
Type: String
Valid Values: `AND | OR`
Required: No
** [ConsistentRead](#API_Scan_RequestSyntax) **
A Boolean value that determines the read consistency model during the scan:
+ If `ConsistentRead` is `false`, then the data returned from `Scan` might not contain the results from other recently completed write operations (`PutItem`, `UpdateItem`, or `DeleteItem`).
+ If `ConsistentRead` is `true`, then all of the write operations that completed before the `Scan` began are guaranteed to be contained in the `Scan` response.
The default setting for `ConsistentRead` is `false`.
The `ConsistentRead` parameter is not supported on global secondary indexes. If you scan a global secondary index with `ConsistentRead` set to true, you will receive a `ValidationException`.
Type: Boolean
Required: No
** [ExclusiveStartKey](#API_Scan_RequestSyntax) **
The primary key of the first item that this operation will evaluate. Use the value that was returned for `LastEvaluatedKey` in the previous operation.
The data type for `ExclusiveStartKey` must be String, Number or Binary. No set data types are allowed.
In a parallel scan, a `Scan` request that includes `ExclusiveStartKey` must specify the same segment whose previous `Scan` returned the corresponding value of `LastEvaluatedKey`.
Type: String to [AttributeValue](API_AttributeValue.md) object map
Key Length Constraints: Maximum length of 65535.
Required: No
** [ExpressionAttributeNames](#API_Scan_RequestSyntax) **
One or more substitution tokens for attribute names in an expression. The following are some use cases for using `ExpressionAttributeNames`:
+ To access an attribute whose name conflicts with a DynamoDB reserved word.
+ To create a placeholder for repeating occurrences of an attribute name in an expression.
+ To prevent special characters in an attribute name from being misinterpreted in an expression.
Use the **\$1** character in an expression to dereference an attribute name. For example, consider the following attribute name:
+ `Percentile`
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](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ReservedWords.html) in the *Amazon DynamoDB Developer Guide*). To work around this, you could specify the following for `ExpressionAttributeNames`:
+ `{"#P":"Percentile"}`
You could then use this substitution in an expression, as in this example:
+ `#P = :val`
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](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html) in the *Amazon DynamoDB Developer Guide*.
Type: String to string map
Value Length Constraints: Maximum length of 65535.
Required: No
** [ExpressionAttributeValues](#API_Scan_RequestSyntax) **
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:
`Available | Backordered | Discontinued`
You would first need to specify `ExpressionAttributeValues` as follows:
`{ ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }`
You could then use these values in an expression, such as this:
`ProductStatus IN (:avail, :back, :disc)`
For more information on expression attribute values, see [Condition Expressions](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.SpecifyingConditions.html) in the *Amazon DynamoDB Developer Guide*.
Type: String to [AttributeValue](API_AttributeValue.md) object map
Required: No
** [FilterExpression](#API_Scan_RequestSyntax) **
A string that contains conditions that DynamoDB applies after the `Scan` operation, but before the data is returned to you. Items that do not satisfy the `FilterExpression` criteria are not returned.
A `FilterExpression` is applied after the items have already been read; the process of filtering does not consume any additional read capacity units.
For more information, see [Filter Expressions](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Scan.html#Scan.FilterExpression) in the *Amazon DynamoDB Developer Guide*.
Type: String
Required: No
** [IndexName](#API_Scan_RequestSyntax) **
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 `IndexName` parameter, you must also provide `TableName`.
Type: String
Length Constraints: Minimum length of 3. Maximum length of 255.
Pattern: `[a-zA-Z0-9_.-]+`
Required: No
** [Limit](#API_Scan_RequestSyntax) **
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 `LastEvaluatedKey` to apply in a subsequent operation, so that you can pick up where you left off. Also, if the processed dataset size exceeds 1 MB before DynamoDB reaches this limit, it stops the operation and returns the matching values up to the limit, and a key in `LastEvaluatedKey` to apply in a subsequent operation to continue the operation. For more information, see [Working with Queries](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/QueryAndScan.html) in the *Amazon DynamoDB Developer Guide*.
Type: Integer
Valid Range: Minimum value of 1.
Required: No
** [ProjectionExpression](#API_Scan_RequestSyntax) **
A string that identifies one or more attributes to retrieve from the specified table or index. 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 [Specifying Item Attributes](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html) in the *Amazon DynamoDB Developer Guide*.
Type: String
Required: No
** [ReturnConsumedCapacity](#API_Scan_RequestSyntax) **
Determines the level of detail about either provisioned or on-demand throughput consumption that is returned in the response:
+ `INDEXES` - The response includes the aggregate `ConsumedCapacity` for the operation, together with `ConsumedCapacity` for each table and secondary index that was accessed.
Note that some operations, such as `GetItem` and `BatchGetItem`, do not access any indexes at all. In these cases, specifying `INDEXES` will only return `ConsumedCapacity` information for table(s).
+ `TOTAL` - The response includes only the aggregate `ConsumedCapacity` for the operation.
+ `NONE` - No `ConsumedCapacity` details are included in the response.
Type: String
Valid Values: `INDEXES | TOTAL | NONE`
Required: No
** [ScanFilter](#API_Scan_RequestSyntax) **
This is a legacy parameter. Use `FilterExpression` instead. For more information, see [ScanFilter](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.ScanFilter.html) in the *Amazon DynamoDB Developer Guide*.
Type: String to [Condition](API_Condition.md) object map
Key Length Constraints: Maximum length of 65535.
Required: No
** [Segment](#API_Scan_RequestSyntax) **
For a parallel `Scan` request, `Segment` identifies an individual segment to be scanned by an application worker.
Segment IDs are zero-based, so the first segment is always 0. For example, if you want to use four application threads to scan a table or an index, then the first thread specifies a `Segment` value of 0, the second thread specifies 1, and so on.
The value of `LastEvaluatedKey` returned from a parallel `Scan` request must be used as `ExclusiveStartKey` with the same segment ID in a subsequent `Scan` operation.
The value for `Segment` must be greater than or equal to 0, and less than the value provided for `TotalSegments`.
If you provide `Segment`, you must also provide `TotalSegments`.
Type: Integer
Valid Range: Minimum value of 0. Maximum value of 999999.
Required: No
** [Select](#API_Scan_RequestSyntax) **
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.
+ `ALL_ATTRIBUTES` - Returns all of the item attributes from the specified table or index. If you query a local secondary index, then for each matching item in the index, DynamoDB fetches the entire item from the parent table. If the index is configured to project all item attributes, then all of the data can be obtained from the local secondary index, and no fetching is required.
+ `ALL_PROJECTED_ATTRIBUTES` - Allowed only when querying an index. Retrieves all attributes that have been projected into the index. If the index is configured to project all attributes, this return value is equivalent to specifying `ALL_ATTRIBUTES`.
+ `COUNT` - Returns the number of matching items, rather than the matching items themselves. Note that this uses the same quantity of read capacity units as getting the items, and is subject to the same item size calculations.
+ `SPECIFIC_ATTRIBUTES` - Returns only the attributes listed in `ProjectionExpression`. This return value is equivalent to specifying `ProjectionExpression` without specifying any value for `Select`.
If you query or scan a local secondary index and request only attributes that are projected into that index, the operation reads only the index and not the table. If any of the requested attributes are not projected into the local secondary index, DynamoDB fetches each of these attributes from the parent table. This extra fetching incurs additional throughput cost and latency.
If you query or scan a global secondary index, you can only request attributes that are projected into the index. Global secondary index queries cannot fetch attributes from the parent table.
If neither `Select` nor `ProjectionExpression` are specified, DynamoDB defaults to `ALL_ATTRIBUTES` when accessing a table, and `ALL_PROJECTED_ATTRIBUTES` when accessing an index. You cannot use both `Select` and `ProjectionExpression` together in a single request, unless the value for `Select` is `SPECIFIC_ATTRIBUTES`. (This usage is equivalent to specifying `ProjectionExpression` without any value for `Select`.)
If you use the `ProjectionExpression` parameter, then the value for `Select` can only be `SPECIFIC_ATTRIBUTES`. Any other value for `Select` will return an error.
Type: String
Valid Values: `ALL_ATTRIBUTES | ALL_PROJECTED_ATTRIBUTES | SPECIFIC_ATTRIBUTES | COUNT`
Required: No
** [TotalSegments](#API_Scan_RequestSyntax) **
For a parallel `Scan` request, `TotalSegments` represents the total number of segments into which the `Scan` operation will be divided. The value of `TotalSegments` corresponds to the number of application workers that will perform the parallel scan. For example, if you want to use four application threads to scan a table or an index, specify a `TotalSegments` value of 4.
The value for `TotalSegments` must be greater than or equal to 1, and less than or equal to 1000000. If you specify a `TotalSegments` value of 1, the `Scan` operation will be sequential rather than parallel.
If you specify `TotalSegments`, you must also specify `Segment`.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 1000000.
Required: No
## Response Syntax
```
{
"ConsumedCapacity": {
"CapacityUnits": number,
"GlobalSecondaryIndexes": {
"string" : {
"CapacityUnits": number,
"ReadCapacityUnits": number,
"WriteCapacityUnits": number
}
},
"LocalSecondaryIndexes": {
"string" : {
"CapacityUnits": number,
"ReadCapacityUnits": number,
"WriteCapacityUnits": number
}
},
"ReadCapacityUnits": number,
"Table": {
"CapacityUnits": number,
"ReadCapacityUnits": number,
"WriteCapacityUnits": number
},
"TableName": "string",
"WriteCapacityUnits": number
},
"Count": number,
"Items": [
{
"string" : {
"B": blob,
"BOOL": boolean,
"BS": [ blob ],
"L": [
"AttributeValue"
],
"M": {
"string" : "AttributeValue"
},
"N": "string",
"NS": [ "string" ],
"NULL": boolean,
"S": "string",
"SS": [ "string" ]
}
}
],
"LastEvaluatedKey": {
"string" : {
"B": blob,
"BOOL": boolean,
"BS": [ blob ],
"L": [
"AttributeValue"
],
"M": {
"string" : "AttributeValue"
},
"N": "string",
"NS": [ "string" ],
"NULL": boolean,
"S": "string",
"SS": [ "string" ]
}
},
"ScannedCount": number
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [ConsumedCapacity](#API_Scan_ResponseSyntax) **
The capacity units consumed by the `Scan` operation. The data returned includes the total provisioned throughput consumed, along with statistics for the table and any indexes involved in the operation. `ConsumedCapacity` is only returned if the `ReturnConsumedCapacity` parameter was specified. For more information, see [Capacity unit consumption for read operations](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/read-write-operations.html#read-operation-consumption) in the *Amazon DynamoDB Developer Guide*.
Type: [ConsumedCapacity](API_ConsumedCapacity.md) object
** [Count](#API_Scan_ResponseSyntax) **
The number of items in the response.
If you set `ScanFilter` in the request, then `Count` is the number of items returned after the filter was applied, and `ScannedCount` is the number of matching items before the filter was applied.
If you did not use a filter in the request, then `Count` is the same as `ScannedCount`.
Type: Integer
** [Items](#API_Scan_ResponseSyntax) **
An array of item attributes that match the scan criteria. Each element in this array consists of an attribute name and the value for that attribute.
Type: Array of string to [AttributeValue](API_AttributeValue.md) object maps
Key Length Constraints: Maximum length of 65535.
** [LastEvaluatedKey](#API_Scan_ResponseSyntax) **
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 `LastEvaluatedKey` is empty, then the "last page" of results has been processed and there is no more data to be retrieved.
If `LastEvaluatedKey` is not empty, it does not necessarily mean that there is more data in the result set. The only way to know when you have reached the end of the result set is when `LastEvaluatedKey` is empty.
Type: String to [AttributeValue](API_AttributeValue.md) object map
Key Length Constraints: Maximum length of 65535.
** [ScannedCount](#API_Scan_ResponseSyntax) **
The number of items evaluated, before any `ScanFilter` is applied. A high `ScannedCount` value with few, or no, `Count` results indicates an inefficient `Scan` operation. For more information, see [Count and ScannedCount](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/QueryAndScan.html#Count) in the *Amazon DynamoDB Developer Guide*.
If you did not use a filter in the request, then `ScannedCount` is the same as `Count`.
Type: Integer
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalServerError **
An error occurred on the server side.
** message **
The server encountered an internal error trying to fulfill the request.
HTTP Status Code: 500
** ProvisionedThroughputExceededException **
The request was denied due to request throttling. For detailed information about why the request was throttled and the ARN of the impacted resource, find the [ThrottlingReason](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_ThrottlingReason.html) field in the returned exception. The AWS SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to [Error Retries and Exponential Backoff](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Programming.Errors.html#Programming.Errors.RetryAndBackoff) in the *Amazon DynamoDB Developer Guide*.
** message **
You exceeded your maximum allowed provisioned throughput.
** ThrottlingReasons **
A list of [ThrottlingReason](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_ThrottlingReason.html) that provide detailed diagnostic information about why the request was throttled.
HTTP Status Code: 400
** RequestLimitExceeded **
Throughput exceeds the current throughput quota for your account. For detailed information about why the request was throttled and the ARN of the impacted resource, find the [ThrottlingReason](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_ThrottlingReason.html) field in the returned exception. Contact [Support](https://aws.amazon.com/support) to request a quota increase.
** ThrottlingReasons **
A list of [ThrottlingReason](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_ThrottlingReason.html) that provide detailed diagnostic information about why the request was throttled.
HTTP Status Code: 400
** ResourceNotFoundException **
The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be `ACTIVE`.
** message **
The resource which is being requested does not exist.
HTTP Status Code: 400
** ThrottlingException **
The request was denied due to request throttling. For detailed information about why the request was throttled and the ARN of the impacted resource, find the [ThrottlingReason](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_ThrottlingReason.html) field in the returned exception.
** throttlingReasons **
A list of [ThrottlingReason](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_ThrottlingReason.html) that provide detailed diagnostic information about why the request was throttled.
HTTP Status Code: 400
## Examples
### Return All Items
The following example returns all of the items in a table. No scan filter is applied.
#### Sample Request
```
POST / HTTP/1.1
Host: dynamodb..;
Accept-Encoding: identity
Content-Length:
User-Agent:
Content-Type: application/x-amz-json-1.0
Authorization: AWS4-HMAC-SHA256 Credential=, SignedHeaders=, Signature=
X-Amz-Date:
X-Amz-Target: DynamoDB_20120810.Scan
{
"TableName": "Reply",
"ReturnConsumedCapacity": "TOTAL"
}
```
#### Sample Response
```
HTTP/1.1 200 OK
x-amzn-RequestId:
x-amz-crc32:
Content-Type: application/x-amz-json-1.0
Content-Length:
Date:
{
"ConsumedCapacity": {
"CapacityUnits": 0.5,
"TableName": "Reply"
},
"Count": 4,
"Items": [
{
"PostedBy": {
"S": "joe@example.com"
},
"ReplyDateTime": {
"S": "20130320115336"
},
"Id": {
"S": "Amazon DynamoDB#How do I update multiple items?"
},
"Message": {
"S": "Have you looked at BatchWriteItem?"
}
},
{
"PostedBy": {
"S": "fred@example.com"
},
"ReplyDateTime": {
"S": "20130320115342"
},
"Id": {
"S": "Amazon DynamoDB#How do I update multiple items?"
},
"Message": {
"S": "No, I didn't know about that. Where can I find more information?"
}
},
{
"PostedBy": {
"S": "joe@example.com"
},
"ReplyDateTime": {
"S": "20130320115347"
},
"Id": {
"S": "Amazon DynamoDB#How do I update multiple items?"
},
"Message": {
"S": "BatchWriteItem is documented in the Amazon DynamoDB API Reference."
}
},
{
"PostedBy": {
"S": "fred@example.com"
},
"ReplyDateTime": {
"S": "20130320115352"
},
"Id": {
"S": "Amazon DynamoDB#How do I update multiple items?"
},
"Message": {
"S": "OK, I'll take a look at that. Thanks!"
}
}
],
"ScannedCount": 4
}
```
### Use a Filter Expression
The following example returns only those items matching specific criteria.
#### Sample Request
```
POST / HTTP/1.1
Host: dynamodb..;
Accept-Encoding: identity
Content-Length:
User-Agent:
Content-Type: application/x-amz-json-1.0
Authorization: AWS4-HMAC-SHA256 Credential=, SignedHeaders=, Signature=
X-Amz-Date:
X-Amz-Target: DynamoDB_20120810.Scan
{
"TableName": "Reply",
"FilterExpression": "PostedBy = :val",
"ExpressionAttributeValues": {":val": {"S": "joe@example.com"}},
"ReturnConsumedCapacity": "TOTAL"
}
```
#### Sample Response
```
HTTP/1.1 200 OK
x-amzn-RequestId:
x-amz-crc32:
Content-Type: application/x-amz-json-1.0
Content-Length:
Date:
{
"ConsumedCapacity": {
"CapacityUnits": 0.5,
"TableName": "Reply"
},
"Count": 2,
"Items": [
{
"PostedBy": {
"S": "joe@example.com"
},
"ReplyDateTime": {
"S": "20130320115336"
},
"Id": {
"S": "Amazon DynamoDB#How do I update multiple items?"
},
"Message": {
"S": "Have you looked at BatchWriteItem?"
}
},
{
"PostedBy": {
"S": "joe@example.com"
},
"ReplyDateTime": {
"S": "20130320115347"
},
"Id": {
"S": "Amazon DynamoDB#How do I update multiple items?"
},
"Message": {
"S": "BatchWriteItem is documented in the Amazon DynamoDB API Reference."
}
}
],
"ScannedCount": 4
}
```
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/dynamodb-2012-08-10/Scan)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/dynamodb-2012-08-10/Scan)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/Scan)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/dynamodb-2012-08-10/Scan)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/Scan)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/dynamodb-2012-08-10/Scan)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/dynamodb-2012-08-10/Scan)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/dynamodb-2012-08-10/Scan)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/dynamodb-2012-08-10/Scan)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/Scan)
# TagResource
Associate a set of tags with an Amazon DynamoDB resource. You can then activate these user-defined tags so that they appear on the Billing and Cost Management console for cost allocation tracking. You can call TagResource up to five times per second, per account.
+ `TagResource` is an asynchronous operation. If you issue a [ListTagsOfResource](API_ListTagsOfResource.md) request immediately after a `TagResource` request, DynamoDB might return your previous tag set, if there was one, or an empty tag set. This is because `ListTagsOfResource` uses an eventually consistent query, and the metadata for your tags or table might not be available at that moment. Wait for a few seconds, and then try the `ListTagsOfResource` request again.
+ The application or removal of tags using `TagResource` and `UntagResource` APIs is eventually consistent. `ListTagsOfResource` API will only reflect the changes after a few seconds.
For an overview on tagging DynamoDB resources, see [Tagging for DynamoDB](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Tagging.html) in the *Amazon DynamoDB Developer Guide*.
## Request Syntax
```
{
"ResourceArn": "string",
"Tags": [
{
"Key": "string",
"Value": "string"
}
]
}
```
## Request Parameters
The request accepts the following data in JSON format.
**Note**
In the following list, the required parameters are described first.
** [ResourceArn](#API_TagResource_RequestSyntax) **
Identifies the Amazon DynamoDB resource to which tags should be added. This value is an Amazon Resource Name (ARN).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1283.
Required: Yes
** [Tags](#API_TagResource_RequestSyntax) **
The tags to be assigned to the Amazon DynamoDB resource.
Type: Array of [Tag](API_Tag.md) objects
Required: Yes
## Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalServerError **
An error occurred on the server side.
** message **
The server encountered an internal error trying to fulfill the request.
HTTP Status Code: 500
** LimitExceededException **
There is no limit to the number of daily on-demand backups that can be taken.
For most purposes, up to 500 simultaneous table operations are allowed per account. These operations include `CreateTable`, `UpdateTable`, `DeleteTable`,`UpdateTimeToLive`, `RestoreTableFromBackup`, and `RestoreTableToPointInTime`.
When you are creating a table with one or more secondary indexes, you can have up to 250 such requests running at a time. However, if the table or index specifications are complex, then DynamoDB might temporarily reduce the number of concurrent operations.
When importing into DynamoDB, up to 50 simultaneous import table operations are allowed per account.
There is a soft account quota of 2,500 tables.
GetRecords was called with a value of more than 1000 for the limit request parameter.
More than 2 processes are reading from the same streams shard at the same time. Exceeding this limit may result in request throttling.
** message **
Too many operations for a given subscriber.
HTTP Status Code: 400
** ResourceInUseException **
The operation conflicts with the resource's availability. For example:
+ You attempted to recreate an existing table.
+ You tried to delete a table currently in the `CREATING` state.
+ You tried to update a resource that was already being updated.
When appropriate, wait for the ongoing update to complete and attempt the request again.
** message **
The resource which is being attempted to be changed is in use.
HTTP Status Code: 400
** ResourceNotFoundException **
The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be `ACTIVE`.
** message **
The resource which is being requested does not exist.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/dynamodb-2012-08-10/TagResource)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/dynamodb-2012-08-10/TagResource)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/TagResource)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/dynamodb-2012-08-10/TagResource)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/TagResource)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/dynamodb-2012-08-10/TagResource)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/dynamodb-2012-08-10/TagResource)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/dynamodb-2012-08-10/TagResource)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/dynamodb-2012-08-10/TagResource)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/TagResource)
# TransactGetItems
`TransactGetItems` is a synchronous operation that atomically retrieves multiple items from one or more tables (but not from indexes) in a single account and Region. A `TransactGetItems` call can contain up to 100 `TransactGetItem` objects, each of which contains a `Get` structure that specifies an item to retrieve from a table in the account and Region. A call to `TransactGetItems` cannot retrieve items from tables in more than one AWS account or Region. The aggregate size of the items in the transaction cannot exceed 4 MB.
DynamoDB rejects the entire `TransactGetItems` request if any of the following is true:
+ A conflicting operation is in the process of updating an item to be read.
+ There is insufficient provisioned capacity for the transaction to be completed.
+ There is a user error, such as an invalid data format.
+ The aggregate size of the items in the transaction exceeded 4 MB.
## Request Syntax
```
{
"ReturnConsumedCapacity": "string",
"TransactItems": [
{
"Get": {
"ExpressionAttributeNames": {
"string" : "string"
},
"Key": {
"string" : {
"B": blob,
"BOOL": boolean,
"BS": [ blob ],
"L": [
"AttributeValue"
],
"M": {
"string" : "AttributeValue"
},
"N": "string",
"NS": [ "string" ],
"NULL": boolean,
"S": "string",
"SS": [ "string" ]
}
},
"ProjectionExpression": "string",
"TableName": "string"
}
}
]
}
```
## Request Parameters
The request accepts the following data in JSON format.
**Note**
In the following list, the required parameters are described first.
** [TransactItems](#API_TransactGetItems_RequestSyntax) **
An ordered array of up to 100 `TransactGetItem` objects, each of which contains a `Get` structure.
Type: Array of [TransactGetItem](API_TransactGetItem.md) objects
Array Members: Minimum number of 1 item. Maximum number of 100 items.
Required: Yes
** [ReturnConsumedCapacity](#API_TransactGetItems_RequestSyntax) **
A value of `TOTAL` causes consumed capacity information to be returned, and a value of `NONE` prevents that information from being returned. No other value is valid.
Type: String
Valid Values: `INDEXES | TOTAL | NONE`
Required: No
## Response Syntax
```
{
"ConsumedCapacity": [
{
"CapacityUnits": number,
"GlobalSecondaryIndexes": {
"string" : {
"CapacityUnits": number,
"ReadCapacityUnits": number,
"WriteCapacityUnits": number
}
},
"LocalSecondaryIndexes": {
"string" : {
"CapacityUnits": number,
"ReadCapacityUnits": number,
"WriteCapacityUnits": number
}
},
"ReadCapacityUnits": number,
"Table": {
"CapacityUnits": number,
"ReadCapacityUnits": number,
"WriteCapacityUnits": number
},
"TableName": "string",
"WriteCapacityUnits": number
}
],
"Responses": [
{
"Item": {
"string" : {
"B": blob,
"BOOL": boolean,
"BS": [ blob ],
"L": [
"AttributeValue"
],
"M": {
"string" : "AttributeValue"
},
"N": "string",
"NS": [ "string" ],
"NULL": boolean,
"S": "string",
"SS": [ "string" ]
}
}
}
]
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [ConsumedCapacity](#API_TransactGetItems_ResponseSyntax) **
If the *ReturnConsumedCapacity* value was `TOTAL`, this is an array of `ConsumedCapacity` objects, one for each table addressed by `TransactGetItem` objects in the *TransactItems* parameter. These `ConsumedCapacity` objects report the read-capacity units consumed by the `TransactGetItems` call in that table.
Type: Array of [ConsumedCapacity](API_ConsumedCapacity.md) objects
** [Responses](#API_TransactGetItems_ResponseSyntax) **
An ordered array of up to 100 `ItemResponse` objects, each of which corresponds to the `TransactGetItem` object in the same position in the *TransactItems* array. Each `ItemResponse` object contains a Map of the name-value pairs that are the projected attributes of the requested item.
If a requested item could not be retrieved, the corresponding `ItemResponse` object is Null, or if the requested item has no projected attributes, the corresponding `ItemResponse` object is an empty Map.
Type: Array of [ItemResponse](API_ItemResponse.md) objects
Array Members: Minimum number of 1 item. Maximum number of 100 items.
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalServerError **
An error occurred on the server side.
** message **
The server encountered an internal error trying to fulfill the request.
HTTP Status Code: 500
** ProvisionedThroughputExceededException **
The request was denied due to request throttling. For detailed information about why the request was throttled and the ARN of the impacted resource, find the [ThrottlingReason](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_ThrottlingReason.html) field in the returned exception. The AWS SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to [Error Retries and Exponential Backoff](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Programming.Errors.html#Programming.Errors.RetryAndBackoff) in the *Amazon DynamoDB Developer Guide*.
** message **
You exceeded your maximum allowed provisioned throughput.
** ThrottlingReasons **
A list of [ThrottlingReason](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_ThrottlingReason.html) that provide detailed diagnostic information about why the request was throttled.
HTTP Status Code: 400
** RequestLimitExceeded **
Throughput exceeds the current throughput quota for your account. For detailed information about why the request was throttled and the ARN of the impacted resource, find the [ThrottlingReason](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_ThrottlingReason.html) field in the returned exception. Contact [Support](https://aws.amazon.com/support) to request a quota increase.
** ThrottlingReasons **
A list of [ThrottlingReason](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_ThrottlingReason.html) that provide detailed diagnostic information about why the request was throttled.
HTTP Status Code: 400
** ResourceNotFoundException **
The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be `ACTIVE`.
** message **
The resource which is being requested does not exist.
HTTP Status Code: 400
** ThrottlingException **
The request was denied due to request throttling. For detailed information about why the request was throttled and the ARN of the impacted resource, find the [ThrottlingReason](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_ThrottlingReason.html) field in the returned exception.
** throttlingReasons **
A list of [ThrottlingReason](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_ThrottlingReason.html) that provide detailed diagnostic information about why the request was throttled.
HTTP Status Code: 400
** TransactionCanceledException **
The entire transaction request was canceled.
DynamoDB cancels a `TransactWriteItems` request under the following circumstances:
+ A condition in one of the condition expressions is not met.
+ A table in the `TransactWriteItems` request is in a different account or region.
+ More than one action in the `TransactWriteItems` operation targets the same item.
+ There is insufficient provisioned capacity for the transaction to be completed.
+ An item size becomes too large (larger than 400 KB), or a local secondary index (LSI) becomes too large, or a similar validation error occurs because of changes made by the transaction.
+ There is a user error, such as an invalid data format.
+ There is an ongoing `TransactWriteItems` operation that conflicts with a concurrent `TransactWriteItems` request. In this case the `TransactWriteItems` operation fails with a `TransactionCanceledException`.
DynamoDB cancels a `TransactGetItems` request under the following circumstances:
+ There is an ongoing `TransactGetItems` operation that conflicts with a concurrent `PutItem`, `UpdateItem`, `DeleteItem` or `TransactWriteItems` request. In this case the `TransactGetItems` operation fails with a `TransactionCanceledException`.
+ A table in the `TransactGetItems` request is in a different account or region.
+ There is insufficient provisioned capacity for the transaction to be completed.
+ There is a user error, such as an invalid data format.
DynamoDB lists the cancellation reasons on the `CancellationReasons` property. Transaction cancellation reasons are ordered in the order of requested items, if an item has no error it will have `None` code and `Null` message.
Cancellation reason codes and possible error messages:
+ No Errors:
+ Code: `None`
+ Message: `null`
+ Conditional Check Failed:
+ Code: `ConditionalCheckFailed`
+ Message: The conditional request failed.
+ Item Collection Size Limit Exceeded:
+ Code: `ItemCollectionSizeLimitExceeded`
+ Message: Collection size exceeded.
+ Transaction Conflict:
+ Code: `TransactionConflict`
+ Message: Transaction is ongoing for the item.
+ Provisioned Throughput Exceeded:
+ Code: `ProvisionedThroughputExceeded`
+ Messages:
+ The level of configured provisioned throughput for the table was exceeded. Consider increasing your provisioning level with the UpdateTable API.
**Note**
This Message is received when provisioned throughput is exceeded is on a provisioned DynamoDB table.
+ The level of configured provisioned throughput for one or more global secondary indexes of the table was exceeded. Consider increasing your provisioning level for the under-provisioned global secondary indexes with the UpdateTable API.
**Note**
This message is returned when provisioned throughput is exceeded is on a provisioned GSI.
+ Throttling Error:
+ Code: `ThrottlingError`
+ Messages:
+ Throughput exceeds the current capacity of your table or index. DynamoDB is automatically scaling your table or index so please try again shortly. If exceptions persist, check if you have a hot key: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/bp-partition-key-design.html.
**Note**
This message is returned when writes get throttled on an On-Demand table as DynamoDB is automatically scaling the table.
+ Throughput exceeds the current capacity for one or more global secondary indexes. DynamoDB is automatically scaling your index so please try again shortly.
**Note**
This message is returned when writes get throttled on an On-Demand GSI as DynamoDB is automatically scaling the GSI.
+ Validation Error:
+ Code: `ValidationError`
+ Messages:
+ One or more parameter values were invalid.
+ The update expression attempted to update the secondary index key beyond allowed size limits.
+ The update expression attempted to update the secondary index key to unsupported type.
+ An operand in the update expression has an incorrect data type.
+ Item size to update has exceeded the maximum allowed size.
+ Number overflow. Attempting to store a number with magnitude larger than supported range.
+ Type mismatch for attribute to update.
+ Nesting Levels have exceeded supported limits.
+ The document path provided in the update expression is invalid for update.
+ The provided expression refers to an attribute that does not exist in the item.
** CancellationReasons **
A list of cancellation reasons.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/dynamodb-2012-08-10/TransactGetItems)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/dynamodb-2012-08-10/TransactGetItems)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/TransactGetItems)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/dynamodb-2012-08-10/TransactGetItems)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/TransactGetItems)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/dynamodb-2012-08-10/TransactGetItems)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/dynamodb-2012-08-10/TransactGetItems)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/dynamodb-2012-08-10/TransactGetItems)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/dynamodb-2012-08-10/TransactGetItems)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/TransactGetItems)
# TransactWriteItems
`TransactWriteItems` is a synchronous write operation that groups up to 100 action requests. These actions can target items in different tables, but not in different AWS accounts or Regions, and no two actions can target the same item. For example, you cannot both `ConditionCheck` and `Update` the same item. The aggregate size of the items in the transaction cannot exceed 4 MB.
The actions are completed atomically so that either all of them succeed, or all of them fail. They are defined by the following objects:
+ `Put` — Initiates a `PutItem` operation to write a new item. This structure specifies the primary key of the item to be written, the name of the table to write it in, an optional condition expression that must be satisfied for the write to succeed, a list of the item's attributes, and a field indicating whether to retrieve the item's attributes if the condition is not met.
+ `Update` — Initiates an `UpdateItem` operation to update an existing item. This structure specifies the primary key of the item to be updated, the name of the table where it resides, an optional condition expression that must be satisfied for the update to succeed, an expression that defines one or more attributes to be updated, and a field indicating whether to retrieve the item's attributes if the condition is not met.
+ `Delete` — Initiates a `DeleteItem` operation to delete an existing item. This structure specifies the primary key of the item to be deleted, the name of the table where it resides, an optional condition expression that must be satisfied for the deletion to succeed, and a field indicating whether to retrieve the item's attributes if the condition is not met.
+ `ConditionCheck` — Applies a condition to an item that is not being modified by the transaction. This structure specifies the primary key of the item to be checked, the name of the table where it resides, a condition expression that must be satisfied for the transaction to succeed, and a field indicating whether to retrieve the item's attributes if the condition is not met.
DynamoDB rejects the entire `TransactWriteItems` request if any of the following is true:
+ A condition in one of the condition expressions is not met.
+ An ongoing operation is in the process of updating the same item.
+ There is insufficient provisioned capacity for the transaction to be completed.
+ An item size becomes too large (bigger than 400 KB), a local secondary index (LSI) becomes too large, or a similar validation error occurs because of changes made by the transaction.
+ The aggregate size of the items in the transaction exceeds 4 MB.
+ There is a user error, such as an invalid data format.
## Request Syntax
```
{
"ClientRequestToken": "string",
"ReturnConsumedCapacity": "string",
"ReturnItemCollectionMetrics": "string",
"TransactItems": [
{
"ConditionCheck": {
"ConditionExpression": "string",
"ExpressionAttributeNames": {
"string" : "string"
},
"ExpressionAttributeValues": {
"string" : {
"B": blob,
"BOOL": boolean,
"BS": [ blob ],
"L": [
"AttributeValue"
],
"M": {
"string" : "AttributeValue"
},
"N": "string",
"NS": [ "string" ],
"NULL": boolean,
"S": "string",
"SS": [ "string" ]
}
},
"Key": {
"string" : {
"B": blob,
"BOOL": boolean,
"BS": [ blob ],
"L": [
"AttributeValue"
],
"M": {
"string" : "AttributeValue"
},
"N": "string",
"NS": [ "string" ],
"NULL": boolean,
"S": "string",
"SS": [ "string" ]
}
},
"ReturnValuesOnConditionCheckFailure": "string",
"TableName": "string"
},
"Delete": {
"ConditionExpression": "string",
"ExpressionAttributeNames": {
"string" : "string"
},
"ExpressionAttributeValues": {
"string" : {
"B": blob,
"BOOL": boolean,
"BS": [ blob ],
"L": [
"AttributeValue"
],
"M": {
"string" : "AttributeValue"
},
"N": "string",
"NS": [ "string" ],
"NULL": boolean,
"S": "string",
"SS": [ "string" ]
}
},
"Key": {
"string" : {
"B": blob,
"BOOL": boolean,
"BS": [ blob ],
"L": [
"AttributeValue"
],
"M": {
"string" : "AttributeValue"
},
"N": "string",
"NS": [ "string" ],
"NULL": boolean,
"S": "string",
"SS": [ "string" ]
}
},
"ReturnValuesOnConditionCheckFailure": "string",
"TableName": "string"
},
"Put": {
"ConditionExpression": "string",
"ExpressionAttributeNames": {
"string" : "string"
},
"ExpressionAttributeValues": {
"string" : {
"B": blob,
"BOOL": boolean,
"BS": [ blob ],
"L": [
"AttributeValue"
],
"M": {
"string" : "AttributeValue"
},
"N": "string",
"NS": [ "string" ],
"NULL": boolean,
"S": "string",
"SS": [ "string" ]
}
},
"Item": {
"string" : {
"B": blob,
"BOOL": boolean,
"BS": [ blob ],
"L": [
"AttributeValue"
],
"M": {
"string" : "AttributeValue"
},
"N": "string",
"NS": [ "string" ],
"NULL": boolean,
"S": "string",
"SS": [ "string" ]
}
},
"ReturnValuesOnConditionCheckFailure": "string",
"TableName": "string"
},
"Update": {
"ConditionExpression": "string",
"ExpressionAttributeNames": {
"string" : "string"
},
"ExpressionAttributeValues": {
"string" : {
"B": blob,
"BOOL": boolean,
"BS": [ blob ],
"L": [
"AttributeValue"
],
"M": {
"string" : "AttributeValue"
},
"N": "string",
"NS": [ "string" ],
"NULL": boolean,
"S": "string",
"SS": [ "string" ]
}
},
"Key": {
"string" : {
"B": blob,
"BOOL": boolean,
"BS": [ blob ],
"L": [
"AttributeValue"
],
"M": {
"string" : "AttributeValue"
},
"N": "string",
"NS": [ "string" ],
"NULL": boolean,
"S": "string",
"SS": [ "string" ]
}
},
"ReturnValuesOnConditionCheckFailure": "string",
"TableName": "string",
"UpdateExpression": "string"
}
}
]
}
```
## Request Parameters
The request accepts the following data in JSON format.
**Note**
In the following list, the required parameters are described first.
** [TransactItems](#API_TransactWriteItems_RequestSyntax) **
An ordered array of up to 100 `TransactWriteItem` objects, each of which contains a `ConditionCheck`, `Put`, `Update`, or `Delete` object. These can operate on items in different tables, but the tables must reside in the same AWS account and Region, and no two of them can operate on the same item.
Type: Array of [TransactWriteItem](API_TransactWriteItem.md) objects
Array Members: Minimum number of 1 item. Maximum number of 100 items.
Required: Yes
** [ClientRequestToken](#API_TransactWriteItems_RequestSyntax) **
Providing a `ClientRequestToken` makes the call to `TransactWriteItems` idempotent, meaning that multiple identical calls have the same effect as one single call.
Although multiple identical calls using the same client request token produce the same result on the server (no side effects), the responses to the calls might not be the same. If the `ReturnConsumedCapacity` parameter is set, then the initial `TransactWriteItems` call returns the amount of write capacity units consumed in making the changes. Subsequent `TransactWriteItems` calls with the same client token return the number of read capacity units consumed in reading the item.
A client request token is valid for 10 minutes after the first request that uses it is completed. After 10 minutes, any request with the same client token is treated as a new request. Do not resubmit the same request with the same client token for more than 10 minutes, or the result might not be idempotent.
If you submit a request with the same client token but a change in other parameters within the 10-minute idempotency window, DynamoDB returns an `IdempotentParameterMismatch` exception.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 36.
Required: No
** [ReturnConsumedCapacity](#API_TransactWriteItems_RequestSyntax) **
Determines the level of detail about either provisioned or on-demand throughput consumption that is returned in the response:
+ `INDEXES` - The response includes the aggregate `ConsumedCapacity` for the operation, together with `ConsumedCapacity` for each table and secondary index that was accessed.
Note that some operations, such as `GetItem` and `BatchGetItem`, do not access any indexes at all. In these cases, specifying `INDEXES` will only return `ConsumedCapacity` information for table(s).
+ `TOTAL` - The response includes only the aggregate `ConsumedCapacity` for the operation.
+ `NONE` - No `ConsumedCapacity` details are included in the response.
Type: String
Valid Values: `INDEXES | TOTAL | NONE`
Required: No
** [ReturnItemCollectionMetrics](#API_TransactWriteItems_RequestSyntax) **
Determines whether item collection metrics are returned. If set to `SIZE`, the response includes statistics about item collections (if any), that were modified during the operation and are returned in the response. If set to `NONE` (the default), no statistics are returned.
Type: String
Valid Values: `SIZE | NONE`
Required: No
## Response Syntax
```
{
"ConsumedCapacity": [
{
"CapacityUnits": number,
"GlobalSecondaryIndexes": {
"string" : {
"CapacityUnits": number,
"ReadCapacityUnits": number,
"WriteCapacityUnits": number
}
},
"LocalSecondaryIndexes": {
"string" : {
"CapacityUnits": number,
"ReadCapacityUnits": number,
"WriteCapacityUnits": number
}
},
"ReadCapacityUnits": number,
"Table": {
"CapacityUnits": number,
"ReadCapacityUnits": number,
"WriteCapacityUnits": number
},
"TableName": "string",
"WriteCapacityUnits": number
}
],
"ItemCollectionMetrics": {
"string" : [
{
"ItemCollectionKey": {
"string" : {
"B": blob,
"BOOL": boolean,
"BS": [ blob ],
"L": [
"AttributeValue"
],
"M": {
"string" : "AttributeValue"
},
"N": "string",
"NS": [ "string" ],
"NULL": boolean,
"S": "string",
"SS": [ "string" ]
}
},
"SizeEstimateRangeGB": [ number ]
}
]
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [ConsumedCapacity](#API_TransactWriteItems_ResponseSyntax) **
The capacity units consumed by the entire `TransactWriteItems` operation. The values of the list are ordered according to the ordering of the `TransactItems` request parameter.
Type: Array of [ConsumedCapacity](API_ConsumedCapacity.md) objects
** [ItemCollectionMetrics](#API_TransactWriteItems_ResponseSyntax) **
A list of tables that were processed by `TransactWriteItems` and, for each table, information about any item collections that were affected by individual `UpdateItem`, `PutItem`, or `DeleteItem` operations.
Type: String to array of [ItemCollectionMetrics](API_ItemCollectionMetrics.md) objects map
Key Length Constraints: Minimum length of 1. Maximum length of 1024.
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** IdempotentParameterMismatchException **
DynamoDB rejected the request because you retried a request with a different payload but with an idempotent token that was already used.
HTTP Status Code: 400
** InternalServerError **
An error occurred on the server side.
** message **
The server encountered an internal error trying to fulfill the request.
HTTP Status Code: 500
** ProvisionedThroughputExceededException **
The request was denied due to request throttling. For detailed information about why the request was throttled and the ARN of the impacted resource, find the [ThrottlingReason](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_ThrottlingReason.html) field in the returned exception. The AWS SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to [Error Retries and Exponential Backoff](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Programming.Errors.html#Programming.Errors.RetryAndBackoff) in the *Amazon DynamoDB Developer Guide*.
** message **
You exceeded your maximum allowed provisioned throughput.
** ThrottlingReasons **
A list of [ThrottlingReason](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_ThrottlingReason.html) that provide detailed diagnostic information about why the request was throttled.
HTTP Status Code: 400
** RequestLimitExceeded **
Throughput exceeds the current throughput quota for your account. For detailed information about why the request was throttled and the ARN of the impacted resource, find the [ThrottlingReason](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_ThrottlingReason.html) field in the returned exception. Contact [Support](https://aws.amazon.com/support) to request a quota increase.
** ThrottlingReasons **
A list of [ThrottlingReason](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_ThrottlingReason.html) that provide detailed diagnostic information about why the request was throttled.
HTTP Status Code: 400
** ResourceNotFoundException **
The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be `ACTIVE`.
** message **
The resource which is being requested does not exist.
HTTP Status Code: 400
** ThrottlingException **
The request was denied due to request throttling. For detailed information about why the request was throttled and the ARN of the impacted resource, find the [ThrottlingReason](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_ThrottlingReason.html) field in the returned exception.
** throttlingReasons **
A list of [ThrottlingReason](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_ThrottlingReason.html) that provide detailed diagnostic information about why the request was throttled.
HTTP Status Code: 400
** TransactionCanceledException **
The entire transaction request was canceled.
DynamoDB cancels a `TransactWriteItems` request under the following circumstances:
+ A condition in one of the condition expressions is not met.
+ A table in the `TransactWriteItems` request is in a different account or region.
+ More than one action in the `TransactWriteItems` operation targets the same item.
+ There is insufficient provisioned capacity for the transaction to be completed.
+ An item size becomes too large (larger than 400 KB), or a local secondary index (LSI) becomes too large, or a similar validation error occurs because of changes made by the transaction.
+ There is a user error, such as an invalid data format.
+ There is an ongoing `TransactWriteItems` operation that conflicts with a concurrent `TransactWriteItems` request. In this case the `TransactWriteItems` operation fails with a `TransactionCanceledException`.
DynamoDB cancels a `TransactGetItems` request under the following circumstances:
+ There is an ongoing `TransactGetItems` operation that conflicts with a concurrent `PutItem`, `UpdateItem`, `DeleteItem` or `TransactWriteItems` request. In this case the `TransactGetItems` operation fails with a `TransactionCanceledException`.
+ A table in the `TransactGetItems` request is in a different account or region.
+ There is insufficient provisioned capacity for the transaction to be completed.
+ There is a user error, such as an invalid data format.
DynamoDB lists the cancellation reasons on the `CancellationReasons` property. Transaction cancellation reasons are ordered in the order of requested items, if an item has no error it will have `None` code and `Null` message.
Cancellation reason codes and possible error messages:
+ No Errors:
+ Code: `None`
+ Message: `null`
+ Conditional Check Failed:
+ Code: `ConditionalCheckFailed`
+ Message: The conditional request failed.
+ Item Collection Size Limit Exceeded:
+ Code: `ItemCollectionSizeLimitExceeded`
+ Message: Collection size exceeded.
+ Transaction Conflict:
+ Code: `TransactionConflict`
+ Message: Transaction is ongoing for the item.
+ Provisioned Throughput Exceeded:
+ Code: `ProvisionedThroughputExceeded`
+ Messages:
+ The level of configured provisioned throughput for the table was exceeded. Consider increasing your provisioning level with the UpdateTable API.
**Note**
This Message is received when provisioned throughput is exceeded is on a provisioned DynamoDB table.
+ The level of configured provisioned throughput for one or more global secondary indexes of the table was exceeded. Consider increasing your provisioning level for the under-provisioned global secondary indexes with the UpdateTable API.
**Note**
This message is returned when provisioned throughput is exceeded is on a provisioned GSI.
+ Throttling Error:
+ Code: `ThrottlingError`
+ Messages:
+ Throughput exceeds the current capacity of your table or index. DynamoDB is automatically scaling your table or index so please try again shortly. If exceptions persist, check if you have a hot key: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/bp-partition-key-design.html.
**Note**
This message is returned when writes get throttled on an On-Demand table as DynamoDB is automatically scaling the table.
+ Throughput exceeds the current capacity for one or more global secondary indexes. DynamoDB is automatically scaling your index so please try again shortly.
**Note**
This message is returned when writes get throttled on an On-Demand GSI as DynamoDB is automatically scaling the GSI.
+ Validation Error:
+ Code: `ValidationError`
+ Messages:
+ One or more parameter values were invalid.
+ The update expression attempted to update the secondary index key beyond allowed size limits.
+ The update expression attempted to update the secondary index key to unsupported type.
+ An operand in the update expression has an incorrect data type.
+ Item size to update has exceeded the maximum allowed size.
+ Number overflow. Attempting to store a number with magnitude larger than supported range.
+ Type mismatch for attribute to update.
+ Nesting Levels have exceeded supported limits.
+ The document path provided in the update expression is invalid for update.
+ The provided expression refers to an attribute that does not exist in the item.
** CancellationReasons **
A list of cancellation reasons.
HTTP Status Code: 400
** TransactionInProgressException **
The transaction with the given request token is already in progress.
Recommended Settings
This is a general recommendation for handling the `TransactionInProgressException`. These settings help ensure that the client retries will trigger completion of the ongoing `TransactWriteItems` request.
+ Set `clientExecutionTimeout` to a value that allows at least one retry to be processed after 5 seconds have elapsed since the first attempt for the `TransactWriteItems` operation.
+ Set `socketTimeout` to a value a little lower than the `requestTimeout` setting.
+ `requestTimeout` should be set based on the time taken for the individual retries of a single HTTP request for your use case, but setting it to 1 second or higher should work well to reduce chances of retries and `TransactionInProgressException` errors.
+ Use exponential backoff when retrying and tune backoff if needed.
Assuming [default retry policy](https://github.com/aws/aws-sdk-java/blob/fd409dee8ae23fb8953e0bb4dbde65536a7e0514/aws-java-sdk-core/src/main/java/com/amazonaws/retry/PredefinedRetryPolicies.java#L97), example timeout settings based on the guidelines above are as follows:
Example timeline:
+ 0-1000 first attempt
+ 1000-1500 first sleep/delay (default retry policy uses 500 ms as base delay for 4xx errors)
+ 1500-2500 second attempt
+ 2500-3500 second sleep/delay (500 \$1 2, exponential backoff)
+ 3500-4500 third attempt
+ 4500-6500 third sleep/delay (500 \$1 2^2)
+ 6500-7500 fourth attempt (this can trigger inline recovery since 5 seconds have elapsed since the first attempt reached TC)
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/dynamodb-2012-08-10/TransactWriteItems)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/dynamodb-2012-08-10/TransactWriteItems)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/TransactWriteItems)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/dynamodb-2012-08-10/TransactWriteItems)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/TransactWriteItems)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/dynamodb-2012-08-10/TransactWriteItems)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/dynamodb-2012-08-10/TransactWriteItems)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/dynamodb-2012-08-10/TransactWriteItems)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/dynamodb-2012-08-10/TransactWriteItems)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/TransactWriteItems)
# UntagResource
Removes the association of tags from an Amazon DynamoDB resource. You can call `UntagResource` up to five times per second, per account.
+ `UntagResource` is an asynchronous operation. If you issue a [ListTagsOfResource](API_ListTagsOfResource.md) request immediately after an `UntagResource` request, DynamoDB might return your previous tag set, if there was one, or an empty tag set. This is because `ListTagsOfResource` uses an eventually consistent query, and the metadata for your tags or table might not be available at that moment. Wait for a few seconds, and then try the `ListTagsOfResource` request again.
+ The application or removal of tags using `TagResource` and `UntagResource` APIs is eventually consistent. `ListTagsOfResource` API will only reflect the changes after a few seconds.
For an overview on tagging DynamoDB resources, see [Tagging for DynamoDB](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Tagging.html) in the *Amazon DynamoDB Developer Guide*.
## Request Syntax
```
{
"ResourceArn": "string",
"TagKeys": [ "string" ]
}
```
## Request Parameters
The request accepts the following data in JSON format.
**Note**
In the following list, the required parameters are described first.
** [ResourceArn](#API_UntagResource_RequestSyntax) **
The DynamoDB resource that the tags will be removed from. This value is an Amazon Resource Name (ARN).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1283.
Required: Yes
** [TagKeys](#API_UntagResource_RequestSyntax) **
A list of tag keys. Existing tags of the resource whose keys are members of this list will be removed from the DynamoDB resource.
Type: Array of strings
Length Constraints: Minimum length of 1. Maximum length of 128.
Required: Yes
## Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalServerError **
An error occurred on the server side.
** message **
The server encountered an internal error trying to fulfill the request.
HTTP Status Code: 500
** LimitExceededException **
There is no limit to the number of daily on-demand backups that can be taken.
For most purposes, up to 500 simultaneous table operations are allowed per account. These operations include `CreateTable`, `UpdateTable`, `DeleteTable`,`UpdateTimeToLive`, `RestoreTableFromBackup`, and `RestoreTableToPointInTime`.
When you are creating a table with one or more secondary indexes, you can have up to 250 such requests running at a time. However, if the table or index specifications are complex, then DynamoDB might temporarily reduce the number of concurrent operations.
When importing into DynamoDB, up to 50 simultaneous import table operations are allowed per account.
There is a soft account quota of 2,500 tables.
GetRecords was called with a value of more than 1000 for the limit request parameter.
More than 2 processes are reading from the same streams shard at the same time. Exceeding this limit may result in request throttling.
** message **
Too many operations for a given subscriber.
HTTP Status Code: 400
** ResourceInUseException **
The operation conflicts with the resource's availability. For example:
+ You attempted to recreate an existing table.
+ You tried to delete a table currently in the `CREATING` state.
+ You tried to update a resource that was already being updated.
When appropriate, wait for the ongoing update to complete and attempt the request again.
** message **
The resource which is being attempted to be changed is in use.
HTTP Status Code: 400
** ResourceNotFoundException **
The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be `ACTIVE`.
** message **
The resource which is being requested does not exist.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/dynamodb-2012-08-10/UntagResource)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/dynamodb-2012-08-10/UntagResource)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/UntagResource)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/dynamodb-2012-08-10/UntagResource)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/UntagResource)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/dynamodb-2012-08-10/UntagResource)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/dynamodb-2012-08-10/UntagResource)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/dynamodb-2012-08-10/UntagResource)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/dynamodb-2012-08-10/UntagResource)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/UntagResource)
# UpdateContinuousBackups
`UpdateContinuousBackups` enables or disables point in time recovery for the specified table. A successful `UpdateContinuousBackups` call returns the current `ContinuousBackupsDescription`. Continuous backups are `ENABLED` on all tables at table creation. If point in time recovery is enabled, `PointInTimeRecoveryStatus` will be set to ENABLED.
Once 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 in the last 35 days. You can set the `RecoveryPeriodInDays` to any value between 1 and 35 days.
## Request Syntax
```
{
"PointInTimeRecoverySpecification": {
"PointInTimeRecoveryEnabled": boolean,
"RecoveryPeriodInDays": number
},
"TableName": "string"
}
```
## Request Parameters
The request accepts the following data in JSON format.
**Note**
In the following list, the required parameters are described first.
** [PointInTimeRecoverySpecification](#API_UpdateContinuousBackups_RequestSyntax) **
Represents the settings used to enable point in time recovery.
Type: [PointInTimeRecoverySpecification](API_PointInTimeRecoverySpecification.md) object
Required: Yes
** [TableName](#API_UpdateContinuousBackups_RequestSyntax) **
The name of the table. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: Yes
## Response Syntax
```
{
"ContinuousBackupsDescription": {
"ContinuousBackupsStatus": "string",
"PointInTimeRecoveryDescription": {
"EarliestRestorableDateTime": number,
"LatestRestorableDateTime": number,
"PointInTimeRecoveryStatus": "string",
"RecoveryPeriodInDays": number
}
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [ContinuousBackupsDescription](#API_UpdateContinuousBackups_ResponseSyntax) **
Represents the continuous backups and point in time recovery settings on the table.
Type: [ContinuousBackupsDescription](API_ContinuousBackupsDescription.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** ContinuousBackupsUnavailableException **
Backups have not yet been enabled for this table.
HTTP Status Code: 400
** InternalServerError **
An error occurred on the server side.
** message **
The server encountered an internal error trying to fulfill the request.
HTTP Status Code: 500
** TableNotFoundException **
A source table with the name `TableName` does not currently exist within the subscriber's account or the subscriber is operating in the wrong AWS Region.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/dynamodb-2012-08-10/UpdateContinuousBackups)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/dynamodb-2012-08-10/UpdateContinuousBackups)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/UpdateContinuousBackups)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/dynamodb-2012-08-10/UpdateContinuousBackups)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/UpdateContinuousBackups)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/dynamodb-2012-08-10/UpdateContinuousBackups)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/dynamodb-2012-08-10/UpdateContinuousBackups)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/dynamodb-2012-08-10/UpdateContinuousBackups)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/dynamodb-2012-08-10/UpdateContinuousBackups)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/UpdateContinuousBackups)
# UpdateContributorInsights
Updates the status for contributor insights for a specific table or index. CloudWatch Contributor Insights for DynamoDB graphs display the partition key and (if applicable) sort key of frequently accessed items and frequently throttled items in plaintext. If you require the use of AWS Key Management Service (KMS) to encrypt this table’s partition key and sort key data with an AWS managed key or customer managed key, you should not enable CloudWatch Contributor Insights for DynamoDB for this table.
## Request Syntax
```
{
"ContributorInsightsAction": "string",
"ContributorInsightsMode": "string",
"IndexName": "string",
"TableName": "string"
}
```
## Request Parameters
The request accepts the following data in JSON format.
**Note**
In the following list, the required parameters are described first.
** [ContributorInsightsAction](#API_UpdateContributorInsights_RequestSyntax) **
Represents the contributor insights action.
Type: String
Valid Values: `ENABLE | DISABLE`
Required: Yes
** [TableName](#API_UpdateContributorInsights_RequestSyntax) **
The name of the table. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: Yes
** [ContributorInsightsMode](#API_UpdateContributorInsights_RequestSyntax) **
Specifies whether to track all access and throttled events or throttled events only for the DynamoDB table or index.
Type: String
Valid Values: `ACCESSED_AND_THROTTLED_KEYS | THROTTLED_KEYS`
Required: No
** [IndexName](#API_UpdateContributorInsights_RequestSyntax) **
The global secondary index name, if applicable.
Type: String
Length Constraints: Minimum length of 3. Maximum length of 255.
Pattern: `[a-zA-Z0-9_.-]+`
Required: No
## Response Syntax
```
{
"ContributorInsightsMode": "string",
"ContributorInsightsStatus": "string",
"IndexName": "string",
"TableName": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [ContributorInsightsMode](#API_UpdateContributorInsights_ResponseSyntax) **
The updated mode of CloudWatch Contributor Insights that determines whether to monitor all access and throttled events or to track throttled events exclusively.
Type: String
Valid Values: `ACCESSED_AND_THROTTLED_KEYS | THROTTLED_KEYS`
** [ContributorInsightsStatus](#API_UpdateContributorInsights_ResponseSyntax) **
The status of contributor insights
Type: String
Valid Values: `ENABLING | ENABLED | DISABLING | DISABLED | FAILED`
** [IndexName](#API_UpdateContributorInsights_ResponseSyntax) **
The name of the global secondary index, if applicable.
Type: String
Length Constraints: Minimum length of 3. Maximum length of 255.
Pattern: `[a-zA-Z0-9_.-]+`
** [TableName](#API_UpdateContributorInsights_ResponseSyntax) **
The name of the table.
Type: String
Length Constraints: Minimum length of 3. Maximum length of 255.
Pattern: `[a-zA-Z0-9_.-]+`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalServerError **
An error occurred on the server side.
** message **
The server encountered an internal error trying to fulfill the request.
HTTP Status Code: 500
** ResourceNotFoundException **
The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be `ACTIVE`.
** message **
The resource which is being requested does not exist.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/dynamodb-2012-08-10/UpdateContributorInsights)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/dynamodb-2012-08-10/UpdateContributorInsights)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/UpdateContributorInsights)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/dynamodb-2012-08-10/UpdateContributorInsights)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/UpdateContributorInsights)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/dynamodb-2012-08-10/UpdateContributorInsights)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/dynamodb-2012-08-10/UpdateContributorInsights)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/dynamodb-2012-08-10/UpdateContributorInsights)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/dynamodb-2012-08-10/UpdateContributorInsights)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/UpdateContributorInsights)
# UpdateGlobalTable
Adds or removes replicas in the specified global table. The global table must already exist to be able to use this operation. Any replica to be added must be empty, have the same name as the global table, have the same key schema, have DynamoDB Streams enabled, and have the same provisioned and maximum write capacity units.
**Important**
This documentation is for version 2017.11.29 (Legacy) of global tables, which should be avoided for new global tables. Customers should use [Global Tables version 2019.11.21 (Current)](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/GlobalTables.html) when possible, because it provides greater flexibility, higher efficiency, and consumes less write capacity than 2017.11.29 (Legacy).
To determine which version you're using, see [Determining the global table version you are using](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.DetermineVersion.html). To update existing global tables from version 2017.11.29 (Legacy) to version 2019.11.21 (Current), see [Upgrading global tables](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/V2globaltables_upgrade.html).
**Note**
If you are using global tables [Version 2019.11.21](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/GlobalTables.html) (Current) you can use [UpdateTable](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_UpdateTable.html) instead.
Although you can use `UpdateGlobalTable` to add replicas and remove replicas in a single request, for simplicity we recommend that you issue separate requests for adding or removing replicas.
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).
+ The global secondary indexes must have the same provisioned and maximum write capacity units.
## Request Syntax
```
{
"GlobalTableName": "string",
"ReplicaUpdates": [
{
"Create": {
"RegionName": "string"
},
"Delete": {
"RegionName": "string"
}
}
]
}
```
## Request Parameters
The request accepts the following data in JSON format.
**Note**
In the following list, the required parameters are described first.
** [GlobalTableName](#API_UpdateGlobalTable_RequestSyntax) **
The global table name.
Type: String
Length Constraints: Minimum length of 3. Maximum length of 255.
Pattern: `[a-zA-Z0-9_.-]+`
Required: Yes
** [ReplicaUpdates](#API_UpdateGlobalTable_RequestSyntax) **
A list of Regions that should be added or removed from the global table.
Type: Array of [ReplicaUpdate](API_ReplicaUpdate.md) objects
Required: Yes
## Response Syntax
```
{
"GlobalTableDescription": {
"CreationDateTime": number,
"GlobalTableArn": "string",
"GlobalTableName": "string",
"GlobalTableStatus": "string",
"ReplicationGroup": [
{
"GlobalSecondaryIndexes": [
{
"IndexName": "string",
"OnDemandThroughputOverride": {
"MaxReadRequestUnits": number
},
"ProvisionedThroughputOverride": {
"ReadCapacityUnits": number
},
"WarmThroughput": {
"ReadUnitsPerSecond": number,
"Status": "string",
"WriteUnitsPerSecond": number
}
}
],
"GlobalTableSettingsReplicationMode": "string",
"KMSMasterKeyId": "string",
"OnDemandThroughputOverride": {
"MaxReadRequestUnits": number
},
"ProvisionedThroughputOverride": {
"ReadCapacityUnits": number
},
"RegionName": "string",
"ReplicaArn": "string",
"ReplicaInaccessibleDateTime": number,
"ReplicaStatus": "string",
"ReplicaStatusDescription": "string",
"ReplicaStatusPercentProgress": "string",
"ReplicaTableClassSummary": {
"LastUpdateDateTime": number,
"TableClass": "string"
},
"WarmThroughput": {
"ReadUnitsPerSecond": number,
"Status": "string",
"WriteUnitsPerSecond": number
}
}
]
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [GlobalTableDescription](#API_UpdateGlobalTable_ResponseSyntax) **
Contains the details of the global table.
Type: [GlobalTableDescription](API_GlobalTableDescription.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** GlobalTableNotFoundException **
The specified global table does not exist.
HTTP Status Code: 400
** InternalServerError **
An error occurred on the server side.
** message **
The server encountered an internal error trying to fulfill the request.
HTTP Status Code: 500
** ReplicaAlreadyExistsException **
The specified replica is already part of the global table.
HTTP Status Code: 400
** ReplicaNotFoundException **
The specified replica is no longer part of the global table.
HTTP Status Code: 400
** TableNotFoundException **
A source table with the name `TableName` does not currently exist within the subscriber's account or the subscriber is operating in the wrong AWS Region.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/dynamodb-2012-08-10/UpdateGlobalTable)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/dynamodb-2012-08-10/UpdateGlobalTable)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/UpdateGlobalTable)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/dynamodb-2012-08-10/UpdateGlobalTable)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/UpdateGlobalTable)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/dynamodb-2012-08-10/UpdateGlobalTable)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/dynamodb-2012-08-10/UpdateGlobalTable)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/dynamodb-2012-08-10/UpdateGlobalTable)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/dynamodb-2012-08-10/UpdateGlobalTable)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/UpdateGlobalTable)
# UpdateGlobalTableSettings
Updates settings for a global table.
**Important**
This documentation is for version 2017.11.29 (Legacy) of global tables, which should be avoided for new global tables. Customers should use [Global Tables version 2019.11.21 (Current)](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/GlobalTables.html) when possible, because it provides greater flexibility, higher efficiency, and consumes less write capacity than 2017.11.29 (Legacy).
To determine which version you're using, see [Determining the global table version you are using](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.DetermineVersion.html). To update existing global tables from version 2017.11.29 (Legacy) to version 2019.11.21 (Current), see [Upgrading global tables](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/V2globaltables_upgrade.html).
## Request Syntax
```
{
"GlobalTableBillingMode": "string",
"GlobalTableGlobalSecondaryIndexSettingsUpdate": [
{
"IndexName": "string",
"ProvisionedWriteCapacityAutoScalingSettingsUpdate": {
"AutoScalingDisabled": boolean,
"AutoScalingRoleArn": "string",
"MaximumUnits": number,
"MinimumUnits": number,
"ScalingPolicyUpdate": {
"PolicyName": "string",
"TargetTrackingScalingPolicyConfiguration": {
"DisableScaleIn": boolean,
"ScaleInCooldown": number,
"ScaleOutCooldown": number,
"TargetValue": number
}
}
},
"ProvisionedWriteCapacityUnits": number
}
],
"GlobalTableName": "string",
"GlobalTableProvisionedWriteCapacityAutoScalingSettingsUpdate": {
"AutoScalingDisabled": boolean,
"AutoScalingRoleArn": "string",
"MaximumUnits": number,
"MinimumUnits": number,
"ScalingPolicyUpdate": {
"PolicyName": "string",
"TargetTrackingScalingPolicyConfiguration": {
"DisableScaleIn": boolean,
"ScaleInCooldown": number,
"ScaleOutCooldown": number,
"TargetValue": number
}
}
},
"GlobalTableProvisionedWriteCapacityUnits": number,
"ReplicaSettingsUpdate": [
{
"RegionName": "string",
"ReplicaGlobalSecondaryIndexSettingsUpdate": [
{
"IndexName": "string",
"ProvisionedReadCapacityAutoScalingSettingsUpdate": {
"AutoScalingDisabled": boolean,
"AutoScalingRoleArn": "string",
"MaximumUnits": number,
"MinimumUnits": number,
"ScalingPolicyUpdate": {
"PolicyName": "string",
"TargetTrackingScalingPolicyConfiguration": {
"DisableScaleIn": boolean,
"ScaleInCooldown": number,
"ScaleOutCooldown": number,
"TargetValue": number
}
}
},
"ProvisionedReadCapacityUnits": number
}
],
"ReplicaProvisionedReadCapacityAutoScalingSettingsUpdate": {
"AutoScalingDisabled": boolean,
"AutoScalingRoleArn": "string",
"MaximumUnits": number,
"MinimumUnits": number,
"ScalingPolicyUpdate": {
"PolicyName": "string",
"TargetTrackingScalingPolicyConfiguration": {
"DisableScaleIn": boolean,
"ScaleInCooldown": number,
"ScaleOutCooldown": number,
"TargetValue": number
}
}
},
"ReplicaProvisionedReadCapacityUnits": number,
"ReplicaTableClass": "string"
}
]
}
```
## Request Parameters
The request accepts the following data in JSON format.
**Note**
In the following list, the required parameters are described first.
** [GlobalTableName](#API_UpdateGlobalTableSettings_RequestSyntax) **
The name of the global table
Type: String
Length Constraints: Minimum length of 3. Maximum length of 255.
Pattern: `[a-zA-Z0-9_.-]+`
Required: Yes
** [GlobalTableBillingMode](#API_UpdateGlobalTableSettings_RequestSyntax) **
The billing mode of the global table. If `GlobalTableBillingMode` is not specified, the global table defaults to `PROVISIONED` capacity billing mode.
+ `PROVISIONED` - We recommend using `PROVISIONED` for predictable workloads. `PROVISIONED` sets the billing mode to [Provisioned capacity mode](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/provisioned-capacity-mode.html).
+ `PAY_PER_REQUEST` - We recommend using `PAY_PER_REQUEST` for unpredictable workloads. `PAY_PER_REQUEST` sets the billing mode to [On-demand capacity mode](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/on-demand-capacity-mode.html).
Type: String
Valid Values: `PROVISIONED | PAY_PER_REQUEST`
Required: No
** [GlobalTableGlobalSecondaryIndexSettingsUpdate](#API_UpdateGlobalTableSettings_RequestSyntax) **
Represents the settings of a global secondary index for a global table that will be modified.
Type: Array of [GlobalTableGlobalSecondaryIndexSettingsUpdate](API_GlobalTableGlobalSecondaryIndexSettingsUpdate.md) objects
Array Members: Minimum number of 1 item. Maximum number of 20 items.
Required: No
** [GlobalTableProvisionedWriteCapacityAutoScalingSettingsUpdate](#API_UpdateGlobalTableSettings_RequestSyntax) **
Auto scaling settings for managing provisioned write capacity for the global table.
Type: [AutoScalingSettingsUpdate](API_AutoScalingSettingsUpdate.md) object
Required: No
** [GlobalTableProvisionedWriteCapacityUnits](#API_UpdateGlobalTableSettings_RequestSyntax) **
The maximum number of writes consumed per second before DynamoDB returns a `ThrottlingException.`
Type: Long
Valid Range: Minimum value of 1.
Required: No
** [ReplicaSettingsUpdate](#API_UpdateGlobalTableSettings_RequestSyntax) **
Represents the settings for a global table in a Region that will be modified.
Type: Array of [ReplicaSettingsUpdate](API_ReplicaSettingsUpdate.md) objects
Array Members: Minimum number of 1 item. Maximum number of 50 items.
Required: No
## Response Syntax
```
{
"GlobalTableName": "string",
"ReplicaSettings": [
{
"RegionName": "string",
"ReplicaBillingModeSummary": {
"BillingMode": "string",
"LastUpdateToPayPerRequestDateTime": number
},
"ReplicaGlobalSecondaryIndexSettings": [
{
"IndexName": "string",
"IndexStatus": "string",
"ProvisionedReadCapacityAutoScalingSettings": {
"AutoScalingDisabled": boolean,
"AutoScalingRoleArn": "string",
"MaximumUnits": number,
"MinimumUnits": number,
"ScalingPolicies": [
{
"PolicyName": "string",
"TargetTrackingScalingPolicyConfiguration": {
"DisableScaleIn": boolean,
"ScaleInCooldown": number,
"ScaleOutCooldown": number,
"TargetValue": number
}
}
]
},
"ProvisionedReadCapacityUnits": number,
"ProvisionedWriteCapacityAutoScalingSettings": {
"AutoScalingDisabled": boolean,
"AutoScalingRoleArn": "string",
"MaximumUnits": number,
"MinimumUnits": number,
"ScalingPolicies": [
{
"PolicyName": "string",
"TargetTrackingScalingPolicyConfiguration": {
"DisableScaleIn": boolean,
"ScaleInCooldown": number,
"ScaleOutCooldown": number,
"TargetValue": number
}
}
]
},
"ProvisionedWriteCapacityUnits": number
}
],
"ReplicaProvisionedReadCapacityAutoScalingSettings": {
"AutoScalingDisabled": boolean,
"AutoScalingRoleArn": "string",
"MaximumUnits": number,
"MinimumUnits": number,
"ScalingPolicies": [
{
"PolicyName": "string",
"TargetTrackingScalingPolicyConfiguration": {
"DisableScaleIn": boolean,
"ScaleInCooldown": number,
"ScaleOutCooldown": number,
"TargetValue": number
}
}
]
},
"ReplicaProvisionedReadCapacityUnits": number,
"ReplicaProvisionedWriteCapacityAutoScalingSettings": {
"AutoScalingDisabled": boolean,
"AutoScalingRoleArn": "string",
"MaximumUnits": number,
"MinimumUnits": number,
"ScalingPolicies": [
{
"PolicyName": "string",
"TargetTrackingScalingPolicyConfiguration": {
"DisableScaleIn": boolean,
"ScaleInCooldown": number,
"ScaleOutCooldown": number,
"TargetValue": number
}
}
]
},
"ReplicaProvisionedWriteCapacityUnits": number,
"ReplicaStatus": "string",
"ReplicaTableClassSummary": {
"LastUpdateDateTime": number,
"TableClass": "string"
}
}
]
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [GlobalTableName](#API_UpdateGlobalTableSettings_ResponseSyntax) **
The name of the global table.
Type: String
Length Constraints: Minimum length of 3. Maximum length of 255.
Pattern: `[a-zA-Z0-9_.-]+`
** [ReplicaSettings](#API_UpdateGlobalTableSettings_ResponseSyntax) **
The Region-specific settings for the global table.
Type: Array of [ReplicaSettingsDescription](API_ReplicaSettingsDescription.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** GlobalTableNotFoundException **
The specified global table does not exist.
HTTP Status Code: 400
** IndexNotFoundException **
The operation tried to access a nonexistent index.
HTTP Status Code: 400
** InternalServerError **
An error occurred on the server side.
** message **
The server encountered an internal error trying to fulfill the request.
HTTP Status Code: 500
** LimitExceededException **
There is no limit to the number of daily on-demand backups that can be taken.
For most purposes, up to 500 simultaneous table operations are allowed per account. These operations include `CreateTable`, `UpdateTable`, `DeleteTable`,`UpdateTimeToLive`, `RestoreTableFromBackup`, and `RestoreTableToPointInTime`.
When you are creating a table with one or more secondary indexes, you can have up to 250 such requests running at a time. However, if the table or index specifications are complex, then DynamoDB might temporarily reduce the number of concurrent operations.
When importing into DynamoDB, up to 50 simultaneous import table operations are allowed per account.
There is a soft account quota of 2,500 tables.
GetRecords was called with a value of more than 1000 for the limit request parameter.
More than 2 processes are reading from the same streams shard at the same time. Exceeding this limit may result in request throttling.
** message **
Too many operations for a given subscriber.
HTTP Status Code: 400
** ReplicaNotFoundException **
The specified replica is no longer part of the global table.
HTTP Status Code: 400
** ResourceInUseException **
The operation conflicts with the resource's availability. For example:
+ You attempted to recreate an existing table.
+ You tried to delete a table currently in the `CREATING` state.
+ You tried to update a resource that was already being updated.
When appropriate, wait for the ongoing update to complete and attempt the request again.
** message **
The resource which is being attempted to be changed is in use.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/dynamodb-2012-08-10/UpdateGlobalTableSettings)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/dynamodb-2012-08-10/UpdateGlobalTableSettings)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/UpdateGlobalTableSettings)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/dynamodb-2012-08-10/UpdateGlobalTableSettings)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/UpdateGlobalTableSettings)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/dynamodb-2012-08-10/UpdateGlobalTableSettings)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/dynamodb-2012-08-10/UpdateGlobalTableSettings)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/dynamodb-2012-08-10/UpdateGlobalTableSettings)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/dynamodb-2012-08-10/UpdateGlobalTableSettings)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/UpdateGlobalTableSettings)
# UpdateItem
Edits an existing item's attributes, or adds a new item to the table if it does not already exist. You can put, delete, or add attribute values. You can also perform a conditional update on an existing item (insert a new attribute name-value pair if it doesn't exist, or replace an existing name-value pair if it has certain expected attribute values).
You can also return the item's attribute values in the same `UpdateItem` operation using the `ReturnValues` parameter.
## Request Syntax
```
{
"AttributeUpdates": {
"string" : {
"Action": "string",
"Value": {
"B": blob,
"BOOL": boolean,
"BS": [ blob ],
"L": [
"AttributeValue"
],
"M": {
"string" : "AttributeValue"
},
"N": "string",
"NS": [ "string" ],
"NULL": boolean,
"S": "string",
"SS": [ "string" ]
}
}
},
"ConditionalOperator": "string",
"ConditionExpression": "string",
"Expected": {
"string" : {
"AttributeValueList": [
{
"B": blob,
"BOOL": boolean,
"BS": [ blob ],
"L": [
"AttributeValue"
],
"M": {
"string" : "AttributeValue"
},
"N": "string",
"NS": [ "string" ],
"NULL": boolean,
"S": "string",
"SS": [ "string" ]
}
],
"ComparisonOperator": "string",
"Exists": boolean,
"Value": {
"B": blob,
"BOOL": boolean,
"BS": [ blob ],
"L": [
"AttributeValue"
],
"M": {
"string" : "AttributeValue"
},
"N": "string",
"NS": [ "string" ],
"NULL": boolean,
"S": "string",
"SS": [ "string" ]
}
}
},
"ExpressionAttributeNames": {
"string" : "string"
},
"ExpressionAttributeValues": {
"string" : {
"B": blob,
"BOOL": boolean,
"BS": [ blob ],
"L": [
"AttributeValue"
],
"M": {
"string" : "AttributeValue"
},
"N": "string",
"NS": [ "string" ],
"NULL": boolean,
"S": "string",
"SS": [ "string" ]
}
},
"Key": {
"string" : {
"B": blob,
"BOOL": boolean,
"BS": [ blob ],
"L": [
"AttributeValue"
],
"M": {
"string" : "AttributeValue"
},
"N": "string",
"NS": [ "string" ],
"NULL": boolean,
"S": "string",
"SS": [ "string" ]
}
},
"ReturnConsumedCapacity": "string",
"ReturnItemCollectionMetrics": "string",
"ReturnValues": "string",
"ReturnValuesOnConditionCheckFailure": "string",
"TableName": "string",
"UpdateExpression": "string"
}
```
## Request Parameters
The request accepts the following data in JSON format.
**Note**
In the following list, the required parameters are described first.
** [Key](#API_UpdateItem_RequestSyntax) **
The primary key of the item to be updated. Each element consists of an attribute name and a value for that attribute.
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.
Type: String to [AttributeValue](API_AttributeValue.md) object map
Key Length Constraints: Maximum length of 65535.
Required: Yes
** [TableName](#API_UpdateItem_RequestSyntax) **
The name of the table containing the item to update. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: Yes
** [AttributeUpdates](#API_UpdateItem_RequestSyntax) **
This is a legacy parameter. Use `UpdateExpression` instead. For more information, see [AttributeUpdates](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.AttributeUpdates.html) in the *Amazon DynamoDB Developer Guide*.
Type: String to [AttributeValueUpdate](API_AttributeValueUpdate.md) object map
Key Length Constraints: Maximum length of 65535.
Required: No
** [ConditionalOperator](#API_UpdateItem_RequestSyntax) **
This is a legacy parameter. Use `ConditionExpression` instead. For more information, see [ConditionalOperator](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.ConditionalOperator.html) in the *Amazon DynamoDB Developer Guide*.
Type: String
Valid Values: `AND | OR`
Required: No
** [ConditionExpression](#API_UpdateItem_RequestSyntax) **
A condition that must be satisfied in order for a conditional update to succeed.
An expression can contain any of the following:
+ Functions: `attribute_exists | attribute_not_exists | attribute_type | contains | begins_with | size`
These function names are case-sensitive.
+ Comparison operators: `= | <> | < | > | <= | >= | BETWEEN | IN `
+ Logical operators: `AND | OR | NOT`
For more information about condition expressions, see [Specifying Conditions](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.SpecifyingConditions.html) in the *Amazon DynamoDB Developer Guide*.
Type: String
Required: No
** [Expected](#API_UpdateItem_RequestSyntax) **
This is a legacy parameter. Use `ConditionExpression` instead. For more information, see [Expected](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.Expected.html) in the *Amazon DynamoDB Developer Guide*.
Type: String to [ExpectedAttributeValue](API_ExpectedAttributeValue.md) object map
Key Length Constraints: Maximum length of 65535.
Required: No
** [ExpressionAttributeNames](#API_UpdateItem_RequestSyntax) **
One or more substitution tokens for attribute names in an expression. The following are some use cases for using `ExpressionAttributeNames`:
+ To access an attribute whose name conflicts with a DynamoDB reserved word.
+ To create a placeholder for repeating occurrences of an attribute name in an expression.
+ To prevent special characters in an attribute name from being misinterpreted in an expression.
Use the **\$1** character in an expression to dereference an attribute name. For example, consider the following attribute name:
+ `Percentile`
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](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ReservedWords.html) in the *Amazon DynamoDB Developer Guide*.) To work around this, you could specify the following for `ExpressionAttributeNames`:
+ `{"#P":"Percentile"}`
You could then use this substitution in an expression, as in this example:
+ `#P = :val`
Tokens that begin with the **:** character are *expression attribute values*, which are placeholders for the actual value at runtime.
For more information about expression attribute names, see [Specifying Item Attributes](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html) in the *Amazon DynamoDB Developer Guide*.
Type: String to string map
Value Length Constraints: Maximum length of 65535.
Required: No
** [ExpressionAttributeValues](#API_UpdateItem_RequestSyntax) **
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:
`Available | Backordered | Discontinued`
You would first need to specify `ExpressionAttributeValues` as follows:
`{ ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }`
You could then use these values in an expression, such as this:
`ProductStatus IN (:avail, :back, :disc)`
For more information on expression attribute values, see [Condition Expressions](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.SpecifyingConditions.html) in the *Amazon DynamoDB Developer Guide*.
Type: String to [AttributeValue](API_AttributeValue.md) object map
Required: No
** [ReturnConsumedCapacity](#API_UpdateItem_RequestSyntax) **
Determines the level of detail about either provisioned or on-demand throughput consumption that is returned in the response:
+ `INDEXES` - The response includes the aggregate `ConsumedCapacity` for the operation, together with `ConsumedCapacity` for each table and secondary index that was accessed.
Note that some operations, such as `GetItem` and `BatchGetItem`, do not access any indexes at all. In these cases, specifying `INDEXES` will only return `ConsumedCapacity` information for table(s).
+ `TOTAL` - The response includes only the aggregate `ConsumedCapacity` for the operation.
+ `NONE` - No `ConsumedCapacity` details are included in the response.
Type: String
Valid Values: `INDEXES | TOTAL | NONE`
Required: No
** [ReturnItemCollectionMetrics](#API_UpdateItem_RequestSyntax) **
Determines whether item collection metrics are returned. If set to `SIZE`, the response includes statistics about item collections, if any, that were modified during the operation are returned in the response. If set to `NONE` (the default), no statistics are returned.
Type: String
Valid Values: `SIZE | NONE`
Required: No
** [ReturnValues](#API_UpdateItem_RequestSyntax) **
Use `ReturnValues` if you want to get the item attributes as they appear before or after they are successfully updated. For `UpdateItem`, the valid values are:
+ `NONE` - If `ReturnValues` is not specified, or if its value is `NONE`, then nothing is returned. (This setting is the default for `ReturnValues`.)
+ `ALL_OLD` - Returns all of the attributes of the item, as they appeared before the UpdateItem operation.
+ `UPDATED_OLD` - Returns only the updated attributes, as they appeared before the UpdateItem operation.
+ `ALL_NEW` - Returns all of the attributes of the item, as they appear after the UpdateItem operation.
+ `UPDATED_NEW` - Returns only the updated attributes, as they appear after the UpdateItem operation.
There is no additional cost associated with requesting a return value aside from the small network and processing overhead of receiving a larger response. No read capacity units are consumed.
The values returned are strongly consistent.
Type: String
Valid Values: `NONE | ALL_OLD | UPDATED_OLD | ALL_NEW | UPDATED_NEW`
Required: No
** [ReturnValuesOnConditionCheckFailure](#API_UpdateItem_RequestSyntax) **
An optional parameter that returns the item attributes for an `UpdateItem` operation that failed a condition check.
There is no additional cost associated with requesting a return value aside from the small network and processing overhead of receiving a larger response. No read capacity units are consumed.
Type: String
Valid Values: `ALL_OLD | NONE`
Required: No
** [UpdateExpression](#API_UpdateItem_RequestSyntax) **
An expression that defines one or more attributes to be updated, the action to be performed on them, and new values for them.
The following action values are available for `UpdateExpression`.
+ `SET` - Adds one or more attributes and values to an item. If any of these attributes already exist, they are replaced by the new values. You can also use `SET` to add or subtract from an attribute that is of type Number. For example: `SET myNum = myNum + :val`
`SET` supports the following functions:
+ `if_not_exists (path, operand)` - if the item does not contain an attribute at the specified path, then `if_not_exists` evaluates to operand; otherwise, it evaluates to path. You can use this function to avoid overwriting an attribute that may already be present in the item.
+ `list_append (operand, operand)` - evaluates to a list with a new element added to it. You can append the new element to the start or the end of the list by reversing the order of the operands.
These function names are case-sensitive.
+ `REMOVE` - Removes one or more attributes from an item.
+ `ADD` - Adds the specified value to the item, if the attribute does not already exist. If the attribute does exist, then the behavior of `ADD` depends on the data type of the attribute:
+ If the existing attribute is a number, and if `Value` is also a number, then `Value` is mathematically added to the existing attribute. If `Value` is a negative number, then it is subtracted from the existing attribute.
**Note**
If you use `ADD` to increment or decrement a number value for an item that doesn't exist before the update, DynamoDB uses `0` as the initial value.
Similarly, if you use `ADD` for an existing item to increment or decrement an attribute value that doesn't exist before the update, DynamoDB uses `0` as the initial value. For example, suppose that the item you want to update doesn't have an attribute named `itemcount`, but you decide to `ADD` the number `3` to this attribute anyway. DynamoDB will create the `itemcount` attribute, set its initial value to `0`, and finally add `3` to it. The result will be a new `itemcount` attribute in the item, with a value of `3`.
+ If the existing data type is a set and if `Value` is also a set, then `Value` is added to the existing set. For example, if the attribute value is the set `[1,2]`, and the `ADD` action specified `[3]`, then the final attribute value is `[1,2,3]`. An error occurs if an `ADD` action is specified for a set attribute and the attribute type specified does not match the existing set type.
Both sets must have the same primitive data type. For example, if the existing data type is a set of strings, the `Value` must also be a set of strings.
**Important**
The `ADD` action only supports Number and set data types.
+ `DELETE` - Deletes an element from a set.
If a set of values is specified, then those values are subtracted from the old set. For example, if the attribute value was the set `[a,b,c]` and the `DELETE` action specifies `[a,c]`, then the final attribute value is `[b]`. Specifying an empty set is an error.
**Important**
The `DELETE` action only supports set data types.
You can have many actions in a single expression, such as the following: `SET a=:value1, b=:value2 DELETE :value3, :value4, :value5`
For more information on update expressions, see [Modifying Items and Attributes](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.Modifying.html) in the *Amazon DynamoDB Developer Guide*.
Type: String
Required: No
## Response Syntax
```
{
"Attributes": {
"string" : {
"B": blob,
"BOOL": boolean,
"BS": [ blob ],
"L": [
"AttributeValue"
],
"M": {
"string" : "AttributeValue"
},
"N": "string",
"NS": [ "string" ],
"NULL": boolean,
"S": "string",
"SS": [ "string" ]
}
},
"ConsumedCapacity": {
"CapacityUnits": number,
"GlobalSecondaryIndexes": {
"string" : {
"CapacityUnits": number,
"ReadCapacityUnits": number,
"WriteCapacityUnits": number
}
},
"LocalSecondaryIndexes": {
"string" : {
"CapacityUnits": number,
"ReadCapacityUnits": number,
"WriteCapacityUnits": number
}
},
"ReadCapacityUnits": number,
"Table": {
"CapacityUnits": number,
"ReadCapacityUnits": number,
"WriteCapacityUnits": number
},
"TableName": "string",
"WriteCapacityUnits": number
},
"ItemCollectionMetrics": {
"ItemCollectionKey": {
"string" : {
"B": blob,
"BOOL": boolean,
"BS": [ blob ],
"L": [
"AttributeValue"
],
"M": {
"string" : "AttributeValue"
},
"N": "string",
"NS": [ "string" ],
"NULL": boolean,
"S": "string",
"SS": [ "string" ]
}
},
"SizeEstimateRangeGB": [ number ]
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [Attributes](#API_UpdateItem_ResponseSyntax) **
A map of attribute values as they appear before or after the `UpdateItem` operation, as determined by the `ReturnValues` parameter.
The `Attributes` map is only present if the update was successful and `ReturnValues` was specified as something other than `NONE` in the request. Each element represents one attribute.
Type: String to [AttributeValue](API_AttributeValue.md) object map
Key Length Constraints: Maximum length of 65535.
** [ConsumedCapacity](#API_UpdateItem_ResponseSyntax) **
The capacity units consumed by the `UpdateItem` operation. The data returned includes the total provisioned throughput consumed, along with statistics for the table and any indexes involved in the operation. `ConsumedCapacity` is only returned if the `ReturnConsumedCapacity` parameter was specified. For more information, see [Capacity unity consumption for write operations](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/read-write-operations.html#write-operation-consumption) in the *Amazon DynamoDB Developer Guide*.
Type: [ConsumedCapacity](API_ConsumedCapacity.md) object
** [ItemCollectionMetrics](#API_UpdateItem_ResponseSyntax) **
Information about item collections, if any, that were affected by the `UpdateItem` operation. `ItemCollectionMetrics` is only returned if the `ReturnItemCollectionMetrics` parameter was specified. If the table does not have any local secondary indexes, this information is not returned in the response.
Each `ItemCollectionMetrics` element consists of:
+ `ItemCollectionKey` - The partition key value of the item collection. This is the same as the partition key value of the item itself.
+ `SizeEstimateRangeGB` - An estimate of item collection size, in gigabytes. This value is a two-element array containing a lower bound and an upper bound for the estimate. The estimate includes the size of all the items in the table, plus the size of all attributes projected into all of the local secondary indexes on that table. Use this estimate to measure whether a local secondary index is approaching its size limit.
The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate.
Type: [ItemCollectionMetrics](API_ItemCollectionMetrics.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** ConditionalCheckFailedException **
A condition specified in the operation failed to be evaluated.
** Item **
Item which caused the `ConditionalCheckFailedException`.
** message **
The conditional request failed.
HTTP Status Code: 400
** InternalServerError **
An error occurred on the server side.
** message **
The server encountered an internal error trying to fulfill the request.
HTTP Status Code: 500
** ItemCollectionSizeLimitExceededException **
An item collection is too large. This exception is only returned for tables that have one or more local secondary indexes.
** message **
The total size of an item collection has exceeded the maximum limit of 10 gigabytes.
HTTP Status Code: 400
** ProvisionedThroughputExceededException **
The request was denied due to request throttling. For detailed information about why the request was throttled and the ARN of the impacted resource, find the [ThrottlingReason](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_ThrottlingReason.html) field in the returned exception. The AWS SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to [Error Retries and Exponential Backoff](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Programming.Errors.html#Programming.Errors.RetryAndBackoff) in the *Amazon DynamoDB Developer Guide*.
** message **
You exceeded your maximum allowed provisioned throughput.
** ThrottlingReasons **
A list of [ThrottlingReason](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_ThrottlingReason.html) that provide detailed diagnostic information about why the request was throttled.
HTTP Status Code: 400
** ReplicatedWriteConflictException **
The request was rejected because one or more items in the request are being modified by a request in another Region.
HTTP Status Code: 400
** RequestLimitExceeded **
Throughput exceeds the current throughput quota for your account. For detailed information about why the request was throttled and the ARN of the impacted resource, find the [ThrottlingReason](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_ThrottlingReason.html) field in the returned exception. Contact [Support](https://aws.amazon.com/support) to request a quota increase.
** ThrottlingReasons **
A list of [ThrottlingReason](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_ThrottlingReason.html) that provide detailed diagnostic information about why the request was throttled.
HTTP Status Code: 400
** ResourceNotFoundException **
The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be `ACTIVE`.
** message **
The resource which is being requested does not exist.
HTTP Status Code: 400
** ThrottlingException **
The request was denied due to request throttling. For detailed information about why the request was throttled and the ARN of the impacted resource, find the [ThrottlingReason](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_ThrottlingReason.html) field in the returned exception.
** throttlingReasons **
A list of [ThrottlingReason](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_ThrottlingReason.html) that provide detailed diagnostic information about why the request was throttled.
HTTP Status Code: 400
** TransactionConflictException **
Operation was rejected because there is an ongoing transaction for the item.
HTTP Status Code: 400
## Examples
### Conditional Update
This example updates the `Thread` table, changing the `LastPostedBy` attribute, but only if `LastPostedBy` is currently "`fred@example.com`". All of the item's attributes, as they appear after the update, are returned in the response.
#### Sample Request
```
POST / HTTP/1.1
Host: dynamodb..;
Accept-Encoding: identity
Content-Length:
User-Agent:
Content-Type: application/x-amz-json-1.0
Authorization: AWS4-HMAC-SHA256 Credential=, SignedHeaders=, Signature=
X-Amz-Date:
X-Amz-Target: DynamoDB_20120810.UpdateItem
{
"TableName": "Thread",
"Key": {
"ForumName": {
"S": "Amazon DynamoDB"
},
"Subject": {
"S": "Maximum number of items?"
}
},
"UpdateExpression": "set LastPostedBy = :val1",
"ConditionExpression": "LastPostedBy = :val2",
"ExpressionAttributeValues": {
":val1": {"S": "alice@example.com"},
":val2": {"S": "fred@example.com"}
},
"ReturnValues": "ALL_NEW"
}
```
#### Sample Response
```
HTTP/1.1 200 OK
x-amzn-RequestId:
x-amz-crc32:
Content-Type: application/x-amz-json-1.0
Content-Length:
Date:
{
"Attributes": {
"LastPostedBy": {
"S": "alice@example.com"
},
"ForumName": {
"S": "Amazon DynamoDB"
},
"LastPostDateTime": {
"S": "20130320010350"
},
"Tags": {
"SS": ["Update","Multiple Items","HelpMe"]
},
"Subject": {
"S": "Maximum number of items?"
},
"Views": {
"N": "5"
},
"Message": {
"S": "I want to put 10 million data items to an Amazon DynamoDB table. Is there an upper limit?"
}
}
}
```
### Atomic Counter
The following example increments the `Replies` attribute in the `Thread` table whenever someone posts a reply. Because `ReturnValues` is set to `NONE`, no output appears in the response payload.
#### Sample Request
```
POST / HTTP/1.1
Host: dynamodb..;
Accept-Encoding: identity
Content-Length:
User-Agent:
Content-Type: application/x-amz-json-1.0
Authorization: AWS4-HMAC-SHA256 Credential=, SignedHeaders=, Signature=
X-Amz-Date:
X-Amz-Target: DynamoDB_20120810.UpdateItem
{
"TableName": "Thread",
"Key": {
"ForumName": {
"S": "Amazon DynamoDB"
},
"Subject": {
"S": "A question about updates"
}
},
"UpdateExpression": "set Replies = Replies + :num",
"ExpressionAttributeValues": {
":num": {"N": "1"}
},
"ReturnValues" : "NONE"
}
```
#### Sample Response
```
HTTP/1.1 200 OK
x-amzn-RequestId:
x-amz-crc32:
Content-Type: application/x-amz-json-1.0
Content-Length:
Date:
{
}
```
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/dynamodb-2012-08-10/UpdateItem)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/dynamodb-2012-08-10/UpdateItem)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/UpdateItem)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/dynamodb-2012-08-10/UpdateItem)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/UpdateItem)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/dynamodb-2012-08-10/UpdateItem)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/dynamodb-2012-08-10/UpdateItem)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/dynamodb-2012-08-10/UpdateItem)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/dynamodb-2012-08-10/UpdateItem)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/UpdateItem)
# UpdateKinesisStreamingDestination
The command to update the Kinesis stream destination.
## Request Syntax
```
{
"StreamArn": "string",
"TableName": "string",
"UpdateKinesisStreamingConfiguration": {
"ApproximateCreationDateTimePrecision": "string"
}
}
```
## Request Parameters
The request accepts the following data in JSON format.
**Note**
In the following list, the required parameters are described first.
** [StreamArn](#API_UpdateKinesisStreamingDestination_RequestSyntax) **
The Amazon Resource Name (ARN) for the Kinesis stream input.
Type: String
Length Constraints: Minimum length of 37. Maximum length of 1024.
Required: Yes
** [TableName](#API_UpdateKinesisStreamingDestination_RequestSyntax) **
The table name for the Kinesis streaming destination input. You can also provide the ARN of the table in this parameter.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: Yes
** [UpdateKinesisStreamingConfiguration](#API_UpdateKinesisStreamingDestination_RequestSyntax) **
The command to update the Kinesis stream configuration.
Type: [UpdateKinesisStreamingConfiguration](API_UpdateKinesisStreamingConfiguration.md) object
Required: No
## Response Syntax
```
{
"DestinationStatus": "string",
"StreamArn": "string",
"TableName": "string",
"UpdateKinesisStreamingConfiguration": {
"ApproximateCreationDateTimePrecision": "string"
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [DestinationStatus](#API_UpdateKinesisStreamingDestination_ResponseSyntax) **
The status of the attempt to update the Kinesis streaming destination output.
Type: String
Valid Values: `ENABLING | ACTIVE | DISABLING | DISABLED | ENABLE_FAILED | UPDATING`
** [StreamArn](#API_UpdateKinesisStreamingDestination_ResponseSyntax) **
The ARN for the Kinesis stream input.
Type: String
Length Constraints: Minimum length of 37. Maximum length of 1024.
** [TableName](#API_UpdateKinesisStreamingDestination_ResponseSyntax) **
The table name for the Kinesis streaming destination output.
Type: String
Length Constraints: Minimum length of 3. Maximum length of 255.
Pattern: `[a-zA-Z0-9_.-]+`
** [UpdateKinesisStreamingConfiguration](#API_UpdateKinesisStreamingDestination_ResponseSyntax) **
The command to update the Kinesis streaming destination configuration.
Type: [UpdateKinesisStreamingConfiguration](API_UpdateKinesisStreamingConfiguration.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalServerError **
An error occurred on the server side.
** message **
The server encountered an internal error trying to fulfill the request.
HTTP Status Code: 500
** LimitExceededException **
There is no limit to the number of daily on-demand backups that can be taken.
For most purposes, up to 500 simultaneous table operations are allowed per account. These operations include `CreateTable`, `UpdateTable`, `DeleteTable`,`UpdateTimeToLive`, `RestoreTableFromBackup`, and `RestoreTableToPointInTime`.
When you are creating a table with one or more secondary indexes, you can have up to 250 such requests running at a time. However, if the table or index specifications are complex, then DynamoDB might temporarily reduce the number of concurrent operations.
When importing into DynamoDB, up to 50 simultaneous import table operations are allowed per account.
There is a soft account quota of 2,500 tables.
GetRecords was called with a value of more than 1000 for the limit request parameter.
More than 2 processes are reading from the same streams shard at the same time. Exceeding this limit may result in request throttling.
** message **
Too many operations for a given subscriber.
HTTP Status Code: 400
** ResourceInUseException **
The operation conflicts with the resource's availability. For example:
+ You attempted to recreate an existing table.
+ You tried to delete a table currently in the `CREATING` state.
+ You tried to update a resource that was already being updated.
When appropriate, wait for the ongoing update to complete and attempt the request again.
** message **
The resource which is being attempted to be changed is in use.
HTTP Status Code: 400
** ResourceNotFoundException **
The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be `ACTIVE`.
** message **
The resource which is being requested does not exist.
HTTP Status Code: 400
## Examples
### Update the configuration of a kinesis streaming destination on a table
This example updates a kinesis streaming destination to produce records with ApproximateCreationDateTime timestamps at millisecond precision.
#### Sample Request
```
POST / HTTP/1.1
Host: dynamodb..;
Accept-Encoding: identity
Content-Length:
User-Agent:
Content-Type: application/x-amz-json-1.0
Authorization: AWS4-HMAC-SHA256 Credential=, SignedHeaders=, Signature=
X-Amz-Date:
X-Amz-Target: DynamoDB_20120810.UpdateKinesisStreamingDestination
{
"StreamArn": "arn:aws:kinesis:us-east-1:123456789012:stream/example_stream",
"TableName": "example_table",
"UpdateKinesisStreamingConfiguration": {
"ApproximateCreationDateTimePrecision": "MILLISECOND"
}
}
```
#### Sample Response
```
HTTP/1.1 200 OK
x-amzn-RequestId:
x-amz-crc32:
Content-Type: application/x-amz-json-1.0
Content-Length:
Date:
{
"StreamArn": "arn:aws:kinesis:us-east-1:123456789012:stream/example_stream",
"TableName": "example_table",
"DestinationStatus": "UPDATING",
"UpdateKinesisStreamingConfiguration": {
"ApproximateCreationDateTimePrecision": "MILLISECOND"
}
}
```
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/dynamodb-2012-08-10/UpdateKinesisStreamingDestination)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/dynamodb-2012-08-10/UpdateKinesisStreamingDestination)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/UpdateKinesisStreamingDestination)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/dynamodb-2012-08-10/UpdateKinesisStreamingDestination)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/UpdateKinesisStreamingDestination)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/dynamodb-2012-08-10/UpdateKinesisStreamingDestination)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/dynamodb-2012-08-10/UpdateKinesisStreamingDestination)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/dynamodb-2012-08-10/UpdateKinesisStreamingDestination)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/dynamodb-2012-08-10/UpdateKinesisStreamingDestination)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/UpdateKinesisStreamingDestination)
# UpdateTable
Modifies the provisioned throughput settings, global secondary indexes, or DynamoDB Streams settings for a given table.
You can only perform one of the following operations at once:
+ Modify the provisioned throughput settings of the table.
+ Remove a global secondary index from the table.
+ Create a new global secondary index on the table. After the index begins backfilling, you can use `UpdateTable` to perform other operations.
`UpdateTable` is an asynchronous operation; while it's executing, the table status changes from `ACTIVE` to `UPDATING`. While it's `UPDATING`, you can't issue another `UpdateTable` request. When the table returns to the `ACTIVE` state, the `UpdateTable` operation is complete.
## Request Syntax
```
{
"AttributeDefinitions": [
{
"AttributeName": "string",
"AttributeType": "string"
}
],
"BillingMode": "string",
"DeletionProtectionEnabled": boolean,
"GlobalSecondaryIndexUpdates": [
{
"Create": {
"IndexName": "string",
"KeySchema": [
{
"AttributeName": "string",
"KeyType": "string"
}
],
"OnDemandThroughput": {
"MaxReadRequestUnits": number,
"MaxWriteRequestUnits": number
},
"Projection": {
"NonKeyAttributes": [ "string" ],
"ProjectionType": "string"
},
"ProvisionedThroughput": {
"ReadCapacityUnits": number,
"WriteCapacityUnits": number
},
"WarmThroughput": {
"ReadUnitsPerSecond": number,
"WriteUnitsPerSecond": number
}
},
"Delete": {
"IndexName": "string"
},
"Update": {
"IndexName": "string",
"OnDemandThroughput": {
"MaxReadRequestUnits": number,
"MaxWriteRequestUnits": number
},
"ProvisionedThroughput": {
"ReadCapacityUnits": number,
"WriteCapacityUnits": number
},
"WarmThroughput": {
"ReadUnitsPerSecond": number,
"WriteUnitsPerSecond": number
}
}
}
],
"GlobalTableSettingsReplicationMode": "string",
"GlobalTableWitnessUpdates": [
{
"Create": {
"RegionName": "string"
},
"Delete": {
"RegionName": "string"
}
}
],
"MultiRegionConsistency": "string",
"OnDemandThroughput": {
"MaxReadRequestUnits": number,
"MaxWriteRequestUnits": number
},
"ProvisionedThroughput": {
"ReadCapacityUnits": number,
"WriteCapacityUnits": number
},
"ReplicaUpdates": [
{
"Create": {
"GlobalSecondaryIndexes": [
{
"IndexName": "string",
"OnDemandThroughputOverride": {
"MaxReadRequestUnits": number
},
"ProvisionedThroughputOverride": {
"ReadCapacityUnits": number
}
}
],
"KMSMasterKeyId": "string",
"OnDemandThroughputOverride": {
"MaxReadRequestUnits": number
},
"ProvisionedThroughputOverride": {
"ReadCapacityUnits": number
},
"RegionName": "string",
"TableClassOverride": "string"
},
"Delete": {
"RegionName": "string"
},
"Update": {
"GlobalSecondaryIndexes": [
{
"IndexName": "string",
"OnDemandThroughputOverride": {
"MaxReadRequestUnits": number
},
"ProvisionedThroughputOverride": {
"ReadCapacityUnits": number
}
}
],
"KMSMasterKeyId": "string",
"OnDemandThroughputOverride": {
"MaxReadRequestUnits": number
},
"ProvisionedThroughputOverride": {
"ReadCapacityUnits": number
},
"RegionName": "string",
"TableClassOverride": "string"
}
}
],
"SSESpecification": {
"Enabled": boolean,
"KMSMasterKeyId": "string",
"SSEType": "string"
},
"StreamSpecification": {
"StreamEnabled": boolean,
"StreamViewType": "string"
},
"TableClass": "string",
"TableName": "string",
"WarmThroughput": {
"ReadUnitsPerSecond": number,
"WriteUnitsPerSecond": number
}
}
```
## Request Parameters
The request accepts the following data in JSON format.
**Note**
In the following list, the required parameters are described first.
** [TableName](#API_UpdateTable_RequestSyntax) **
The name of the table to be updated. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: Yes
** [AttributeDefinitions](#API_UpdateTable_RequestSyntax) **
An array of attributes that describe the key schema for the table and indexes. If you are adding a new global secondary index to the table, `AttributeDefinitions` must include the key element(s) of the new index.
Type: Array of [AttributeDefinition](API_AttributeDefinition.md) objects
Required: No
** [BillingMode](#API_UpdateTable_RequestSyntax) **
Controls how you are charged for read and write throughput and how you manage capacity. When switching from pay-per-request to provisioned capacity, initial provisioned capacity values must be set. The initial provisioned capacity values are estimated based on the consumed read and write capacity of your table and global secondary indexes over the past 30 minutes.
+ `PAY_PER_REQUEST` - We recommend using `PAY_PER_REQUEST` for most DynamoDB workloads. `PAY_PER_REQUEST` sets the billing mode to [On-demand capacity mode](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/on-demand-capacity-mode.html).
+ `PROVISIONED` - We recommend using `PROVISIONED` for steady workloads with predictable growth where capacity requirements can be reliably forecasted. `PROVISIONED` sets the billing mode to [Provisioned capacity mode](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/provisioned-capacity-mode.html).
Type: String
Valid Values: `PROVISIONED | PAY_PER_REQUEST`
Required: No
** [DeletionProtectionEnabled](#API_UpdateTable_RequestSyntax) **
Indicates whether deletion protection is to be enabled (true) or disabled (false) on the table.
Type: Boolean
Required: No
** [GlobalSecondaryIndexUpdates](#API_UpdateTable_RequestSyntax) **
An array of one or more global secondary indexes for the table. For each index in the array, you can request one action:
+ `Create` - add a new global secondary index to the table.
+ `Update` - modify the provisioned throughput settings of an existing global secondary index.
+ `Delete` - remove a global secondary index from the table.
You can create or delete only one global secondary index per `UpdateTable` operation.
For more information, see [Managing Global Secondary Indexes](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/GSI.OnlineOps.html) in the *Amazon DynamoDB Developer Guide*.
Type: Array of [GlobalSecondaryIndexUpdate](API_GlobalSecondaryIndexUpdate.md) objects
Required: No
** [GlobalTableSettingsReplicationMode](#API_UpdateTable_RequestSyntax) **
Controls the settings replication mode for a global table replica. This attribute can be defined using UpdateTable operation only on a regional table with values:
+ `ENABLED`: Defines settings replication on a regional table to be used as a source table for creating Multi-Account Global Table.
+ `DISABLED`: Remove settings replication on a regional table. Settings replication needs to be defined to ENABLED again in order to create a Multi-Account Global Table using this table.
Type: String
Valid Values: `ENABLED | DISABLED | ENABLED_WITH_OVERRIDES`
Required: No
** [GlobalTableWitnessUpdates](#API_UpdateTable_RequestSyntax) **
A list of witness updates for a MRSC global table. A witness provides a cost-effective alternative to a full replica in a MRSC global table by maintaining replicated change data written to global table replicas. You cannot perform read or write operations on a witness. For each witness, you can request one action:
+ `Create` - add a new witness to the global table.
+ `Delete` - remove a witness from the global table.
You can create or delete only one witness per `UpdateTable` operation.
For more information, see [Multi-Region strong consistency (MRSC)](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/V2globaltables_HowItWorks.html#V2globaltables_HowItWorks.consistency-modes) in the Amazon DynamoDB Developer Guide
Type: Array of [GlobalTableWitnessGroupUpdate](API_GlobalTableWitnessGroupUpdate.md) objects
Array Members: Fixed number of 1 item.
Required: No
** [MultiRegionConsistency](#API_UpdateTable_RequestSyntax) **
Specifies the consistency mode for a new global table. This parameter is only valid when you create a global table by specifying one or more [Create](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_ReplicationGroupUpdate.html#DDB-Type-ReplicationGroupUpdate-Create) actions in the [ReplicaUpdates](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_UpdateTable.html#DDB-UpdateTable-request-ReplicaUpdates) action list.
You can specify one of the following consistency modes:
+ `EVENTUAL`: Configures a new global table for multi-Region eventual consistency (MREC). This is the default consistency mode for global tables.
+ `STRONG`: Configures a new global table for multi-Region strong consistency (MRSC).
If you don't specify this field, the global table consistency mode defaults to `EVENTUAL`. For more information about global tables consistency modes, see [ Consistency modes](https://docs.aws.amazon.com/V2globaltables_HowItWorks.html#V2globaltables_HowItWorks.consistency-modes) in DynamoDB developer guide.
Type: String
Valid Values: `EVENTUAL | STRONG`
Required: No
** [OnDemandThroughput](#API_UpdateTable_RequestSyntax) **
Updates the maximum number of read and write units for the specified table in on-demand capacity mode. If you use this parameter, you must specify `MaxReadRequestUnits`, `MaxWriteRequestUnits`, or both.
Type: [OnDemandThroughput](API_OnDemandThroughput.md) object
Required: No
** [ProvisionedThroughput](#API_UpdateTable_RequestSyntax) **
The new provisioned throughput settings for the specified table or index.
Type: [ProvisionedThroughput](API_ProvisionedThroughput.md) object
Required: No
** [ReplicaUpdates](#API_UpdateTable_RequestSyntax) **
A list of replica update actions (create, delete, or update) for the table.
Type: Array of [ReplicationGroupUpdate](API_ReplicationGroupUpdate.md) objects
Array Members: Minimum number of 1 item.
Required: No
** [SSESpecification](#API_UpdateTable_RequestSyntax) **
The new server-side encryption settings for the specified table.
Type: [SSESpecification](API_SSESpecification.md) object
Required: No
** [StreamSpecification](#API_UpdateTable_RequestSyntax) **
Represents the DynamoDB Streams configuration for the table.
You receive a `ValidationException` if you try to enable a stream on a table that already has a stream, or if you try to disable a stream on a table that doesn't have a stream.
Type: [StreamSpecification](API_StreamSpecification.md) object
Required: No
** [TableClass](#API_UpdateTable_RequestSyntax) **
The table class of the table to be updated. Valid values are `STANDARD` and `STANDARD_INFREQUENT_ACCESS`.
Type: String
Valid Values: `STANDARD | STANDARD_INFREQUENT_ACCESS`
Required: No
** [WarmThroughput](#API_UpdateTable_RequestSyntax) **
Represents the warm throughput (in read units per second and write units per second) for updating a table.
Type: [WarmThroughput](API_WarmThroughput.md) object
Required: No
## Response Syntax
```
{
"TableDescription": {
"ArchivalSummary": {
"ArchivalBackupArn": "string",
"ArchivalDateTime": number,
"ArchivalReason": "string"
},
"AttributeDefinitions": [
{
"AttributeName": "string",
"AttributeType": "string"
}
],
"BillingModeSummary": {
"BillingMode": "string",
"LastUpdateToPayPerRequestDateTime": number
},
"CreationDateTime": number,
"DeletionProtectionEnabled": boolean,
"GlobalSecondaryIndexes": [
{
"Backfilling": boolean,
"IndexArn": "string",
"IndexName": "string",
"IndexSizeBytes": number,
"IndexStatus": "string",
"ItemCount": number,
"KeySchema": [
{
"AttributeName": "string",
"KeyType": "string"
}
],
"OnDemandThroughput": {
"MaxReadRequestUnits": number,
"MaxWriteRequestUnits": number
},
"Projection": {
"NonKeyAttributes": [ "string" ],
"ProjectionType": "string"
},
"ProvisionedThroughput": {
"LastDecreaseDateTime": number,
"LastIncreaseDateTime": number,
"NumberOfDecreasesToday": number,
"ReadCapacityUnits": number,
"WriteCapacityUnits": number
},
"WarmThroughput": {
"ReadUnitsPerSecond": number,
"Status": "string",
"WriteUnitsPerSecond": number
}
}
],
"GlobalTableSettingsReplicationMode": "string",
"GlobalTableVersion": "string",
"GlobalTableWitnesses": [
{
"RegionName": "string",
"WitnessStatus": "string"
}
],
"ItemCount": number,
"KeySchema": [
{
"AttributeName": "string",
"KeyType": "string"
}
],
"LatestStreamArn": "string",
"LatestStreamLabel": "string",
"LocalSecondaryIndexes": [
{
"IndexArn": "string",
"IndexName": "string",
"IndexSizeBytes": number,
"ItemCount": number,
"KeySchema": [
{
"AttributeName": "string",
"KeyType": "string"
}
],
"Projection": {
"NonKeyAttributes": [ "string" ],
"ProjectionType": "string"
}
}
],
"MultiRegionConsistency": "string",
"OnDemandThroughput": {
"MaxReadRequestUnits": number,
"MaxWriteRequestUnits": number
},
"ProvisionedThroughput": {
"LastDecreaseDateTime": number,
"LastIncreaseDateTime": number,
"NumberOfDecreasesToday": number,
"ReadCapacityUnits": number,
"WriteCapacityUnits": number
},
"Replicas": [
{
"GlobalSecondaryIndexes": [
{
"IndexName": "string",
"OnDemandThroughputOverride": {
"MaxReadRequestUnits": number
},
"ProvisionedThroughputOverride": {
"ReadCapacityUnits": number
},
"WarmThroughput": {
"ReadUnitsPerSecond": number,
"Status": "string",
"WriteUnitsPerSecond": number
}
}
],
"GlobalTableSettingsReplicationMode": "string",
"KMSMasterKeyId": "string",
"OnDemandThroughputOverride": {
"MaxReadRequestUnits": number
},
"ProvisionedThroughputOverride": {
"ReadCapacityUnits": number
},
"RegionName": "string",
"ReplicaArn": "string",
"ReplicaInaccessibleDateTime": number,
"ReplicaStatus": "string",
"ReplicaStatusDescription": "string",
"ReplicaStatusPercentProgress": "string",
"ReplicaTableClassSummary": {
"LastUpdateDateTime": number,
"TableClass": "string"
},
"WarmThroughput": {
"ReadUnitsPerSecond": number,
"Status": "string",
"WriteUnitsPerSecond": number
}
}
],
"RestoreSummary": {
"RestoreDateTime": number,
"RestoreInProgress": boolean,
"SourceBackupArn": "string",
"SourceTableArn": "string"
},
"SSEDescription": {
"InaccessibleEncryptionDateTime": number,
"KMSMasterKeyArn": "string",
"SSEType": "string",
"Status": "string"
},
"StreamSpecification": {
"StreamEnabled": boolean,
"StreamViewType": "string"
},
"TableArn": "string",
"TableClassSummary": {
"LastUpdateDateTime": number,
"TableClass": "string"
},
"TableId": "string",
"TableName": "string",
"TableSizeBytes": number,
"TableStatus": "string",
"WarmThroughput": {
"ReadUnitsPerSecond": number,
"Status": "string",
"WriteUnitsPerSecond": number
}
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [TableDescription](#API_UpdateTable_ResponseSyntax) **
Represents the properties of the table.
Type: [TableDescription](API_TableDescription.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalServerError **
An error occurred on the server side.
** message **
The server encountered an internal error trying to fulfill the request.
HTTP Status Code: 500
** LimitExceededException **
There is no limit to the number of daily on-demand backups that can be taken.
For most purposes, up to 500 simultaneous table operations are allowed per account. These operations include `CreateTable`, `UpdateTable`, `DeleteTable`,`UpdateTimeToLive`, `RestoreTableFromBackup`, and `RestoreTableToPointInTime`.
When you are creating a table with one or more secondary indexes, you can have up to 250 such requests running at a time. However, if the table or index specifications are complex, then DynamoDB might temporarily reduce the number of concurrent operations.
When importing into DynamoDB, up to 50 simultaneous import table operations are allowed per account.
There is a soft account quota of 2,500 tables.
GetRecords was called with a value of more than 1000 for the limit request parameter.
More than 2 processes are reading from the same streams shard at the same time. Exceeding this limit may result in request throttling.
** message **
Too many operations for a given subscriber.
HTTP Status Code: 400
** ResourceInUseException **
The operation conflicts with the resource's availability. For example:
+ You attempted to recreate an existing table.
+ You tried to delete a table currently in the `CREATING` state.
+ You tried to update a resource that was already being updated.
When appropriate, wait for the ongoing update to complete and attempt the request again.
** message **
The resource which is being attempted to be changed is in use.
HTTP Status Code: 400
** ResourceNotFoundException **
The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be `ACTIVE`.
** message **
The resource which is being requested does not exist.
HTTP Status Code: 400
## Examples
### Modify Provisioned Write Throughput
This example changes both the provisioned read and write throughput of the `Thread` table to 10 capacity units.
#### Sample Request
```
POST / HTTP/1.1
Host: dynamodb..;
Accept-Encoding: identity
Content-Length:
User-Agent:
Content-Type: application/x-amz-json-1.0
Authorization: AWS4-HMAC-SHA256 Credential=, SignedHeaders=, Signature=
X-Amz-Date:
X-Amz-Target: DynamoDB_20120810.UpdateTable
{
"TableName": "Thread",
"ProvisionedThroughput": {
"ReadCapacityUnits": 10,
"WriteCapacityUnits": 10
}
}
```
#### Sample Response
```
HTTP/1.1 200 OK
x-amzn-RequestId:
x-amz-crc32:
Content-Type: application/x-amz-json-1.0
Content-Length:
Date:
{
"TableDescription": {
"TableArn": "arn:aws:dynamodb:us-west-2:123456789012:table/Thread",
"AttributeDefinitions": [
{
"AttributeName": "ForumName",
"AttributeType": "S"
},
{
"AttributeName": "LastPostDateTime",
"AttributeType": "S"
},
{
"AttributeName": "Subject",
"AttributeType": "S"
}
],
"CreationDateTime": 1.363801528686E9,
"ItemCount": 0,
"KeySchema": [
{
"AttributeName": "ForumName",
"KeyType": "HASH"
},
{
"AttributeName": "Subject",
"KeyType": "RANGE"
}
],
"LocalSecondaryIndexes": [
{
"IndexName": "LastPostIndex",
"IndexSizeBytes": 0,
"ItemCount": 0,
"KeySchema": [
{
"AttributeName": "ForumName",
"KeyType": "HASH"
},
{
"AttributeName": "LastPostDateTime",
"KeyType": "RANGE"
}
],
"Projection": {
"ProjectionType": "KEYS_ONLY"
}
}
],
"ProvisionedThroughput": {
"LastIncreaseDateTime": 1.363801701282E9,
"NumberOfDecreasesToday": 0,
"ReadCapacityUnits": 5,
"WriteCapacityUnits": 5
},
"TableName": "Thread",
"TableSizeBytes": 0,
"TableStatus": "UPDATING"
}
}
```
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/dynamodb-2012-08-10/UpdateTable)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/dynamodb-2012-08-10/UpdateTable)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/UpdateTable)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/dynamodb-2012-08-10/UpdateTable)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/UpdateTable)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/dynamodb-2012-08-10/UpdateTable)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/dynamodb-2012-08-10/UpdateTable)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/dynamodb-2012-08-10/UpdateTable)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/dynamodb-2012-08-10/UpdateTable)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/UpdateTable)
# UpdateTableReplicaAutoScaling
Updates auto scaling settings on your global tables at once.
## Request Syntax
```
{
"GlobalSecondaryIndexUpdates": [
{
"IndexName": "string",
"ProvisionedWriteCapacityAutoScalingUpdate": {
"AutoScalingDisabled": boolean,
"AutoScalingRoleArn": "string",
"MaximumUnits": number,
"MinimumUnits": number,
"ScalingPolicyUpdate": {
"PolicyName": "string",
"TargetTrackingScalingPolicyConfiguration": {
"DisableScaleIn": boolean,
"ScaleInCooldown": number,
"ScaleOutCooldown": number,
"TargetValue": number
}
}
}
}
],
"ProvisionedWriteCapacityAutoScalingUpdate": {
"AutoScalingDisabled": boolean,
"AutoScalingRoleArn": "string",
"MaximumUnits": number,
"MinimumUnits": number,
"ScalingPolicyUpdate": {
"PolicyName": "string",
"TargetTrackingScalingPolicyConfiguration": {
"DisableScaleIn": boolean,
"ScaleInCooldown": number,
"ScaleOutCooldown": number,
"TargetValue": number
}
}
},
"ReplicaUpdates": [
{
"RegionName": "string",
"ReplicaGlobalSecondaryIndexUpdates": [
{
"IndexName": "string",
"ProvisionedReadCapacityAutoScalingUpdate": {
"AutoScalingDisabled": boolean,
"AutoScalingRoleArn": "string",
"MaximumUnits": number,
"MinimumUnits": number,
"ScalingPolicyUpdate": {
"PolicyName": "string",
"TargetTrackingScalingPolicyConfiguration": {
"DisableScaleIn": boolean,
"ScaleInCooldown": number,
"ScaleOutCooldown": number,
"TargetValue": number
}
}
}
}
],
"ReplicaProvisionedReadCapacityAutoScalingUpdate": {
"AutoScalingDisabled": boolean,
"AutoScalingRoleArn": "string",
"MaximumUnits": number,
"MinimumUnits": number,
"ScalingPolicyUpdate": {
"PolicyName": "string",
"TargetTrackingScalingPolicyConfiguration": {
"DisableScaleIn": boolean,
"ScaleInCooldown": number,
"ScaleOutCooldown": number,
"TargetValue": number
}
}
}
}
],
"TableName": "string"
}
```
## Request Parameters
The request accepts the following data in JSON format.
**Note**
In the following list, the required parameters are described first.
** [TableName](#API_UpdateTableReplicaAutoScaling_RequestSyntax) **
The name of the global table to be updated. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: Yes
** [GlobalSecondaryIndexUpdates](#API_UpdateTableReplicaAutoScaling_RequestSyntax) **
Represents the auto scaling settings of the global secondary indexes of the replica to be updated.
Type: Array of [GlobalSecondaryIndexAutoScalingUpdate](API_GlobalSecondaryIndexAutoScalingUpdate.md) objects
Array Members: Minimum number of 1 item.
Required: No
** [ProvisionedWriteCapacityAutoScalingUpdate](#API_UpdateTableReplicaAutoScaling_RequestSyntax) **
Represents the auto scaling settings to be modified for a global table or global secondary index.
Type: [AutoScalingSettingsUpdate](API_AutoScalingSettingsUpdate.md) object
Required: No
** [ReplicaUpdates](#API_UpdateTableReplicaAutoScaling_RequestSyntax) **
Represents the auto scaling settings of replicas of the table that will be modified.
Type: Array of [ReplicaAutoScalingUpdate](API_ReplicaAutoScalingUpdate.md) objects
Array Members: Minimum number of 1 item.
Required: No
## Response Syntax
```
{
"TableAutoScalingDescription": {
"Replicas": [
{
"GlobalSecondaryIndexes": [
{
"IndexName": "string",
"IndexStatus": "string",
"ProvisionedReadCapacityAutoScalingSettings": {
"AutoScalingDisabled": boolean,
"AutoScalingRoleArn": "string",
"MaximumUnits": number,
"MinimumUnits": number,
"ScalingPolicies": [
{
"PolicyName": "string",
"TargetTrackingScalingPolicyConfiguration": {
"DisableScaleIn": boolean,
"ScaleInCooldown": number,
"ScaleOutCooldown": number,
"TargetValue": number
}
}
]
},
"ProvisionedWriteCapacityAutoScalingSettings": {
"AutoScalingDisabled": boolean,
"AutoScalingRoleArn": "string",
"MaximumUnits": number,
"MinimumUnits": number,
"ScalingPolicies": [
{
"PolicyName": "string",
"TargetTrackingScalingPolicyConfiguration": {
"DisableScaleIn": boolean,
"ScaleInCooldown": number,
"ScaleOutCooldown": number,
"TargetValue": number
}
}
]
}
}
],
"RegionName": "string",
"ReplicaProvisionedReadCapacityAutoScalingSettings": {
"AutoScalingDisabled": boolean,
"AutoScalingRoleArn": "string",
"MaximumUnits": number,
"MinimumUnits": number,
"ScalingPolicies": [
{
"PolicyName": "string",
"TargetTrackingScalingPolicyConfiguration": {
"DisableScaleIn": boolean,
"ScaleInCooldown": number,
"ScaleOutCooldown": number,
"TargetValue": number
}
}
]
},
"ReplicaProvisionedWriteCapacityAutoScalingSettings": {
"AutoScalingDisabled": boolean,
"AutoScalingRoleArn": "string",
"MaximumUnits": number,
"MinimumUnits": number,
"ScalingPolicies": [
{
"PolicyName": "string",
"TargetTrackingScalingPolicyConfiguration": {
"DisableScaleIn": boolean,
"ScaleInCooldown": number,
"ScaleOutCooldown": number,
"TargetValue": number
}
}
]
},
"ReplicaStatus": "string"
}
],
"TableName": "string",
"TableStatus": "string"
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [TableAutoScalingDescription](#API_UpdateTableReplicaAutoScaling_ResponseSyntax) **
Returns information about the auto scaling settings of a table with replicas.
Type: [TableAutoScalingDescription](API_TableAutoScalingDescription.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalServerError **
An error occurred on the server side.
** message **
The server encountered an internal error trying to fulfill the request.
HTTP Status Code: 500
** LimitExceededException **
There is no limit to the number of daily on-demand backups that can be taken.
For most purposes, up to 500 simultaneous table operations are allowed per account. These operations include `CreateTable`, `UpdateTable`, `DeleteTable`,`UpdateTimeToLive`, `RestoreTableFromBackup`, and `RestoreTableToPointInTime`.
When you are creating a table with one or more secondary indexes, you can have up to 250 such requests running at a time. However, if the table or index specifications are complex, then DynamoDB might temporarily reduce the number of concurrent operations.
When importing into DynamoDB, up to 50 simultaneous import table operations are allowed per account.
There is a soft account quota of 2,500 tables.
GetRecords was called with a value of more than 1000 for the limit request parameter.
More than 2 processes are reading from the same streams shard at the same time. Exceeding this limit may result in request throttling.
** message **
Too many operations for a given subscriber.
HTTP Status Code: 400
** ResourceInUseException **
The operation conflicts with the resource's availability. For example:
+ You attempted to recreate an existing table.
+ You tried to delete a table currently in the `CREATING` state.
+ You tried to update a resource that was already being updated.
When appropriate, wait for the ongoing update to complete and attempt the request again.
** message **
The resource which is being attempted to be changed is in use.
HTTP Status Code: 400
** ResourceNotFoundException **
The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be `ACTIVE`.
** message **
The resource which is being requested does not exist.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/dynamodb-2012-08-10/UpdateTableReplicaAutoScaling)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/dynamodb-2012-08-10/UpdateTableReplicaAutoScaling)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/UpdateTableReplicaAutoScaling)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/dynamodb-2012-08-10/UpdateTableReplicaAutoScaling)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/UpdateTableReplicaAutoScaling)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/dynamodb-2012-08-10/UpdateTableReplicaAutoScaling)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/dynamodb-2012-08-10/UpdateTableReplicaAutoScaling)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/dynamodb-2012-08-10/UpdateTableReplicaAutoScaling)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/dynamodb-2012-08-10/UpdateTableReplicaAutoScaling)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/UpdateTableReplicaAutoScaling)
# UpdateTimeToLive
The `UpdateTimeToLive` method enables or disables Time to Live (TTL) for the specified table. A successful `UpdateTimeToLive` call returns the current `TimeToLiveSpecification`. It can take up to one hour for the change to fully process. Any additional `UpdateTimeToLive` calls for the same table during this one hour duration result in a `ValidationException`.
TTL compares the current time in epoch time format to the time stored in the TTL attribute of an item. If the epoch time value stored in the attribute is less than the current time, the item is marked as expired and subsequently deleted.
**Note**
The epoch time format is the number of seconds elapsed since 12:00:00 AM January 1, 1970 UTC.
DynamoDB deletes expired items on a best-effort basis to ensure availability of throughput for other data operations.
**Important**
DynamoDB typically deletes expired items within two days of expiration. The exact duration within which an item gets deleted after expiration is specific to the nature of the workload. Items that have expired and not been deleted will still show up in reads, queries, and scans.
As items are deleted, they are removed from any local secondary index and global secondary index immediately in the same eventually consistent way as a standard delete operation.
For more information, see [Time To Live](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/TTL.html) in the Amazon DynamoDB Developer Guide.
## Request Syntax
```
{
"TableName": "string",
"TimeToLiveSpecification": {
"AttributeName": "string",
"Enabled": boolean
}
}
```
## Request Parameters
The request accepts the following data in JSON format.
**Note**
In the following list, the required parameters are described first.
** [TableName](#API_UpdateTimeToLive_RequestSyntax) **
The name of the table to be configured. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: Yes
** [TimeToLiveSpecification](#API_UpdateTimeToLive_RequestSyntax) **
Represents the settings used to enable or disable Time to Live for the specified table.
Type: [TimeToLiveSpecification](API_TimeToLiveSpecification.md) object
Required: Yes
## Response Syntax
```
{
"TimeToLiveSpecification": {
"AttributeName": "string",
"Enabled": boolean
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [TimeToLiveSpecification](#API_UpdateTimeToLive_ResponseSyntax) **
Represents the output of an `UpdateTimeToLive` operation.
Type: [TimeToLiveSpecification](API_TimeToLiveSpecification.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalServerError **
An error occurred on the server side.
** message **
The server encountered an internal error trying to fulfill the request.
HTTP Status Code: 500
** LimitExceededException **
There is no limit to the number of daily on-demand backups that can be taken.
For most purposes, up to 500 simultaneous table operations are allowed per account. These operations include `CreateTable`, `UpdateTable`, `DeleteTable`,`UpdateTimeToLive`, `RestoreTableFromBackup`, and `RestoreTableToPointInTime`.
When you are creating a table with one or more secondary indexes, you can have up to 250 such requests running at a time. However, if the table or index specifications are complex, then DynamoDB might temporarily reduce the number of concurrent operations.
When importing into DynamoDB, up to 50 simultaneous import table operations are allowed per account.
There is a soft account quota of 2,500 tables.
GetRecords was called with a value of more than 1000 for the limit request parameter.
More than 2 processes are reading from the same streams shard at the same time. Exceeding this limit may result in request throttling.
** message **
Too many operations for a given subscriber.
HTTP Status Code: 400
** ResourceInUseException **
The operation conflicts with the resource's availability. For example:
+ You attempted to recreate an existing table.
+ You tried to delete a table currently in the `CREATING` state.
+ You tried to update a resource that was already being updated.
When appropriate, wait for the ongoing update to complete and attempt the request again.
** message **
The resource which is being attempted to be changed is in use.
HTTP Status Code: 400
** ResourceNotFoundException **
The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be `ACTIVE`.
** message **
The resource which is being requested does not exist.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/dynamodb-2012-08-10/UpdateTimeToLive)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/dynamodb-2012-08-10/UpdateTimeToLive)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/UpdateTimeToLive)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/dynamodb-2012-08-10/UpdateTimeToLive)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dynamodb-2012-08-10/UpdateTimeToLive)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/dynamodb-2012-08-10/UpdateTimeToLive)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/dynamodb-2012-08-10/UpdateTimeToLive)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/dynamodb-2012-08-10/UpdateTimeToLive)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/dynamodb-2012-08-10/UpdateTimeToLive)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dynamodb-2012-08-10/UpdateTimeToLive)
# DynamoDB Accelerator
The following actions are supported by DynamoDB Accelerator:
+ [CreateCluster](API_dax_CreateCluster.md)
+ [CreateParameterGroup](API_dax_CreateParameterGroup.md)
+ [CreateSubnetGroup](API_dax_CreateSubnetGroup.md)
+ [DecreaseReplicationFactor](API_dax_DecreaseReplicationFactor.md)
+ [DeleteCluster](API_dax_DeleteCluster.md)
+ [DeleteParameterGroup](API_dax_DeleteParameterGroup.md)
+ [DeleteSubnetGroup](API_dax_DeleteSubnetGroup.md)
+ [DescribeClusters](API_dax_DescribeClusters.md)
+ [DescribeDefaultParameters](API_dax_DescribeDefaultParameters.md)
+ [DescribeEvents](API_dax_DescribeEvents.md)
+ [DescribeParameterGroups](API_dax_DescribeParameterGroups.md)
+ [DescribeParameters](API_dax_DescribeParameters.md)
+ [DescribeSubnetGroups](API_dax_DescribeSubnetGroups.md)
+ [IncreaseReplicationFactor](API_dax_IncreaseReplicationFactor.md)
+ [ListTags](API_dax_ListTags.md)
+ [RebootNode](API_dax_RebootNode.md)
+ [TagResource](API_dax_TagResource.md)
+ [UntagResource](API_dax_UntagResource.md)
+ [UpdateCluster](API_dax_UpdateCluster.md)
+ [UpdateParameterGroup](API_dax_UpdateParameterGroup.md)
+ [UpdateSubnetGroup](API_dax_UpdateSubnetGroup.md)
# CreateCluster
Creates a DAX cluster. All nodes in the cluster run the same DAX caching software.
## Request Syntax
```
{
"AvailabilityZones": [ "string" ],
"ClusterEndpointEncryptionType": "string",
"ClusterName": "string",
"Description": "string",
"IamRoleArn": "string",
"NetworkType": "string",
"NodeType": "string",
"NotificationTopicArn": "string",
"ParameterGroupName": "string",
"PreferredMaintenanceWindow": "string",
"ReplicationFactor": number,
"SecurityGroupIds": [ "string" ],
"SSESpecification": {
"Enabled": boolean
},
"SubnetGroupName": "string",
"Tags": [
{
"Key": "string",
"Value": "string"
}
]
}
```
## Request Parameters
The request accepts the following data in JSON format.
**Note**
In the following list, the required parameters are described first.
** [ClusterName](#API_dax_CreateCluster_RequestSyntax) **
The cluster identifier. This parameter is stored as a lowercase string.
**Constraints:**
+ A name must contain from 1 to 20 alphanumeric characters or hyphens.
+ The first character must be a letter.
+ A name cannot end with a hyphen or contain two consecutive hyphens.
Type: String
Required: Yes
** [IamRoleArn](#API_dax_CreateCluster_RequestSyntax) **
A valid Amazon Resource Name (ARN) that identifies an IAM role. At runtime, DAX will assume this role and use the role's permissions to access DynamoDB on your behalf.
Type: String
Required: Yes
** [NodeType](#API_dax_CreateCluster_RequestSyntax) **
The compute and memory capacity of the nodes in the cluster.
Type: String
Required: Yes
** [ReplicationFactor](#API_dax_CreateCluster_RequestSyntax) **
The number of nodes in the DAX cluster. A replication factor of 1 will create a single-node cluster, without any read replicas. For additional fault tolerance, you can create a multiple node cluster with one or more read replicas. To do this, set `ReplicationFactor` to a number between 3 (one primary and two read replicas) and 10 (one primary and nine read replicas). `If the AvailabilityZones` parameter is provided, its length must equal the `ReplicationFactor`.
AWS recommends that you have at least two read replicas per cluster.
Type: Integer
Required: Yes
** [AvailabilityZones](#API_dax_CreateCluster_RequestSyntax) **
The Availability Zones (AZs) in which the cluster nodes will reside after the cluster has been created or updated. If provided, the length of this list must equal the `ReplicationFactor` parameter. If you omit this parameter, DAX will spread the nodes across Availability Zones for the highest availability.
Type: Array of strings
Required: No
** [ClusterEndpointEncryptionType](#API_dax_CreateCluster_RequestSyntax) **
The type of encryption the cluster's endpoint should support. Values are:
+ `NONE` for no encryption
+ `TLS` for Transport Layer Security
Type: String
Valid Values: `NONE | TLS`
Required: No
** [Description](#API_dax_CreateCluster_RequestSyntax) **
A description of the cluster.
Type: String
Required: No
** [NetworkType](#API_dax_CreateCluster_RequestSyntax) **
Specifies the IP protocol(s) the cluster uses for network communications. Values are:
+ `ipv4` - The cluster is accessible only through IPv4 addresses
+ `ipv6` - The cluster is accessible only through IPv6 addresses
+ `dual_stack` - The cluster is accessible through both IPv4 and IPv6 addresses.
If no explicit `NetworkType` is provided, the network type is derived based on the subnet group's configuration.
Type: String
Valid Values: `ipv4 | ipv6 | dual_stack`
Required: No
** [NotificationTopicArn](#API_dax_CreateCluster_RequestSyntax) **
The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications will be sent.
The Amazon SNS topic owner must be same as the DAX cluster owner.
Type: String
Required: No
** [ParameterGroupName](#API_dax_CreateCluster_RequestSyntax) **
The parameter group to be associated with the DAX cluster.
Type: String
Required: No
** [PreferredMaintenanceWindow](#API_dax_CreateCluster_RequestSyntax) **
Specifies the weekly time range during which maintenance on the DAX cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period. Valid values for `ddd` are:
+ `sun`
+ `mon`
+ `tue`
+ `wed`
+ `thu`
+ `fri`
+ `sat`
Example: `sun:05:00-sun:09:00`
If you don't specify a preferred maintenance window when you create or modify a cache cluster, DAX assigns a 60-minute maintenance window on a randomly selected day of the week.
Type: String
Required: No
** [SecurityGroupIds](#API_dax_CreateCluster_RequestSyntax) **
A list of security group IDs to be assigned to each node in the DAX cluster. (Each of the security group ID is system-generated.)
If this parameter is not specified, DAX assigns the default VPC security group to each node.
Type: Array of strings
Required: No
** [SSESpecification](#API_dax_CreateCluster_RequestSyntax) **
Represents the settings used to enable server-side encryption on the cluster.
Type: [SSESpecification](API_dax_SSESpecification.md) object
Required: No
** [SubnetGroupName](#API_dax_CreateCluster_RequestSyntax) **
The name of the subnet group to be used for the replication group.
DAX clusters can only run in an Amazon VPC environment. All of the subnets that you specify in a subnet group must exist in the same VPC.
Type: String
Required: No
** [Tags](#API_dax_CreateCluster_RequestSyntax) **
A set of tags to associate with the DAX cluster.
Type: Array of [Tag](API_dax_Tag.md) objects
Required: No
## Response Syntax
```
{
"Cluster": {
"ActiveNodes": number,
"ClusterArn": "string",
"ClusterDiscoveryEndpoint": {
"Address": "string",
"Port": number,
"URL": "string"
},
"ClusterEndpointEncryptionType": "string",
"ClusterName": "string",
"Description": "string",
"IamRoleArn": "string",
"NetworkType": "string",
"NodeIdsToRemove": [ "string" ],
"Nodes": [
{
"AvailabilityZone": "string",
"Endpoint": {
"Address": "string",
"Port": number,
"URL": "string"
},
"NodeCreateTime": number,
"NodeId": "string",
"NodeStatus": "string",
"ParameterGroupStatus": "string"
}
],
"NodeType": "string",
"NotificationConfiguration": {
"TopicArn": "string",
"TopicStatus": "string"
},
"ParameterGroup": {
"NodeIdsToReboot": [ "string" ],
"ParameterApplyStatus": "string",
"ParameterGroupName": "string"
},
"PreferredMaintenanceWindow": "string",
"SecurityGroups": [
{
"SecurityGroupIdentifier": "string",
"Status": "string"
}
],
"SSEDescription": {
"Status": "string"
},
"Status": "string",
"SubnetGroup": "string",
"TotalNodes": number
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [Cluster](#API_dax_CreateCluster_ResponseSyntax) **
A description of the DAX cluster that you have created.
Type: [Cluster](API_dax_Cluster.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** ClusterAlreadyExistsFault **
You already have a DAX cluster with the given identifier.
HTTP Status Code: 400
** ClusterQuotaForCustomerExceededFault **
You have attempted to exceed the maximum number of DAX clusters for your AWS account.
HTTP Status Code: 400
** InsufficientClusterCapacityFault **
There are not enough system resources to create the cluster you requested (or to resize an already-existing cluster).
HTTP Status Code: 400
** InvalidClusterStateFault **
The requested DAX cluster is not in the *available* state.
HTTP Status Code: 400
** InvalidParameterCombinationException **
Two or more incompatible parameters were specified.
HTTP Status Code: 400
** InvalidParameterGroupStateFault **
One or more parameters in a parameter group are in an invalid state.
HTTP Status Code: 400
** InvalidParameterValueException **
The value for a parameter is invalid.
HTTP Status Code: 400
** InvalidVPCNetworkStateFault **
The VPC network is in an invalid state.
HTTP Status Code: 400
** NodeQuotaForClusterExceededFault **
You have attempted to exceed the maximum number of nodes for a DAX cluster.
HTTP Status Code: 400
** NodeQuotaForCustomerExceededFault **
You have attempted to exceed the maximum number of nodes for your AWS account.
HTTP Status Code: 400
** ParameterGroupNotFoundFault **
The specified parameter group does not exist.
HTTP Status Code: 400
** ServiceLinkedRoleNotFoundFault **
The specified service linked role (SLR) was not found.
HTTP Status Code: 400
** ServiceQuotaExceededException **
You have reached the maximum number of x509 certificates that can be created for encrypted clusters in a 30 day period. Contact AWS customer support to discuss options for continuing to create encrypted clusters.
HTTP Status Code: 400
** SubnetGroupNotFoundFault **
The requested subnet group name does not refer to an existing subnet group.
HTTP Status Code: 400
** TagQuotaPerResourceExceeded **
You have exceeded the maximum number of tags for this DAX cluster.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/dax-2017-04-19/CreateCluster)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/dax-2017-04-19/CreateCluster)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dax-2017-04-19/CreateCluster)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/dax-2017-04-19/CreateCluster)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dax-2017-04-19/CreateCluster)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/dax-2017-04-19/CreateCluster)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/dax-2017-04-19/CreateCluster)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/dax-2017-04-19/CreateCluster)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/dax-2017-04-19/CreateCluster)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dax-2017-04-19/CreateCluster)
# CreateParameterGroup
Creates a new parameter group. A parameter group is a collection of parameters that you apply to all of the nodes in a DAX cluster.
## Request Syntax
```
{
"Description": "string",
"ParameterGroupName": "string"
}
```
## Request Parameters
The request accepts the following data in JSON format.
**Note**
In the following list, the required parameters are described first.
** [ParameterGroupName](#API_dax_CreateParameterGroup_RequestSyntax) **
The name of the parameter group to apply to all of the clusters in this replication group.
Type: String
Required: Yes
** [Description](#API_dax_CreateParameterGroup_RequestSyntax) **
A description of the parameter group.
Type: String
Required: No
## Response Syntax
```
{
"ParameterGroup": {
"Description": "string",
"ParameterGroupName": "string"
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [ParameterGroup](#API_dax_CreateParameterGroup_ResponseSyntax) **
Represents the output of a *CreateParameterGroup* action.
Type: [ParameterGroup](API_dax_ParameterGroup.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InvalidParameterCombinationException **
Two or more incompatible parameters were specified.
HTTP Status Code: 400
** InvalidParameterGroupStateFault **
One or more parameters in a parameter group are in an invalid state.
HTTP Status Code: 400
** InvalidParameterValueException **
The value for a parameter is invalid.
HTTP Status Code: 400
** ParameterGroupAlreadyExistsFault **
The specified parameter group already exists.
HTTP Status Code: 400
** ParameterGroupQuotaExceededFault **
You have attempted to exceed the maximum number of parameter groups.
HTTP Status Code: 400
** ServiceLinkedRoleNotFoundFault **
The specified service linked role (SLR) was not found.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/dax-2017-04-19/CreateParameterGroup)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/dax-2017-04-19/CreateParameterGroup)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dax-2017-04-19/CreateParameterGroup)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/dax-2017-04-19/CreateParameterGroup)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dax-2017-04-19/CreateParameterGroup)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/dax-2017-04-19/CreateParameterGroup)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/dax-2017-04-19/CreateParameterGroup)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/dax-2017-04-19/CreateParameterGroup)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/dax-2017-04-19/CreateParameterGroup)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dax-2017-04-19/CreateParameterGroup)
# CreateSubnetGroup
Creates a new subnet group.
## Request Syntax
```
{
"Description": "string",
"SubnetGroupName": "string",
"SubnetIds": [ "string" ]
}
```
## Request Parameters
The request accepts the following data in JSON format.
**Note**
In the following list, the required parameters are described first.
** [SubnetGroupName](#API_dax_CreateSubnetGroup_RequestSyntax) **
A name for the subnet group. This value is stored as a lowercase string.
Type: String
Required: Yes
** [SubnetIds](#API_dax_CreateSubnetGroup_RequestSyntax) **
A list of VPC subnet IDs for the subnet group.
Type: Array of strings
Required: Yes
** [Description](#API_dax_CreateSubnetGroup_RequestSyntax) **
A description for the subnet group
Type: String
Required: No
## Response Syntax
```
{
"SubnetGroup": {
"Description": "string",
"SubnetGroupName": "string",
"Subnets": [
{
"SubnetAvailabilityZone": "string",
"SubnetIdentifier": "string",
"SupportedNetworkTypes": [ "string" ]
}
],
"SupportedNetworkTypes": [ "string" ],
"VpcId": "string"
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [SubnetGroup](#API_dax_CreateSubnetGroup_ResponseSyntax) **
Represents the output of a *CreateSubnetGroup* operation.
Type: [SubnetGroup](API_dax_SubnetGroup.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InvalidSubnet **
An invalid subnet identifier was specified.
HTTP Status Code: 400
** ServiceLinkedRoleNotFoundFault **
The specified service linked role (SLR) was not found.
HTTP Status Code: 400
** SubnetGroupAlreadyExistsFault **
The specified subnet group already exists.
HTTP Status Code: 400
** SubnetGroupQuotaExceededFault **
The request cannot be processed because it would exceed the allowed number of subnets in a subnet group.
HTTP Status Code: 400
** SubnetNotAllowedFault **
The specified subnet can't be used for the requested network type. This error occurs when either there aren't enough subnets of the required network type to create the cluster, or when you try to use a subnet that doesn't support the requested network type (for example, trying to create a dual-stack cluster with a subnet that doesn't have IPv6 CIDR).
HTTP Status Code: 400
** SubnetQuotaExceededFault **
The request cannot be processed because it would exceed the allowed number of subnets in a subnet group.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/dax-2017-04-19/CreateSubnetGroup)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/dax-2017-04-19/CreateSubnetGroup)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dax-2017-04-19/CreateSubnetGroup)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/dax-2017-04-19/CreateSubnetGroup)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dax-2017-04-19/CreateSubnetGroup)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/dax-2017-04-19/CreateSubnetGroup)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/dax-2017-04-19/CreateSubnetGroup)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/dax-2017-04-19/CreateSubnetGroup)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/dax-2017-04-19/CreateSubnetGroup)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dax-2017-04-19/CreateSubnetGroup)
# DecreaseReplicationFactor
Removes one or more nodes from a DAX cluster.
**Note**
You cannot use `DecreaseReplicationFactor` to remove the last node in a DAX cluster. If you need to do this, use `DeleteCluster` instead.
## Request Syntax
```
{
"AvailabilityZones": [ "string" ],
"ClusterName": "string",
"NewReplicationFactor": number,
"NodeIdsToRemove": [ "string" ]
}
```
## Request Parameters
The request accepts the following data in JSON format.
**Note**
In the following list, the required parameters are described first.
** [ClusterName](#API_dax_DecreaseReplicationFactor_RequestSyntax) **
The name of the DAX cluster from which you want to remove nodes.
Type: String
Required: Yes
** [NewReplicationFactor](#API_dax_DecreaseReplicationFactor_RequestSyntax) **
The new number of nodes for the DAX cluster.
Type: Integer
Required: Yes
** [AvailabilityZones](#API_dax_DecreaseReplicationFactor_RequestSyntax) **
The Availability Zone(s) from which to remove nodes.
Type: Array of strings
Required: No
** [NodeIdsToRemove](#API_dax_DecreaseReplicationFactor_RequestSyntax) **
The unique identifiers of the nodes to be removed from the cluster.
Type: Array of strings
Required: No
## Response Syntax
```
{
"Cluster": {
"ActiveNodes": number,
"ClusterArn": "string",
"ClusterDiscoveryEndpoint": {
"Address": "string",
"Port": number,
"URL": "string"
},
"ClusterEndpointEncryptionType": "string",
"ClusterName": "string",
"Description": "string",
"IamRoleArn": "string",
"NetworkType": "string",
"NodeIdsToRemove": [ "string" ],
"Nodes": [
{
"AvailabilityZone": "string",
"Endpoint": {
"Address": "string",
"Port": number,
"URL": "string"
},
"NodeCreateTime": number,
"NodeId": "string",
"NodeStatus": "string",
"ParameterGroupStatus": "string"
}
],
"NodeType": "string",
"NotificationConfiguration": {
"TopicArn": "string",
"TopicStatus": "string"
},
"ParameterGroup": {
"NodeIdsToReboot": [ "string" ],
"ParameterApplyStatus": "string",
"ParameterGroupName": "string"
},
"PreferredMaintenanceWindow": "string",
"SecurityGroups": [
{
"SecurityGroupIdentifier": "string",
"Status": "string"
}
],
"SSEDescription": {
"Status": "string"
},
"Status": "string",
"SubnetGroup": "string",
"TotalNodes": number
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [Cluster](#API_dax_DecreaseReplicationFactor_ResponseSyntax) **
A description of the DAX cluster, after you have decreased its replication factor.
Type: [Cluster](API_dax_Cluster.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** ClusterNotFoundFault **
The requested cluster ID does not refer to an existing DAX cluster.
HTTP Status Code: 400
** InvalidClusterStateFault **
The requested DAX cluster is not in the *available* state.
HTTP Status Code: 400
** InvalidParameterCombinationException **
Two or more incompatible parameters were specified.
HTTP Status Code: 400
** InvalidParameterValueException **
The value for a parameter is invalid.
HTTP Status Code: 400
** NodeNotFoundFault **
None of the nodes in the cluster have the given node ID.
HTTP Status Code: 400
** ServiceLinkedRoleNotFoundFault **
The specified service linked role (SLR) was not found.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/dax-2017-04-19/DecreaseReplicationFactor)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/dax-2017-04-19/DecreaseReplicationFactor)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dax-2017-04-19/DecreaseReplicationFactor)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/dax-2017-04-19/DecreaseReplicationFactor)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dax-2017-04-19/DecreaseReplicationFactor)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/dax-2017-04-19/DecreaseReplicationFactor)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/dax-2017-04-19/DecreaseReplicationFactor)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/dax-2017-04-19/DecreaseReplicationFactor)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/dax-2017-04-19/DecreaseReplicationFactor)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dax-2017-04-19/DecreaseReplicationFactor)
# DeleteCluster
Deletes a previously provisioned DAX cluster. *DeleteCluster* deletes all associated nodes, node endpoints and the DAX cluster itself. When you receive a successful response from this action, DAX immediately begins deleting the cluster; you cannot cancel or revert this action.
## Request Syntax
```
{
"ClusterName": "string"
}
```
## Request Parameters
The request accepts the following data in JSON format.
**Note**
In the following list, the required parameters are described first.
** [ClusterName](#API_dax_DeleteCluster_RequestSyntax) **
The name of the cluster to be deleted.
Type: String
Required: Yes
## Response Syntax
```
{
"Cluster": {
"ActiveNodes": number,
"ClusterArn": "string",
"ClusterDiscoveryEndpoint": {
"Address": "string",
"Port": number,
"URL": "string"
},
"ClusterEndpointEncryptionType": "string",
"ClusterName": "string",
"Description": "string",
"IamRoleArn": "string",
"NetworkType": "string",
"NodeIdsToRemove": [ "string" ],
"Nodes": [
{
"AvailabilityZone": "string",
"Endpoint": {
"Address": "string",
"Port": number,
"URL": "string"
},
"NodeCreateTime": number,
"NodeId": "string",
"NodeStatus": "string",
"ParameterGroupStatus": "string"
}
],
"NodeType": "string",
"NotificationConfiguration": {
"TopicArn": "string",
"TopicStatus": "string"
},
"ParameterGroup": {
"NodeIdsToReboot": [ "string" ],
"ParameterApplyStatus": "string",
"ParameterGroupName": "string"
},
"PreferredMaintenanceWindow": "string",
"SecurityGroups": [
{
"SecurityGroupIdentifier": "string",
"Status": "string"
}
],
"SSEDescription": {
"Status": "string"
},
"Status": "string",
"SubnetGroup": "string",
"TotalNodes": number
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [Cluster](#API_dax_DeleteCluster_ResponseSyntax) **
A description of the DAX cluster that is being deleted.
Type: [Cluster](API_dax_Cluster.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** ClusterNotFoundFault **
The requested cluster ID does not refer to an existing DAX cluster.
HTTP Status Code: 400
** InvalidClusterStateFault **
The requested DAX cluster is not in the *available* state.
HTTP Status Code: 400
** InvalidParameterCombinationException **
Two or more incompatible parameters were specified.
HTTP Status Code: 400
** InvalidParameterValueException **
The value for a parameter is invalid.
HTTP Status Code: 400
** ServiceLinkedRoleNotFoundFault **
The specified service linked role (SLR) was not found.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/dax-2017-04-19/DeleteCluster)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/dax-2017-04-19/DeleteCluster)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dax-2017-04-19/DeleteCluster)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/dax-2017-04-19/DeleteCluster)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dax-2017-04-19/DeleteCluster)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/dax-2017-04-19/DeleteCluster)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/dax-2017-04-19/DeleteCluster)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/dax-2017-04-19/DeleteCluster)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/dax-2017-04-19/DeleteCluster)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dax-2017-04-19/DeleteCluster)
# DeleteParameterGroup
Deletes the specified parameter group. You cannot delete a parameter group if it is associated with any DAX clusters.
## Request Syntax
```
{
"ParameterGroupName": "string"
}
```
## Request Parameters
The request accepts the following data in JSON format.
**Note**
In the following list, the required parameters are described first.
** [ParameterGroupName](#API_dax_DeleteParameterGroup_RequestSyntax) **
The name of the parameter group to delete.
Type: String
Required: Yes
## Response Syntax
```
{
"DeletionMessage": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [DeletionMessage](#API_dax_DeleteParameterGroup_ResponseSyntax) **
A user-specified message for this action (i.e., a reason for deleting the parameter group).
Type: String
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InvalidParameterCombinationException **
Two or more incompatible parameters were specified.
HTTP Status Code: 400
** InvalidParameterGroupStateFault **
One or more parameters in a parameter group are in an invalid state.
HTTP Status Code: 400
** InvalidParameterValueException **
The value for a parameter is invalid.
HTTP Status Code: 400
** ParameterGroupNotFoundFault **
The specified parameter group does not exist.
HTTP Status Code: 400
** ServiceLinkedRoleNotFoundFault **
The specified service linked role (SLR) was not found.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/dax-2017-04-19/DeleteParameterGroup)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/dax-2017-04-19/DeleteParameterGroup)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dax-2017-04-19/DeleteParameterGroup)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/dax-2017-04-19/DeleteParameterGroup)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dax-2017-04-19/DeleteParameterGroup)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/dax-2017-04-19/DeleteParameterGroup)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/dax-2017-04-19/DeleteParameterGroup)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/dax-2017-04-19/DeleteParameterGroup)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/dax-2017-04-19/DeleteParameterGroup)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dax-2017-04-19/DeleteParameterGroup)
# DeleteSubnetGroup
Deletes a subnet group.
**Note**
You cannot delete a subnet group if it is associated with any DAX clusters.
## Request Syntax
```
{
"SubnetGroupName": "string"
}
```
## Request Parameters
The request accepts the following data in JSON format.
**Note**
In the following list, the required parameters are described first.
** [SubnetGroupName](#API_dax_DeleteSubnetGroup_RequestSyntax) **
The name of the subnet group to delete.
Type: String
Required: Yes
## Response Syntax
```
{
"DeletionMessage": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [DeletionMessage](#API_dax_DeleteSubnetGroup_ResponseSyntax) **
A user-specified message for this action (i.e., a reason for deleting the subnet group).
Type: String
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** ServiceLinkedRoleNotFoundFault **
The specified service linked role (SLR) was not found.
HTTP Status Code: 400
** SubnetGroupInUseFault **
The specified subnet group is currently in use.
HTTP Status Code: 400
** SubnetGroupNotFoundFault **
The requested subnet group name does not refer to an existing subnet group.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/dax-2017-04-19/DeleteSubnetGroup)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/dax-2017-04-19/DeleteSubnetGroup)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dax-2017-04-19/DeleteSubnetGroup)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/dax-2017-04-19/DeleteSubnetGroup)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dax-2017-04-19/DeleteSubnetGroup)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/dax-2017-04-19/DeleteSubnetGroup)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/dax-2017-04-19/DeleteSubnetGroup)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/dax-2017-04-19/DeleteSubnetGroup)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/dax-2017-04-19/DeleteSubnetGroup)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dax-2017-04-19/DeleteSubnetGroup)
# DescribeClusters
Returns information about all provisioned DAX clusters if no cluster identifier is specified, or about a specific DAX cluster if a cluster identifier is supplied.
If the cluster is in the CREATING state, only cluster level information will be displayed until all of the nodes are successfully provisioned.
If the cluster is in the DELETING state, only cluster level information will be displayed.
If nodes are currently being added to the DAX cluster, node endpoint information and creation time for the additional nodes will not be displayed until they are completely provisioned. When the DAX cluster state is *available*, the cluster is ready for use.
If nodes are currently being removed from the DAX cluster, no endpoint information for the removed nodes is displayed.
## Request Syntax
```
{
"ClusterNames": [ "string" ],
"MaxResults": number,
"NextToken": "string"
}
```
## Request Parameters
The request accepts the following data in JSON format.
**Note**
In the following list, the required parameters are described first.
** [ClusterNames](#API_dax_DescribeClusters_RequestSyntax) **
The names of the DAX clusters being described.
Type: Array of strings
Required: No
** [MaxResults](#API_dax_DescribeClusters_RequestSyntax) **
The maximum number of results to include in the response. If more results exist than the specified `MaxResults` value, a token is included in the response so that the remaining results can be retrieved.
The value for `MaxResults` must be between 20 and 100.
Type: Integer
Required: No
** [NextToken](#API_dax_DescribeClusters_RequestSyntax) **
An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by `MaxResults`.
Type: String
Required: No
## Response Syntax
```
{
"Clusters": [
{
"ActiveNodes": number,
"ClusterArn": "string",
"ClusterDiscoveryEndpoint": {
"Address": "string",
"Port": number,
"URL": "string"
},
"ClusterEndpointEncryptionType": "string",
"ClusterName": "string",
"Description": "string",
"IamRoleArn": "string",
"NetworkType": "string",
"NodeIdsToRemove": [ "string" ],
"Nodes": [
{
"AvailabilityZone": "string",
"Endpoint": {
"Address": "string",
"Port": number,
"URL": "string"
},
"NodeCreateTime": number,
"NodeId": "string",
"NodeStatus": "string",
"ParameterGroupStatus": "string"
}
],
"NodeType": "string",
"NotificationConfiguration": {
"TopicArn": "string",
"TopicStatus": "string"
},
"ParameterGroup": {
"NodeIdsToReboot": [ "string" ],
"ParameterApplyStatus": "string",
"ParameterGroupName": "string"
},
"PreferredMaintenanceWindow": "string",
"SecurityGroups": [
{
"SecurityGroupIdentifier": "string",
"Status": "string"
}
],
"SSEDescription": {
"Status": "string"
},
"Status": "string",
"SubnetGroup": "string",
"TotalNodes": number
}
],
"NextToken": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [Clusters](#API_dax_DescribeClusters_ResponseSyntax) **
The descriptions of your DAX clusters, in response to a *DescribeClusters* request.
Type: Array of [Cluster](API_dax_Cluster.md) objects
** [NextToken](#API_dax_DescribeClusters_ResponseSyntax) **
Provides an identifier to allow retrieval of paginated results.
Type: String
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** ClusterNotFoundFault **
The requested cluster ID does not refer to an existing DAX cluster.
HTTP Status Code: 400
** InvalidParameterCombinationException **
Two or more incompatible parameters were specified.
HTTP Status Code: 400
** InvalidParameterValueException **
The value for a parameter is invalid.
HTTP Status Code: 400
** ServiceLinkedRoleNotFoundFault **
The specified service linked role (SLR) was not found.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/dax-2017-04-19/DescribeClusters)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/dax-2017-04-19/DescribeClusters)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dax-2017-04-19/DescribeClusters)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/dax-2017-04-19/DescribeClusters)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dax-2017-04-19/DescribeClusters)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/dax-2017-04-19/DescribeClusters)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/dax-2017-04-19/DescribeClusters)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/dax-2017-04-19/DescribeClusters)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/dax-2017-04-19/DescribeClusters)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dax-2017-04-19/DescribeClusters)
# DescribeDefaultParameters
Returns the default system parameter information for the DAX caching software.
## Request Syntax
```
{
"MaxResults": number,
"NextToken": "string"
}
```
## Request Parameters
The request accepts the following data in JSON format.
**Note**
In the following list, the required parameters are described first.
** [MaxResults](#API_dax_DescribeDefaultParameters_RequestSyntax) **
The maximum number of results to include in the response. If more results exist than the specified `MaxResults` value, a token is included in the response so that the remaining results can be retrieved.
The value for `MaxResults` must be between 20 and 100.
Type: Integer
Required: No
** [NextToken](#API_dax_DescribeDefaultParameters_RequestSyntax) **
An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by `MaxResults`.
Type: String
Required: No
## Response Syntax
```
{
"NextToken": "string",
"Parameters": [
{
"AllowedValues": "string",
"ChangeType": "string",
"DataType": "string",
"Description": "string",
"IsModifiable": "string",
"NodeTypeSpecificValues": [
{
"NodeType": "string",
"Value": "string"
}
],
"ParameterName": "string",
"ParameterType": "string",
"ParameterValue": "string",
"Source": "string"
}
]
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [NextToken](#API_dax_DescribeDefaultParameters_ResponseSyntax) **
Provides an identifier to allow retrieval of paginated results.
Type: String
** [Parameters](#API_dax_DescribeDefaultParameters_ResponseSyntax) **
A list of parameters. Each element in the list represents one parameter.
Type: Array of [Parameter](API_dax_Parameter.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InvalidParameterCombinationException **
Two or more incompatible parameters were specified.
HTTP Status Code: 400
** InvalidParameterValueException **
The value for a parameter is invalid.
HTTP Status Code: 400
** ServiceLinkedRoleNotFoundFault **
The specified service linked role (SLR) was not found.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/dax-2017-04-19/DescribeDefaultParameters)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/dax-2017-04-19/DescribeDefaultParameters)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dax-2017-04-19/DescribeDefaultParameters)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/dax-2017-04-19/DescribeDefaultParameters)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dax-2017-04-19/DescribeDefaultParameters)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/dax-2017-04-19/DescribeDefaultParameters)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/dax-2017-04-19/DescribeDefaultParameters)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/dax-2017-04-19/DescribeDefaultParameters)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/dax-2017-04-19/DescribeDefaultParameters)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dax-2017-04-19/DescribeDefaultParameters)
# DescribeEvents
Returns events related to DAX clusters and parameter groups. You can obtain events specific to a particular DAX cluster or parameter group by providing the name as a parameter.
By default, only the events occurring within the last 24 hours are returned; however, you can retrieve up to 14 days' worth of events if necessary.
## Request Syntax
```
{
"Duration": number,
"EndTime": number,
"MaxResults": number,
"NextToken": "string",
"SourceName": "string",
"SourceType": "string",
"StartTime": number
}
```
## Request Parameters
The request accepts the following data in JSON format.
**Note**
In the following list, the required parameters are described first.
** [Duration](#API_dax_DescribeEvents_RequestSyntax) **
The number of minutes' worth of events to retrieve.
Type: Integer
Required: No
** [EndTime](#API_dax_DescribeEvents_RequestSyntax) **
The end of the time interval for which to retrieve events, specified in ISO 8601 format.
Type: Timestamp
Required: No
** [MaxResults](#API_dax_DescribeEvents_RequestSyntax) **
The maximum number of results to include in the response. If more results exist than the specified `MaxResults` value, a token is included in the response so that the remaining results can be retrieved.
The value for `MaxResults` must be between 20 and 100.
Type: Integer
Required: No
** [NextToken](#API_dax_DescribeEvents_RequestSyntax) **
An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by `MaxResults`.
Type: String
Required: No
** [SourceName](#API_dax_DescribeEvents_RequestSyntax) **
The identifier of the event source for which events will be returned. If not specified, then all sources are included in the response.
Type: String
Required: No
** [SourceType](#API_dax_DescribeEvents_RequestSyntax) **
The event source to retrieve events for. If no value is specified, all events are returned.
Type: String
Valid Values: `CLUSTER | PARAMETER_GROUP | SUBNET_GROUP`
Required: No
** [StartTime](#API_dax_DescribeEvents_RequestSyntax) **
The beginning of the time interval to retrieve events for, specified in ISO 8601 format.
Type: Timestamp
Required: No
## Response Syntax
```
{
"Events": [
{
"Date": number,
"Message": "string",
"SourceName": "string",
"SourceType": "string"
}
],
"NextToken": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [Events](#API_dax_DescribeEvents_ResponseSyntax) **
An array of events. Each element in the array represents one event.
Type: Array of [Event](API_dax_Event.md) objects
** [NextToken](#API_dax_DescribeEvents_ResponseSyntax) **
Provides an identifier to allow retrieval of paginated results.
Type: String
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InvalidParameterCombinationException **
Two or more incompatible parameters were specified.
HTTP Status Code: 400
** InvalidParameterValueException **
The value for a parameter is invalid.
HTTP Status Code: 400
** ServiceLinkedRoleNotFoundFault **
The specified service linked role (SLR) was not found.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/dax-2017-04-19/DescribeEvents)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/dax-2017-04-19/DescribeEvents)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dax-2017-04-19/DescribeEvents)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/dax-2017-04-19/DescribeEvents)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dax-2017-04-19/DescribeEvents)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/dax-2017-04-19/DescribeEvents)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/dax-2017-04-19/DescribeEvents)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/dax-2017-04-19/DescribeEvents)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/dax-2017-04-19/DescribeEvents)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dax-2017-04-19/DescribeEvents)
# DescribeParameterGroups
Returns a list of parameter group descriptions. If a parameter group name is specified, the list will contain only the descriptions for that group.
## Request Syntax
```
{
"MaxResults": number,
"NextToken": "string",
"ParameterGroupNames": [ "string" ]
}
```
## Request Parameters
The request accepts the following data in JSON format.
**Note**
In the following list, the required parameters are described first.
** [MaxResults](#API_dax_DescribeParameterGroups_RequestSyntax) **
The maximum number of results to include in the response. If more results exist than the specified `MaxResults` value, a token is included in the response so that the remaining results can be retrieved.
The value for `MaxResults` must be between 20 and 100.
Type: Integer
Required: No
** [NextToken](#API_dax_DescribeParameterGroups_RequestSyntax) **
An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by `MaxResults`.
Type: String
Required: No
** [ParameterGroupNames](#API_dax_DescribeParameterGroups_RequestSyntax) **
The names of the parameter groups.
Type: Array of strings
Required: No
## Response Syntax
```
{
"NextToken": "string",
"ParameterGroups": [
{
"Description": "string",
"ParameterGroupName": "string"
}
]
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [NextToken](#API_dax_DescribeParameterGroups_ResponseSyntax) **
Provides an identifier to allow retrieval of paginated results.
Type: String
** [ParameterGroups](#API_dax_DescribeParameterGroups_ResponseSyntax) **
An array of parameter groups. Each element in the array represents one parameter group.
Type: Array of [ParameterGroup](API_dax_ParameterGroup.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InvalidParameterCombinationException **
Two or more incompatible parameters were specified.
HTTP Status Code: 400
** InvalidParameterValueException **
The value for a parameter is invalid.
HTTP Status Code: 400
** ParameterGroupNotFoundFault **
The specified parameter group does not exist.
HTTP Status Code: 400
** ServiceLinkedRoleNotFoundFault **
The specified service linked role (SLR) was not found.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/dax-2017-04-19/DescribeParameterGroups)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/dax-2017-04-19/DescribeParameterGroups)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dax-2017-04-19/DescribeParameterGroups)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/dax-2017-04-19/DescribeParameterGroups)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dax-2017-04-19/DescribeParameterGroups)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/dax-2017-04-19/DescribeParameterGroups)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/dax-2017-04-19/DescribeParameterGroups)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/dax-2017-04-19/DescribeParameterGroups)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/dax-2017-04-19/DescribeParameterGroups)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dax-2017-04-19/DescribeParameterGroups)
# DescribeParameters
Returns the detailed parameter list for a particular parameter group.
## Request Syntax
```
{
"MaxResults": number,
"NextToken": "string",
"ParameterGroupName": "string",
"Source": "string"
}
```
## Request Parameters
The request accepts the following data in JSON format.
**Note**
In the following list, the required parameters are described first.
** [ParameterGroupName](#API_dax_DescribeParameters_RequestSyntax) **
The name of the parameter group.
Type: String
Required: Yes
** [MaxResults](#API_dax_DescribeParameters_RequestSyntax) **
The maximum number of results to include in the response. If more results exist than the specified `MaxResults` value, a token is included in the response so that the remaining results can be retrieved.
The value for `MaxResults` must be between 20 and 100.
Type: Integer
Required: No
** [NextToken](#API_dax_DescribeParameters_RequestSyntax) **
An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by `MaxResults`.
Type: String
Required: No
** [Source](#API_dax_DescribeParameters_RequestSyntax) **
How the parameter is defined. For example, `system` denotes a system-defined parameter.
Type: String
Required: No
## Response Syntax
```
{
"NextToken": "string",
"Parameters": [
{
"AllowedValues": "string",
"ChangeType": "string",
"DataType": "string",
"Description": "string",
"IsModifiable": "string",
"NodeTypeSpecificValues": [
{
"NodeType": "string",
"Value": "string"
}
],
"ParameterName": "string",
"ParameterType": "string",
"ParameterValue": "string",
"Source": "string"
}
]
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [NextToken](#API_dax_DescribeParameters_ResponseSyntax) **
Provides an identifier to allow retrieval of paginated results.
Type: String
** [Parameters](#API_dax_DescribeParameters_ResponseSyntax) **
A list of parameters within a parameter group. Each element in the list represents one parameter.
Type: Array of [Parameter](API_dax_Parameter.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InvalidParameterCombinationException **
Two or more incompatible parameters were specified.
HTTP Status Code: 400
** InvalidParameterValueException **
The value for a parameter is invalid.
HTTP Status Code: 400
** ParameterGroupNotFoundFault **
The specified parameter group does not exist.
HTTP Status Code: 400
** ServiceLinkedRoleNotFoundFault **
The specified service linked role (SLR) was not found.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/dax-2017-04-19/DescribeParameters)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/dax-2017-04-19/DescribeParameters)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dax-2017-04-19/DescribeParameters)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/dax-2017-04-19/DescribeParameters)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dax-2017-04-19/DescribeParameters)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/dax-2017-04-19/DescribeParameters)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/dax-2017-04-19/DescribeParameters)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/dax-2017-04-19/DescribeParameters)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/dax-2017-04-19/DescribeParameters)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dax-2017-04-19/DescribeParameters)
# DescribeSubnetGroups
Returns a list of subnet group descriptions. If a subnet group name is specified, the list will contain only the description of that group.
## Request Syntax
```
{
"MaxResults": number,
"NextToken": "string",
"SubnetGroupNames": [ "string" ]
}
```
## Request Parameters
The request accepts the following data in JSON format.
**Note**
In the following list, the required parameters are described first.
** [MaxResults](#API_dax_DescribeSubnetGroups_RequestSyntax) **
The maximum number of results to include in the response. If more results exist than the specified `MaxResults` value, a token is included in the response so that the remaining results can be retrieved.
The value for `MaxResults` must be between 20 and 100.
Type: Integer
Required: No
** [NextToken](#API_dax_DescribeSubnetGroups_RequestSyntax) **
An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by `MaxResults`.
Type: String
Required: No
** [SubnetGroupNames](#API_dax_DescribeSubnetGroups_RequestSyntax) **
The name of the subnet group.
Type: Array of strings
Required: No
## Response Syntax
```
{
"NextToken": "string",
"SubnetGroups": [
{
"Description": "string",
"SubnetGroupName": "string",
"Subnets": [
{
"SubnetAvailabilityZone": "string",
"SubnetIdentifier": "string",
"SupportedNetworkTypes": [ "string" ]
}
],
"SupportedNetworkTypes": [ "string" ],
"VpcId": "string"
}
]
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [NextToken](#API_dax_DescribeSubnetGroups_ResponseSyntax) **
Provides an identifier to allow retrieval of paginated results.
Type: String
** [SubnetGroups](#API_dax_DescribeSubnetGroups_ResponseSyntax) **
An array of subnet groups. Each element in the array represents a single subnet group.
Type: Array of [SubnetGroup](API_dax_SubnetGroup.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** ServiceLinkedRoleNotFoundFault **
The specified service linked role (SLR) was not found.
HTTP Status Code: 400
** SubnetGroupNotFoundFault **
The requested subnet group name does not refer to an existing subnet group.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/dax-2017-04-19/DescribeSubnetGroups)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/dax-2017-04-19/DescribeSubnetGroups)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dax-2017-04-19/DescribeSubnetGroups)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/dax-2017-04-19/DescribeSubnetGroups)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dax-2017-04-19/DescribeSubnetGroups)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/dax-2017-04-19/DescribeSubnetGroups)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/dax-2017-04-19/DescribeSubnetGroups)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/dax-2017-04-19/DescribeSubnetGroups)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/dax-2017-04-19/DescribeSubnetGroups)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dax-2017-04-19/DescribeSubnetGroups)
# IncreaseReplicationFactor
Adds one or more nodes to a DAX cluster.
## Request Syntax
```
{
"AvailabilityZones": [ "string" ],
"ClusterName": "string",
"NewReplicationFactor": number
}
```
## Request Parameters
The request accepts the following data in JSON format.
**Note**
In the following list, the required parameters are described first.
** [ClusterName](#API_dax_IncreaseReplicationFactor_RequestSyntax) **
The name of the DAX cluster that will receive additional nodes.
Type: String
Required: Yes
** [NewReplicationFactor](#API_dax_IncreaseReplicationFactor_RequestSyntax) **
The new number of nodes for the DAX cluster.
Type: Integer
Required: Yes
** [AvailabilityZones](#API_dax_IncreaseReplicationFactor_RequestSyntax) **
The Availability Zones (AZs) in which the cluster nodes will be created. All nodes belonging to the cluster are placed in these Availability Zones. Use this parameter if you want to distribute the nodes across multiple AZs.
Type: Array of strings
Required: No
## Response Syntax
```
{
"Cluster": {
"ActiveNodes": number,
"ClusterArn": "string",
"ClusterDiscoveryEndpoint": {
"Address": "string",
"Port": number,
"URL": "string"
},
"ClusterEndpointEncryptionType": "string",
"ClusterName": "string",
"Description": "string",
"IamRoleArn": "string",
"NetworkType": "string",
"NodeIdsToRemove": [ "string" ],
"Nodes": [
{
"AvailabilityZone": "string",
"Endpoint": {
"Address": "string",
"Port": number,
"URL": "string"
},
"NodeCreateTime": number,
"NodeId": "string",
"NodeStatus": "string",
"ParameterGroupStatus": "string"
}
],
"NodeType": "string",
"NotificationConfiguration": {
"TopicArn": "string",
"TopicStatus": "string"
},
"ParameterGroup": {
"NodeIdsToReboot": [ "string" ],
"ParameterApplyStatus": "string",
"ParameterGroupName": "string"
},
"PreferredMaintenanceWindow": "string",
"SecurityGroups": [
{
"SecurityGroupIdentifier": "string",
"Status": "string"
}
],
"SSEDescription": {
"Status": "string"
},
"Status": "string",
"SubnetGroup": "string",
"TotalNodes": number
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [Cluster](#API_dax_IncreaseReplicationFactor_ResponseSyntax) **
A description of the DAX cluster, with its new replication factor.
Type: [Cluster](API_dax_Cluster.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** ClusterNotFoundFault **
The requested cluster ID does not refer to an existing DAX cluster.
HTTP Status Code: 400
** InsufficientClusterCapacityFault **
There are not enough system resources to create the cluster you requested (or to resize an already-existing cluster).
HTTP Status Code: 400
** InvalidClusterStateFault **
The requested DAX cluster is not in the *available* state.
HTTP Status Code: 400
** InvalidParameterCombinationException **
Two or more incompatible parameters were specified.
HTTP Status Code: 400
** InvalidParameterValueException **
The value for a parameter is invalid.
HTTP Status Code: 400
** InvalidVPCNetworkStateFault **
The VPC network is in an invalid state.
HTTP Status Code: 400
** NodeQuotaForClusterExceededFault **
You have attempted to exceed the maximum number of nodes for a DAX cluster.
HTTP Status Code: 400
** NodeQuotaForCustomerExceededFault **
You have attempted to exceed the maximum number of nodes for your AWS account.
HTTP Status Code: 400
** ServiceLinkedRoleNotFoundFault **
The specified service linked role (SLR) was not found.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/dax-2017-04-19/IncreaseReplicationFactor)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/dax-2017-04-19/IncreaseReplicationFactor)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dax-2017-04-19/IncreaseReplicationFactor)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/dax-2017-04-19/IncreaseReplicationFactor)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dax-2017-04-19/IncreaseReplicationFactor)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/dax-2017-04-19/IncreaseReplicationFactor)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/dax-2017-04-19/IncreaseReplicationFactor)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/dax-2017-04-19/IncreaseReplicationFactor)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/dax-2017-04-19/IncreaseReplicationFactor)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dax-2017-04-19/IncreaseReplicationFactor)
# ListTags
List all of the tags for a DAX cluster. You can call `ListTags` up to 10 times per second, per account.
## Request Syntax
```
{
"NextToken": "string",
"ResourceName": "string"
}
```
## Request Parameters
The request accepts the following data in JSON format.
**Note**
In the following list, the required parameters are described first.
** [ResourceName](#API_dax_ListTags_RequestSyntax) **
The name of the DAX resource to which the tags belong.
Type: String
Required: Yes
** [NextToken](#API_dax_ListTags_RequestSyntax) **
An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token.
Type: String
Required: No
## Response Syntax
```
{
"NextToken": "string",
"Tags": [
{
"Key": "string",
"Value": "string"
}
]
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [NextToken](#API_dax_ListTags_ResponseSyntax) **
If this value is present, there are additional results to be displayed. To retrieve them, call `ListTags` again, with `NextToken` set to this value.
Type: String
** [Tags](#API_dax_ListTags_ResponseSyntax) **
A list of tags currently associated with the DAX cluster.
Type: Array of [Tag](API_dax_Tag.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** ClusterNotFoundFault **
The requested cluster ID does not refer to an existing DAX cluster.
HTTP Status Code: 400
** InvalidARNFault **
The Amazon Resource Name (ARN) supplied in the request is not valid.
HTTP Status Code: 400
** InvalidClusterStateFault **
The requested DAX cluster is not in the *available* state.
HTTP Status Code: 400
** InvalidParameterCombinationException **
Two or more incompatible parameters were specified.
HTTP Status Code: 400
** InvalidParameterValueException **
The value for a parameter is invalid.
HTTP Status Code: 400
** ServiceLinkedRoleNotFoundFault **
The specified service linked role (SLR) was not found.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/dax-2017-04-19/ListTags)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/dax-2017-04-19/ListTags)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dax-2017-04-19/ListTags)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/dax-2017-04-19/ListTags)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dax-2017-04-19/ListTags)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/dax-2017-04-19/ListTags)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/dax-2017-04-19/ListTags)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/dax-2017-04-19/ListTags)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/dax-2017-04-19/ListTags)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dax-2017-04-19/ListTags)
# RebootNode
Reboots a single node of a DAX cluster. The reboot action takes place as soon as possible. During the reboot, the node status is set to REBOOTING.
**Note**
`RebootNode` restarts the DAX engine process and does not remove the contents of the cache.
## Request Syntax
```
{
"ClusterName": "string",
"NodeId": "string"
}
```
## Request Parameters
The request accepts the following data in JSON format.
**Note**
In the following list, the required parameters are described first.
** [ClusterName](#API_dax_RebootNode_RequestSyntax) **
The name of the DAX cluster containing the node to be rebooted.
Type: String
Required: Yes
** [NodeId](#API_dax_RebootNode_RequestSyntax) **
The system-assigned ID of the node to be rebooted.
Type: String
Required: Yes
## Response Syntax
```
{
"Cluster": {
"ActiveNodes": number,
"ClusterArn": "string",
"ClusterDiscoveryEndpoint": {
"Address": "string",
"Port": number,
"URL": "string"
},
"ClusterEndpointEncryptionType": "string",
"ClusterName": "string",
"Description": "string",
"IamRoleArn": "string",
"NetworkType": "string",
"NodeIdsToRemove": [ "string" ],
"Nodes": [
{
"AvailabilityZone": "string",
"Endpoint": {
"Address": "string",
"Port": number,
"URL": "string"
},
"NodeCreateTime": number,
"NodeId": "string",
"NodeStatus": "string",
"ParameterGroupStatus": "string"
}
],
"NodeType": "string",
"NotificationConfiguration": {
"TopicArn": "string",
"TopicStatus": "string"
},
"ParameterGroup": {
"NodeIdsToReboot": [ "string" ],
"ParameterApplyStatus": "string",
"ParameterGroupName": "string"
},
"PreferredMaintenanceWindow": "string",
"SecurityGroups": [
{
"SecurityGroupIdentifier": "string",
"Status": "string"
}
],
"SSEDescription": {
"Status": "string"
},
"Status": "string",
"SubnetGroup": "string",
"TotalNodes": number
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [Cluster](#API_dax_RebootNode_ResponseSyntax) **
A description of the DAX cluster after a node has been rebooted.
Type: [Cluster](API_dax_Cluster.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** ClusterNotFoundFault **
The requested cluster ID does not refer to an existing DAX cluster.
HTTP Status Code: 400
** InvalidClusterStateFault **
The requested DAX cluster is not in the *available* state.
HTTP Status Code: 400
** InvalidParameterCombinationException **
Two or more incompatible parameters were specified.
HTTP Status Code: 400
** InvalidParameterValueException **
The value for a parameter is invalid.
HTTP Status Code: 400
** NodeNotFoundFault **
None of the nodes in the cluster have the given node ID.
HTTP Status Code: 400
** ServiceLinkedRoleNotFoundFault **
The specified service linked role (SLR) was not found.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/dax-2017-04-19/RebootNode)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/dax-2017-04-19/RebootNode)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dax-2017-04-19/RebootNode)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/dax-2017-04-19/RebootNode)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dax-2017-04-19/RebootNode)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/dax-2017-04-19/RebootNode)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/dax-2017-04-19/RebootNode)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/dax-2017-04-19/RebootNode)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/dax-2017-04-19/RebootNode)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dax-2017-04-19/RebootNode)
# TagResource
Associates a set of tags with a DAX resource. You can call `TagResource` up to 5 times per second, per account.
## Request Syntax
```
{
"ResourceName": "string",
"Tags": [
{
"Key": "string",
"Value": "string"
}
]
}
```
## Request Parameters
The request accepts the following data in JSON format.
**Note**
In the following list, the required parameters are described first.
** [ResourceName](#API_dax_TagResource_RequestSyntax) **
The name of the DAX resource to which tags should be added.
Type: String
Required: Yes
** [Tags](#API_dax_TagResource_RequestSyntax) **
The tags to be assigned to the DAX resource.
Type: Array of [Tag](API_dax_Tag.md) objects
Required: Yes
## Response Syntax
```
{
"Tags": [
{
"Key": "string",
"Value": "string"
}
]
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [Tags](#API_dax_TagResource_ResponseSyntax) **
The list of tags that are associated with the DAX resource.
Type: Array of [Tag](API_dax_Tag.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** ClusterNotFoundFault **
The requested cluster ID does not refer to an existing DAX cluster.
HTTP Status Code: 400
** InvalidARNFault **
The Amazon Resource Name (ARN) supplied in the request is not valid.
HTTP Status Code: 400
** InvalidClusterStateFault **
The requested DAX cluster is not in the *available* state.
HTTP Status Code: 400
** InvalidParameterCombinationException **
Two or more incompatible parameters were specified.
HTTP Status Code: 400
** InvalidParameterValueException **
The value for a parameter is invalid.
HTTP Status Code: 400
** ServiceLinkedRoleNotFoundFault **
The specified service linked role (SLR) was not found.
HTTP Status Code: 400
** TagQuotaPerResourceExceeded **
You have exceeded the maximum number of tags for this DAX cluster.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/dax-2017-04-19/TagResource)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/dax-2017-04-19/TagResource)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dax-2017-04-19/TagResource)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/dax-2017-04-19/TagResource)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dax-2017-04-19/TagResource)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/dax-2017-04-19/TagResource)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/dax-2017-04-19/TagResource)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/dax-2017-04-19/TagResource)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/dax-2017-04-19/TagResource)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dax-2017-04-19/TagResource)
# UntagResource
Removes the association of tags from a DAX resource. You can call `UntagResource` up to 5 times per second, per account.
## Request Syntax
```
{
"ResourceName": "string",
"TagKeys": [ "string" ]
}
```
## Request Parameters
The request accepts the following data in JSON format.
**Note**
In the following list, the required parameters are described first.
** [ResourceName](#API_dax_UntagResource_RequestSyntax) **
The name of the DAX resource from which the tags should be removed.
Type: String
Required: Yes
** [TagKeys](#API_dax_UntagResource_RequestSyntax) **
A list of tag keys. If the DAX cluster has any tags with these keys, then the tags are removed from the cluster.
Type: Array of strings
Required: Yes
## Response Syntax
```
{
"Tags": [
{
"Key": "string",
"Value": "string"
}
]
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [Tags](#API_dax_UntagResource_ResponseSyntax) **
The tag keys that have been removed from the cluster.
Type: Array of [Tag](API_dax_Tag.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** ClusterNotFoundFault **
The requested cluster ID does not refer to an existing DAX cluster.
HTTP Status Code: 400
** InvalidARNFault **
The Amazon Resource Name (ARN) supplied in the request is not valid.
HTTP Status Code: 400
** InvalidClusterStateFault **
The requested DAX cluster is not in the *available* state.
HTTP Status Code: 400
** InvalidParameterCombinationException **
Two or more incompatible parameters were specified.
HTTP Status Code: 400
** InvalidParameterValueException **
The value for a parameter is invalid.
HTTP Status Code: 400
** ServiceLinkedRoleNotFoundFault **
The specified service linked role (SLR) was not found.
HTTP Status Code: 400
** TagNotFoundFault **
The tag does not exist.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/dax-2017-04-19/UntagResource)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/dax-2017-04-19/UntagResource)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dax-2017-04-19/UntagResource)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/dax-2017-04-19/UntagResource)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dax-2017-04-19/UntagResource)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/dax-2017-04-19/UntagResource)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/dax-2017-04-19/UntagResource)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/dax-2017-04-19/UntagResource)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/dax-2017-04-19/UntagResource)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dax-2017-04-19/UntagResource)
# UpdateCluster
Modifies the settings for a DAX cluster. You can use this action to change one or more cluster configuration parameters by specifying the parameters and the new values.
## Request Syntax
```
{
"ClusterName": "string",
"Description": "string",
"NotificationTopicArn": "string",
"NotificationTopicStatus": "string",
"ParameterGroupName": "string",
"PreferredMaintenanceWindow": "string",
"SecurityGroupIds": [ "string" ]
}
```
## Request Parameters
The request accepts the following data in JSON format.
**Note**
In the following list, the required parameters are described first.
** [ClusterName](#API_dax_UpdateCluster_RequestSyntax) **
The name of the DAX cluster to be modified.
Type: String
Required: Yes
** [Description](#API_dax_UpdateCluster_RequestSyntax) **
A description of the changes being made to the cluster.
Type: String
Required: No
** [NotificationTopicArn](#API_dax_UpdateCluster_RequestSyntax) **
The Amazon Resource Name (ARN) that identifies the topic.
Type: String
Required: No
** [NotificationTopicStatus](#API_dax_UpdateCluster_RequestSyntax) **
The current state of the topic. A value of “active” means that notifications will be sent to the topic. A value of “inactive” means that notifications will not be sent to the topic.
Type: String
Required: No
** [ParameterGroupName](#API_dax_UpdateCluster_RequestSyntax) **
The name of a parameter group for this cluster.
Type: String
Required: No
** [PreferredMaintenanceWindow](#API_dax_UpdateCluster_RequestSyntax) **
A range of time when maintenance of DAX cluster software will be performed. For example: `sun:01:00-sun:09:00`. Cluster maintenance normally takes less than 30 minutes, and is performed automatically within the maintenance window.
Type: String
Required: No
** [SecurityGroupIds](#API_dax_UpdateCluster_RequestSyntax) **
A list of user-specified security group IDs to be assigned to each node in the DAX cluster. If this parameter is not specified, DAX assigns the default VPC security group to each node.
Type: Array of strings
Required: No
## Response Syntax
```
{
"Cluster": {
"ActiveNodes": number,
"ClusterArn": "string",
"ClusterDiscoveryEndpoint": {
"Address": "string",
"Port": number,
"URL": "string"
},
"ClusterEndpointEncryptionType": "string",
"ClusterName": "string",
"Description": "string",
"IamRoleArn": "string",
"NetworkType": "string",
"NodeIdsToRemove": [ "string" ],
"Nodes": [
{
"AvailabilityZone": "string",
"Endpoint": {
"Address": "string",
"Port": number,
"URL": "string"
},
"NodeCreateTime": number,
"NodeId": "string",
"NodeStatus": "string",
"ParameterGroupStatus": "string"
}
],
"NodeType": "string",
"NotificationConfiguration": {
"TopicArn": "string",
"TopicStatus": "string"
},
"ParameterGroup": {
"NodeIdsToReboot": [ "string" ],
"ParameterApplyStatus": "string",
"ParameterGroupName": "string"
},
"PreferredMaintenanceWindow": "string",
"SecurityGroups": [
{
"SecurityGroupIdentifier": "string",
"Status": "string"
}
],
"SSEDescription": {
"Status": "string"
},
"Status": "string",
"SubnetGroup": "string",
"TotalNodes": number
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [Cluster](#API_dax_UpdateCluster_ResponseSyntax) **
A description of the DAX cluster, after it has been modified.
Type: [Cluster](API_dax_Cluster.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** ClusterNotFoundFault **
The requested cluster ID does not refer to an existing DAX cluster.
HTTP Status Code: 400
** InvalidClusterStateFault **
The requested DAX cluster is not in the *available* state.
HTTP Status Code: 400
** InvalidParameterCombinationException **
Two or more incompatible parameters were specified.
HTTP Status Code: 400
** InvalidParameterGroupStateFault **
One or more parameters in a parameter group are in an invalid state.
HTTP Status Code: 400
** InvalidParameterValueException **
The value for a parameter is invalid.
HTTP Status Code: 400
** ParameterGroupNotFoundFault **
The specified parameter group does not exist.
HTTP Status Code: 400
** ServiceLinkedRoleNotFoundFault **
The specified service linked role (SLR) was not found.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/dax-2017-04-19/UpdateCluster)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/dax-2017-04-19/UpdateCluster)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dax-2017-04-19/UpdateCluster)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/dax-2017-04-19/UpdateCluster)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dax-2017-04-19/UpdateCluster)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/dax-2017-04-19/UpdateCluster)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/dax-2017-04-19/UpdateCluster)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/dax-2017-04-19/UpdateCluster)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/dax-2017-04-19/UpdateCluster)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dax-2017-04-19/UpdateCluster)
# UpdateParameterGroup
Modifies the parameters of a parameter group. You can modify up to 20 parameters in a single request by submitting a list parameter name and value pairs.
## Request Syntax
```
{
"ParameterGroupName": "string",
"ParameterNameValues": [
{
"ParameterName": "string",
"ParameterValue": "string"
}
]
}
```
## Request Parameters
The request accepts the following data in JSON format.
**Note**
In the following list, the required parameters are described first.
** [ParameterGroupName](#API_dax_UpdateParameterGroup_RequestSyntax) **
The name of the parameter group.
Type: String
Required: Yes
** [ParameterNameValues](#API_dax_UpdateParameterGroup_RequestSyntax) **
An array of name-value pairs for the parameters in the group. Each element in the array represents a single parameter.
`record-ttl-millis` and `query-ttl-millis` are the only supported parameter names. For more details, see [Configuring TTL Settings](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DAX.cluster-management.html#DAX.cluster-management.custom-settings.ttl).
Type: Array of [ParameterNameValue](API_dax_ParameterNameValue.md) objects
Required: Yes
## Response Syntax
```
{
"ParameterGroup": {
"Description": "string",
"ParameterGroupName": "string"
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [ParameterGroup](#API_dax_UpdateParameterGroup_ResponseSyntax) **
The parameter group that has been modified.
Type: [ParameterGroup](API_dax_ParameterGroup.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InvalidParameterCombinationException **
Two or more incompatible parameters were specified.
HTTP Status Code: 400
** InvalidParameterGroupStateFault **
One or more parameters in a parameter group are in an invalid state.
HTTP Status Code: 400
** InvalidParameterValueException **
The value for a parameter is invalid.
HTTP Status Code: 400
** ParameterGroupNotFoundFault **
The specified parameter group does not exist.
HTTP Status Code: 400
** ServiceLinkedRoleNotFoundFault **
The specified service linked role (SLR) was not found.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/dax-2017-04-19/UpdateParameterGroup)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/dax-2017-04-19/UpdateParameterGroup)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dax-2017-04-19/UpdateParameterGroup)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/dax-2017-04-19/UpdateParameterGroup)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dax-2017-04-19/UpdateParameterGroup)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/dax-2017-04-19/UpdateParameterGroup)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/dax-2017-04-19/UpdateParameterGroup)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/dax-2017-04-19/UpdateParameterGroup)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/dax-2017-04-19/UpdateParameterGroup)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dax-2017-04-19/UpdateParameterGroup)
# UpdateSubnetGroup
Modifies an existing subnet group.
## Request Syntax
```
{
"Description": "string",
"SubnetGroupName": "string",
"SubnetIds": [ "string" ]
}
```
## Request Parameters
The request accepts the following data in JSON format.
**Note**
In the following list, the required parameters are described first.
** [SubnetGroupName](#API_dax_UpdateSubnetGroup_RequestSyntax) **
The name of the subnet group.
Type: String
Required: Yes
** [Description](#API_dax_UpdateSubnetGroup_RequestSyntax) **
A description of the subnet group.
Type: String
Required: No
** [SubnetIds](#API_dax_UpdateSubnetGroup_RequestSyntax) **
A list of subnet IDs in the subnet group.
Type: Array of strings
Required: No
## Response Syntax
```
{
"SubnetGroup": {
"Description": "string",
"SubnetGroupName": "string",
"Subnets": [
{
"SubnetAvailabilityZone": "string",
"SubnetIdentifier": "string",
"SupportedNetworkTypes": [ "string" ]
}
],
"SupportedNetworkTypes": [ "string" ],
"VpcId": "string"
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [SubnetGroup](#API_dax_UpdateSubnetGroup_ResponseSyntax) **
The subnet group that has been modified.
Type: [SubnetGroup](API_dax_SubnetGroup.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InvalidSubnet **
An invalid subnet identifier was specified.
HTTP Status Code: 400
** ServiceLinkedRoleNotFoundFault **
The specified service linked role (SLR) was not found.
HTTP Status Code: 400
** SubnetGroupNotFoundFault **
The requested subnet group name does not refer to an existing subnet group.
HTTP Status Code: 400
** SubnetInUse **
The requested subnet is being used by another subnet group.
HTTP Status Code: 400
** SubnetNotAllowedFault **
The specified subnet can't be used for the requested network type. This error occurs when either there aren't enough subnets of the required network type to create the cluster, or when you try to use a subnet that doesn't support the requested network type (for example, trying to create a dual-stack cluster with a subnet that doesn't have IPv6 CIDR).
HTTP Status Code: 400
** SubnetQuotaExceededFault **
The request cannot be processed because it would exceed the allowed number of subnets in a subnet group.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/dax-2017-04-19/UpdateSubnetGroup)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/dax-2017-04-19/UpdateSubnetGroup)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dax-2017-04-19/UpdateSubnetGroup)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/dax-2017-04-19/UpdateSubnetGroup)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dax-2017-04-19/UpdateSubnetGroup)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/dax-2017-04-19/UpdateSubnetGroup)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/dax-2017-04-19/UpdateSubnetGroup)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/dax-2017-04-19/UpdateSubnetGroup)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/dax-2017-04-19/UpdateSubnetGroup)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dax-2017-04-19/UpdateSubnetGroup)
# Amazon DynamoDB Streams
The following actions are supported by Amazon DynamoDB Streams:
+ [DescribeStream](API_streams_DescribeStream.md)
+ [GetRecords](API_streams_GetRecords.md)
+ [GetShardIterator](API_streams_GetShardIterator.md)
+ [ListStreams](API_streams_ListStreams.md)
# DescribeStream
Returns information about a stream, including the current status of the stream, its Amazon Resource Name (ARN), the composition of its shards, and its corresponding DynamoDB table.
**Note**
You can call `DescribeStream` at a maximum rate of 10 times per second.
Each shard in the stream has a `SequenceNumberRange` associated with it. If the `SequenceNumberRange` has a `StartingSequenceNumber` but no `EndingSequenceNumber`, then the shard is still open (able to receive more stream records). If both `StartingSequenceNumber` and `EndingSequenceNumber` are present, then that shard is closed and can no longer receive more data.
## Request Syntax
```
{
"ExclusiveStartShardId": "string",
"Limit": number,
"ShardFilter": {
"ShardId": "string",
"Type": "string"
},
"StreamArn": "string"
}
```
## Request Parameters
The request accepts the following data in JSON format.
**Note**
In the following list, the required parameters are described first.
** [StreamArn](#API_streams_DescribeStream_RequestSyntax) **
The Amazon Resource Name (ARN) for the stream.
Type: String
Length Constraints: Minimum length of 37. Maximum length of 1024.
Required: Yes
** [ExclusiveStartShardId](#API_streams_DescribeStream_RequestSyntax) **
The shard ID of the first item that this operation will evaluate. Use the value that was returned for `LastEvaluatedShardId` in the previous operation.
Type: String
Length Constraints: Minimum length of 28. Maximum length of 65.
Required: No
** [Limit](#API_streams_DescribeStream_RequestSyntax) **
The maximum number of shard objects to return. The upper limit is 100.
Type: Integer
Valid Range: Minimum value of 1.
Required: No
** [ShardFilter](#API_streams_DescribeStream_RequestSyntax) **
This optional field contains the filter definition for the `DescribeStream` API.
Type: [ShardFilter](API_streams_ShardFilter.md) object
Required: No
## Response Syntax
```
{
"StreamDescription": {
"CreationRequestDateTime": number,
"KeySchema": [
{
"AttributeName": "string",
"KeyType": "string"
}
],
"LastEvaluatedShardId": "string",
"Shards": [
{
"ParentShardId": "string",
"SequenceNumberRange": {
"EndingSequenceNumber": "string",
"StartingSequenceNumber": "string"
},
"ShardId": "string"
}
],
"StreamArn": "string",
"StreamLabel": "string",
"StreamStatus": "string",
"StreamViewType": "string",
"TableName": "string"
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [StreamDescription](#API_streams_DescribeStream_ResponseSyntax) **
A complete description of the stream, including its creation date and time, the DynamoDB table associated with the stream, the shard IDs within the stream, and the beginning and ending sequence numbers of stream records within the shards.
Type: [StreamDescription](API_streams_StreamDescription.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** InternalServerError **
An error occurred on the server side.
** message **
The server encountered an internal error trying to fulfill the request.
HTTP Status Code: 500
** ResourceNotFoundException **
The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be `ACTIVE`.
** message **
The resource which is being requested does not exist.
HTTP Status Code: 400
## Examples
### Describe A Stream
The following sample returns a description of a stream with a given stream ARN. All of the shards in the stream are listed in the response, along with the beginning and ending sequence numbers of stream records within the shards. Note that one of the shards is still open, because it does not have an `EndingSequenceNumber`.
#### Sample Request
```
POST / HTTP/1.1
x-amzn-RequestId:
x-amzn-crc32: