This page describes the parameters and results for the operations of the Amazon DynamoDB (2012-08-10), and shows how to use the Aws\DynamoDb\DynamoDbClient object to call the described operations. This documentation is specific to the 2012-08-10 API version of the service.
Operation SummaryEach of the following operations can be created from a client using $client->getCommand('CommandName'), where "CommandName" is the name of one of the following operations. Note: a command is a value that encapsulates an operation and the parameters used to create an HTTP request.
You can also create and send a command immediately using the magic methods available on a client object: $client->commandName(/* parameters */). You can send the command asynchronously (returning a promise) by appending the word "Async" to the operation name: $client->commandNameAsync(/* parameters */).
Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:
Waiters allow you to poll a resource until it enters into a desired state. A waiter has a name used to describe what it does, and is associated with an API operation. When creating a waiter, you can provide the API operation parameters associated with the corresponding operation. Waiters can be accessed using the getWaiter($waiterName, $operationParameters) method of a client object. This client supports the following waiters:
Operations BatchExecuteStatement$result = $client->batchExecuteStatement([/* ... */]); $promise = $client->batchExecuteStatementAsync([/* ... */]);
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 .
The entire batch must consist of either read statements or write statements, you cannot mix both in one batch.
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 field of the BatchStatementResponse for each statement.
$result = $client->batchExecuteStatement([
'ReturnConsumedCapacity' => 'INDEXES|TOTAL|NONE',
'Statements' => [ // REQUIRED
[
'ConsistentRead' => true || false,
'Parameters' => [
[
'B' => <string || resource || Psr\Http\Message\StreamInterface>,
'BOOL' => true || false,
'BS' => [<string || resource || Psr\Http\Message\StreamInterface>, ...],
'L' => [
[...], // RECURSIVE
// ...
],
'M' => [
'<AttributeName>' => [...], // RECURSIVE
// ...
],
'N' => '<string>',
'NS' => ['<string>', ...],
'NULL' => true || false,
'S' => '<string>',
'SS' => ['<string>', ...],
],
// ...
],
'ReturnValuesOnConditionCheckFailure' => 'ALL_OLD|NONE',
'Statement' => '<string>', // REQUIRED
],
// ...
],
]);
Parameter Details Members
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.
The list of PartiQL statements representing the batch to run.
[
'ConsumedCapacity' => [
[
'CapacityUnits' => <float>,
'GlobalSecondaryIndexes' => [
'<IndexName>' => [
'CapacityUnits' => <float>,
'ReadCapacityUnits' => <float>,
'WriteCapacityUnits' => <float>,
],
// ...
],
'LocalSecondaryIndexes' => [
'<IndexName>' => [
'CapacityUnits' => <float>,
'ReadCapacityUnits' => <float>,
'WriteCapacityUnits' => <float>,
],
// ...
],
'ReadCapacityUnits' => <float>,
'Table' => [
'CapacityUnits' => <float>,
'ReadCapacityUnits' => <float>,
'WriteCapacityUnits' => <float>,
],
'TableName' => '<string>',
'WriteCapacityUnits' => <float>,
],
// ...
],
'Responses' => [
[
'Error' => [
'Code' => 'ConditionalCheckFailed|ItemCollectionSizeLimitExceeded|RequestLimitExceeded|ValidationError|ProvisionedThroughputExceeded|TransactionConflict|ThrottlingError|InternalServerError|ResourceNotFound|AccessDenied|DuplicateItem',
'Item' => [
'<AttributeName>' => [
'B' => <string || resource || Psr\Http\Message\StreamInterface>,
'BOOL' => true || false,
'BS' => [<string || resource || Psr\Http\Message\StreamInterface>, ...],
'L' => [
[...], // RECURSIVE
// ...
],
'M' => [
'<AttributeName>' => [...], // RECURSIVE
// ...
],
'N' => '<string>',
'NS' => ['<string>', ...],
'NULL' => true || false,
'S' => '<string>',
'SS' => ['<string>', ...],
],
// ...
],
'Message' => '<string>',
],
'Item' => [
'<AttributeName>' => [
'B' => <string || resource || Psr\Http\Message\StreamInterface>,
'BOOL' => true || false,
'BS' => [<string || resource || Psr\Http\Message\StreamInterface>, ...],
'L' => [
[...], // RECURSIVE
// ...
],
'M' => [
'<AttributeName>' => [...], // RECURSIVE
// ...
],
'N' => '<string>',
'NS' => ['<string>', ...],
'NULL' => true || false,
'S' => '<string>',
'SS' => ['<string>', ...],
],
// ...
],
'TableName' => '<string>',
],
// ...
],
]Result Details Members
The capacity units consumed by the entire operation. The values of the list are ordered according to the ordering of the statements.
The response to each PartiQL statement in the batch. The values of the list are ordered according to the ordering of the request statements.
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 field in the returned exception. Contact Amazon Web ServicesSupport to request a quota increase.
An error occurred on the server side.
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 field in the returned exception.
$result = $client->batchGetItem([/* ... */]); $promise = $client->batchGetItemAsync([/* ... */]);
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.
If you request more than 100 items, BatchGetItem returns a ValidationException with the message "Too many items requested for the BatchGetItem call."
For example, if you ask to retrieve 100 items, but each individual item is 300 KB in size, the system returns 52 items (so as not to exceed the 16 MB limit). It also returns an appropriate UnprocessedKeys value so you can get the next page of results. If desired, your application can include its own logic to assemble the pages of results into one dataset.
If none of the items can be processed due to insufficient provisioned throughput on all of the tables in the request, then BatchGetItem returns a ProvisionedThroughputExceededException. If at least one of the items is successfully processed, then BatchGetItem completes successfully, while returning the keys of the unread items in UnprocessedKeys.
If DynamoDB returns any unprocessed items, you should retry the batch operation on those items. However, we strongly recommend that you use an exponential backoff algorithm. If you retry the batch operation immediately, the underlying read or write requests can still fail due to throttling on the individual tables. If you delay the batch operation using exponential backoff, the individual requests in the batch are much more likely to succeed.
For more information, see Batch Operations and Error Handling in the Amazon DynamoDB Developer Guide.
By default, BatchGetItem performs eventually consistent reads on every table in the request. If you want strongly consistent reads instead, you can set ConsistentRead to true for any or all tables.
In order to minimize response latency, BatchGetItem 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 in the Amazon DynamoDB Developer Guide.
BatchGetItem will result in a ValidationException if the same key is specified multiple times.
$result = $client->batchGetItem([
'RequestItems' => [ // REQUIRED
'<TableArn>' => [
'AttributesToGet' => ['<string>', ...],
'ConsistentRead' => true || false,
'ExpressionAttributeNames' => ['<string>', ...],
'Keys' => [ // REQUIRED
[
'<AttributeName>' => [
'B' => <string || resource || Psr\Http\Message\StreamInterface>,
'BOOL' => true || false,
'BS' => [<string || resource || Psr\Http\Message\StreamInterface>, ...],
'L' => [
[...], // RECURSIVE
// ...
],
'M' => [
'<AttributeName>' => [...], // RECURSIVE
// ...
],
'N' => '<string>',
'NS' => ['<string>', ...],
'NULL' => true || false,
'S' => '<string>',
'SS' => ['<string>', ...],
],
// ...
],
// ...
],
'ProjectionExpression' => '<string>',
],
// ...
],
'ReturnConsumedCapacity' => 'INDEXES|TOTAL|NONE',
]);
Parameter Details Members
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 # 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 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 Accessing Item Attributes 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 in the Amazon DynamoDB Developer Guide.
AttributesToGet - This is a legacy parameter. Use ProjectionExpression instead. For more information, see AttributesToGet in the Amazon DynamoDB Developer Guide.
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.
[
'ConsumedCapacity' => [
[
'CapacityUnits' => <float>,
'GlobalSecondaryIndexes' => [
'<IndexName>' => [
'CapacityUnits' => <float>,
'ReadCapacityUnits' => <float>,
'WriteCapacityUnits' => <float>,
],
// ...
],
'LocalSecondaryIndexes' => [
'<IndexName>' => [
'CapacityUnits' => <float>,
'ReadCapacityUnits' => <float>,
'WriteCapacityUnits' => <float>,
],
// ...
],
'ReadCapacityUnits' => <float>,
'Table' => [
'CapacityUnits' => <float>,
'ReadCapacityUnits' => <float>,
'WriteCapacityUnits' => <float>,
],
'TableName' => '<string>',
'WriteCapacityUnits' => <float>,
],
// ...
],
'Responses' => [
'<TableArn>' => [
[
'<AttributeName>' => [
'B' => <string || resource || Psr\Http\Message\StreamInterface>,
'BOOL' => true || false,
'BS' => [<string || resource || Psr\Http\Message\StreamInterface>, ...],
'L' => [
[...], // RECURSIVE
// ...
],
'M' => [
'<AttributeName>' => [...], // RECURSIVE
// ...
],
'N' => '<string>',
'NS' => ['<string>', ...],
'NULL' => true || false,
'S' => '<string>',
'SS' => ['<string>', ...],
],
// ...
],
// ...
],
// ...
],
'UnprocessedKeys' => [
'<TableArn>' => [
'AttributesToGet' => ['<string>', ...],
'ConsistentRead' => true || false,
'ExpressionAttributeNames' => ['<string>', ...],
'Keys' => [
[
'<AttributeName>' => [
'B' => <string || resource || Psr\Http\Message\StreamInterface>,
'BOOL' => true || false,
'BS' => [<string || resource || Psr\Http\Message\StreamInterface>, ...],
'L' => [
[...], // RECURSIVE
// ...
],
'M' => [
'<AttributeName>' => [...], // RECURSIVE
// ...
],
'N' => '<string>',
'NS' => ['<string>', ...],
'NULL' => true || false,
'S' => '<string>',
'SS' => ['<string>', ...],
],
// ...
],
// ...
],
'ProjectionExpression' => '<string>',
],
// ...
],
]Result Details Members
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.
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.
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.
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 field in the returned exception. The Amazon Web Services 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 in the Amazon DynamoDB Developer Guide.
The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be ACTIVE.
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 field in the returned exception. Contact Amazon Web ServicesSupport to request a quota increase.
An error occurred on the server side.
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 field in the returned exception.
This example reads multiple items from the Music table using a batch of three GetItem requests. Only the AlbumTitle attribute is returned.
$result = $client->batchGetItem([
'RequestItems' => [
'Music' => [
'Keys' => [
[
'Artist' => [
'S' => 'No One You Know',
],
'SongTitle' => [
'S' => 'Call Me Today',
],
],
[
'Artist' => [
'S' => 'Acme Band',
],
'SongTitle' => [
'S' => 'Happy Day',
],
],
[
'Artist' => [
'S' => 'No One You Know',
],
'SongTitle' => [
'S' => 'Scared of My Shadow',
],
],
],
'ProjectionExpression' => 'AlbumTitle',
],
],
]);
Result syntax:
[
'Responses' => [
'Music' => [
[
'AlbumTitle' => [
'S' => 'Somewhat Famous',
],
],
[
'AlbumTitle' => [
'S' => 'Blue Sky Blues',
],
],
[
'AlbumTitle' => [
'S' => 'Louder Than Ever',
],
],
],
],
] BatchWriteItem
$result = $client->batchWriteItem([/* ... */]); $promise = $client->batchWriteItemAsync([/* ... */]);
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.
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.
If DynamoDB returns any unprocessed items, you should retry the batch operation on those items. However, we strongly recommend that you use an exponential backoff algorithm. If you retry the batch operation immediately, the underlying read or write requests can still fail due to throttling on the individual tables. If you delay the batch operation using exponential backoff, the individual requests in the batch are much more likely to succeed.
For more information, see Batch Operations and Error Handling in the Amazon DynamoDB Developer Guide.
With BatchWriteItem, you can efficiently write or delete large amounts of data, such as from Amazon EMR, or copy data from another database into DynamoDB. In order to improve performance with these large-scale operations, BatchWriteItem does not behave in the same way as individual PutItem and DeleteItem calls would. For example, you cannot specify conditions on individual put and delete requests, and BatchWriteItem does not return deleted items in the response.
If you use a programming language that supports concurrency, you can use threads to write items in parallel. Your application must include the necessary logic to manage the threads. With languages that don't support threading, you must update or delete the specified items one at a time. In both situations, BatchWriteItem performs the specified put and delete operations in parallel, giving you the power of the thread pool approach without having to introduce complexity into your application.
Parallel processing reduces latency, but each specified put and delete request consumes the same number of write capacity units whether it is processed in parallel or not. Delete operations on nonexistent items consume one write capacity unit.
If one or more of the following is true, DynamoDB rejects the entire batch write operation:
One or more tables specified in the 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.
$result = $client->batchWriteItem([
'RequestItems' => [ // REQUIRED
'<TableArn>' => [
[
'DeleteRequest' => [
'Key' => [ // REQUIRED
'<AttributeName>' => [
'B' => <string || resource || Psr\Http\Message\StreamInterface>,
'BOOL' => true || false,
'BS' => [<string || resource || Psr\Http\Message\StreamInterface>, ...],
'L' => [
[...], // RECURSIVE
// ...
],
'M' => [
'<AttributeName>' => [...], // RECURSIVE
// ...
],
'N' => '<string>',
'NS' => ['<string>', ...],
'NULL' => true || false,
'S' => '<string>',
'SS' => ['<string>', ...],
],
// ...
],
],
'PutRequest' => [
'Item' => [ // REQUIRED
'<AttributeName>' => [
'B' => <string || resource || Psr\Http\Message\StreamInterface>,
'BOOL' => true || false,
'BS' => [<string || resource || Psr\Http\Message\StreamInterface>, ...],
'L' => [
[...], // RECURSIVE
// ...
],
'M' => [
'<AttributeName>' => [...], // RECURSIVE
// ...
],
'N' => '<string>',
'NS' => ['<string>', ...],
'NULL' => true || false,
'S' => '<string>',
'SS' => ['<string>', ...],
],
// ...
],
],
],
// ...
],
// ...
],
'ReturnConsumedCapacity' => 'INDEXES|TOTAL|NONE',
'ReturnItemCollectionMetrics' => 'SIZE|NONE',
]);
Parameter Details Members
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.
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.
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.
[
'ConsumedCapacity' => [
[
'CapacityUnits' => <float>,
'GlobalSecondaryIndexes' => [
'<IndexName>' => [
'CapacityUnits' => <float>,
'ReadCapacityUnits' => <float>,
'WriteCapacityUnits' => <float>,
],
// ...
],
'LocalSecondaryIndexes' => [
'<IndexName>' => [
'CapacityUnits' => <float>,
'ReadCapacityUnits' => <float>,
'WriteCapacityUnits' => <float>,
],
// ...
],
'ReadCapacityUnits' => <float>,
'Table' => [
'CapacityUnits' => <float>,
'ReadCapacityUnits' => <float>,
'WriteCapacityUnits' => <float>,
],
'TableName' => '<string>',
'WriteCapacityUnits' => <float>,
],
// ...
],
'ItemCollectionMetrics' => [
'<TableArn>' => [
[
'ItemCollectionKey' => [
'<AttributeName>' => [
'B' => <string || resource || Psr\Http\Message\StreamInterface>,
'BOOL' => true || false,
'BS' => [<string || resource || Psr\Http\Message\StreamInterface>, ...],
'L' => [
[...], // RECURSIVE
// ...
],
'M' => [
'<AttributeName>' => [...], // RECURSIVE
// ...
],
'N' => '<string>',
'NS' => ['<string>', ...],
'NULL' => true || false,
'S' => '<string>',
'SS' => ['<string>', ...],
],
// ...
],
'SizeEstimateRangeGB' => [<float>, ...],
],
// ...
],
// ...
],
'UnprocessedItems' => [
'<TableArn>' => [
[
'DeleteRequest' => [
'Key' => [
'<AttributeName>' => [
'B' => <string || resource || Psr\Http\Message\StreamInterface>,
'BOOL' => true || false,
'BS' => [<string || resource || Psr\Http\Message\StreamInterface>, ...],
'L' => [
[...], // RECURSIVE
// ...
],
'M' => [
'<AttributeName>' => [...], // RECURSIVE
// ...
],
'N' => '<string>',
'NS' => ['<string>', ...],
'NULL' => true || false,
'S' => '<string>',
'SS' => ['<string>', ...],
],
// ...
],
],
'PutRequest' => [
'Item' => [
'<AttributeName>' => [
'B' => <string || resource || Psr\Http\Message\StreamInterface>,
'BOOL' => true || false,
'BS' => [<string || resource || Psr\Http\Message\StreamInterface>, ...],
'L' => [
[...], // RECURSIVE
// ...
],
'M' => [
'<AttributeName>' => [...], // RECURSIVE
// ...
],
'N' => '<string>',
'NS' => ['<string>', ...],
'NULL' => true || false,
'S' => '<string>',
'SS' => ['<string>', ...],
],
// ...
],
],
],
// ...
],
// ...
],
]Result Details Members
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.
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.
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.
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 field in the returned exception. The Amazon Web Services 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 in the Amazon DynamoDB Developer Guide.
The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be ACTIVE.
An item collection is too large. This exception is only returned for tables that have one or more local secondary indexes.
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 field in the returned exception. Contact Amazon Web ServicesSupport to request a quota increase.
An error occurred on the server side.
The request was rejected because one or more items in the request are being modified by a request in another Region.
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 field in the returned exception.
This example adds three new items to the Music table using a batch of three PutItem requests.
$result = $client->batchWriteItem([
'RequestItems' => [
'Music' => [
[
'PutRequest' => [
'Item' => [
'AlbumTitle' => [
'S' => 'Somewhat Famous',
],
'Artist' => [
'S' => 'No One You Know',
],
'SongTitle' => [
'S' => 'Call Me Today',
],
],
],
],
[
'PutRequest' => [
'Item' => [
'AlbumTitle' => [
'S' => 'Songs About Life',
],
'Artist' => [
'S' => 'Acme Band',
],
'SongTitle' => [
'S' => 'Happy Day',
],
],
],
],
[
'PutRequest' => [
'Item' => [
'AlbumTitle' => [
'S' => 'Blue Sky Blues',
],
'Artist' => [
'S' => 'No One You Know',
],
'SongTitle' => [
'S' => 'Scared of My Shadow',
],
],
],
],
],
],
]);
Result syntax:
[ ]CreateBackup
$result = $client->createBackup([/* ... */]); $promise = $client->createBackupAsync([/* ... */]);
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
$result = $client->createBackup([
'BackupName' => '<string>', // REQUIRED
'TableName' => '<string>', // REQUIRED
]);
Parameter Details Members
Specified name for the backup.
The name of the table. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.
[
'BackupDetails' => [
'BackupArn' => '<string>',
'BackupCreationDateTime' => <DateTime>,
'BackupExpiryDateTime' => <DateTime>,
'BackupName' => '<string>',
'BackupSizeBytes' => <integer>,
'BackupStatus' => 'CREATING|DELETED|AVAILABLE',
'BackupType' => 'USER|SYSTEM|AWS_BACKUP',
],
]Result Details Members
Contains the details of the backup created for the table.
A source table with the name TableName does not currently exist within the subscriber's account or the subscriber is operating in the wrong Amazon Web Services Region.
A target table with the specified name is either being created or deleted.
Backups have not yet been enabled for this table.
There is another ongoing conflicting backup control plane operation on the table. The backup is either being created, deleted or restored to a table.
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.
An error occurred on the server side.
$result = $client->createGlobalTable([/* ... */]); $promise = $client->createGlobalTableAsync([/* ... */]);
Creates a global table from an existing table. A global table creates a replication relationship between two or more DynamoDB tables with the same table name in the provided Regions.
This 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) 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. To update existing global tables from version 2017.11.29 (Legacy) to version 2019.11.21 (Current), see Upgrading global tables.
If you want to add a new replica table to a global table, each of the following conditions must be true:
The table must have the same primary key as all of the other replicas.
The table must have the same name as all of the other replicas.
The table must have DynamoDB Streams enabled, with the stream containing both the new and the old images of the item.
None of the replica tables in the global table can contain any data.
If global secondary indexes are specified, then the following conditions must also be met:
The global secondary indexes must have the same name.
The global secondary indexes must have the same hash key and sort key (if present).
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).
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.
Parameter Syntax$result = $client->createGlobalTable([
'GlobalTableName' => '<string>', // REQUIRED
'ReplicationGroup' => [ // REQUIRED
[
'RegionName' => '<string>',
],
// ...
],
]);
Parameter Details Members
The global table name.
The Regions where the global table needs to be created.
[
'GlobalTableDescription' => [
'CreationDateTime' => <DateTime>,
'GlobalTableArn' => '<string>',
'GlobalTableName' => '<string>',
'GlobalTableStatus' => 'CREATING|ACTIVE|DELETING|UPDATING',
'ReplicationGroup' => [
[
'GlobalSecondaryIndexes' => [
[
'IndexName' => '<string>',
'OnDemandThroughputOverride' => [
'MaxReadRequestUnits' => <integer>,
],
'ProvisionedThroughputOverride' => [
'ReadCapacityUnits' => <integer>,
],
'WarmThroughput' => [
'ReadUnitsPerSecond' => <integer>,
'Status' => 'CREATING|UPDATING|DELETING|ACTIVE',
'WriteUnitsPerSecond' => <integer>,
],
],
// ...
],
'KMSMasterKeyId' => '<string>',
'OnDemandThroughputOverride' => [
'MaxReadRequestUnits' => <integer>,
],
'ProvisionedThroughputOverride' => [
'ReadCapacityUnits' => <integer>,
],
'RegionName' => '<string>',
'ReplicaInaccessibleDateTime' => <DateTime>,
'ReplicaStatus' => 'CREATING|CREATION_FAILED|UPDATING|DELETING|ACTIVE|REGION_DISABLED|INACCESSIBLE_ENCRYPTION_CREDENTIALS|ARCHIVING|ARCHIVED|REPLICATION_NOT_AUTHORIZED',
'ReplicaStatusDescription' => '<string>',
'ReplicaStatusPercentProgress' => '<string>',
'ReplicaTableClassSummary' => [
'LastUpdateDateTime' => <DateTime>,
'TableClass' => 'STANDARD|STANDARD_INFREQUENT_ACCESS',
],
'WarmThroughput' => [
'ReadUnitsPerSecond' => <integer>,
'Status' => 'CREATING|UPDATING|DELETING|ACTIVE|INACCESSIBLE_ENCRYPTION_CREDENTIALS|ARCHIVING|ARCHIVED|REPLICATION_NOT_AUTHORIZED',
'WriteUnitsPerSecond' => <integer>,
],
],
// ...
],
],
]Result Details Members
Contains the details of the global table.
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.
An error occurred on the server side.
The specified global table already exists.
A source table with the name TableName does not currently exist within the subscriber's account or the subscriber is operating in the wrong Amazon Web Services Region.
$result = $client->createTable([/* ... */]); $promise = $client->createTableAsync([/* ... */]);
The CreateTable operation adds a new table to your account. In an Amazon Web Services 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.
$result = $client->createTable([
'AttributeDefinitions' => [ // REQUIRED
[
'AttributeName' => '<string>', // REQUIRED
'AttributeType' => 'S|N|B', // REQUIRED
],
// ...
],
'BillingMode' => 'PROVISIONED|PAY_PER_REQUEST',
'DeletionProtectionEnabled' => true || false,
'GlobalSecondaryIndexes' => [
[
'IndexName' => '<string>', // REQUIRED
'KeySchema' => [ // REQUIRED
[
'AttributeName' => '<string>', // REQUIRED
'KeyType' => 'HASH|RANGE', // REQUIRED
],
// ...
],
'OnDemandThroughput' => [
'MaxReadRequestUnits' => <integer>,
'MaxWriteRequestUnits' => <integer>,
],
'Projection' => [ // REQUIRED
'NonKeyAttributes' => ['<string>', ...],
'ProjectionType' => 'ALL|KEYS_ONLY|INCLUDE',
],
'ProvisionedThroughput' => [
'ReadCapacityUnits' => <integer>, // REQUIRED
'WriteCapacityUnits' => <integer>, // REQUIRED
],
'WarmThroughput' => [
'ReadUnitsPerSecond' => <integer>,
'WriteUnitsPerSecond' => <integer>,
],
],
// ...
],
'KeySchema' => [ // REQUIRED
[
'AttributeName' => '<string>', // REQUIRED
'KeyType' => 'HASH|RANGE', // REQUIRED
],
// ...
],
'LocalSecondaryIndexes' => [
[
'IndexName' => '<string>', // REQUIRED
'KeySchema' => [ // REQUIRED
[
'AttributeName' => '<string>', // REQUIRED
'KeyType' => 'HASH|RANGE', // REQUIRED
],
// ...
],
'Projection' => [ // REQUIRED
'NonKeyAttributes' => ['<string>', ...],
'ProjectionType' => 'ALL|KEYS_ONLY|INCLUDE',
],
],
// ...
],
'OnDemandThroughput' => [
'MaxReadRequestUnits' => <integer>,
'MaxWriteRequestUnits' => <integer>,
],
'ProvisionedThroughput' => [
'ReadCapacityUnits' => <integer>, // REQUIRED
'WriteCapacityUnits' => <integer>, // REQUIRED
],
'ResourcePolicy' => '<string>',
'SSESpecification' => [
'Enabled' => true || false,
'KMSMasterKeyId' => '<string>',
'SSEType' => 'AES256|KMS',
],
'StreamSpecification' => [
'StreamEnabled' => true || false, // REQUIRED
'StreamViewType' => 'NEW_IMAGE|OLD_IMAGE|NEW_AND_OLD_IMAGES|KEYS_ONLY',
],
'TableClass' => 'STANDARD|STANDARD_INFREQUENT_ACCESS',
'TableName' => '<string>', // REQUIRED
'Tags' => [
[
'Key' => '<string>', // REQUIRED
'Value' => '<string>', // REQUIRED
],
// ...
],
'WarmThroughput' => [
'ReadUnitsPerSecond' => <integer>,
'WriteUnitsPerSecond' => <integer>,
],
]);
Parameter Details Members
An array of attributes that describe the key schema for the table and indexes.
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.
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.
Indicates whether deletion protection is to be enabled (true) or disabled (false) on the table.
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.
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.
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 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 in the Amazon DynamoDB Developer Guide.
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.
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.
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 in the Amazon DynamoDB Developer Guide.
An Amazon Web Services 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.
You need to specify the CreateTable and PutResourcePolicy IAM actions for authorizing a user to create a table with a resource-based policy.
Represents the settings used to enable server-side encryption.
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.
The table class of the new table. Valid values are STANDARD and STANDARD_INFREQUENT_ACCESS.
The name of the table to create. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.
A list of key-value pairs to label the table. For more information, see Tagging for DynamoDB.
Represents the warm throughput (in read units per second and write units per second) for creating a table.
[
'TableDescription' => [
'ArchivalSummary' => [
'ArchivalBackupArn' => '<string>',
'ArchivalDateTime' => <DateTime>,
'ArchivalReason' => '<string>',
],
'AttributeDefinitions' => [
[
'AttributeName' => '<string>',
'AttributeType' => 'S|N|B',
],
// ...
],
'BillingModeSummary' => [
'BillingMode' => 'PROVISIONED|PAY_PER_REQUEST',
'LastUpdateToPayPerRequestDateTime' => <DateTime>,
],
'CreationDateTime' => <DateTime>,
'DeletionProtectionEnabled' => true || false,
'GlobalSecondaryIndexes' => [
[
'Backfilling' => true || false,
'IndexArn' => '<string>',
'IndexName' => '<string>',
'IndexSizeBytes' => <integer>,
'IndexStatus' => 'CREATING|UPDATING|DELETING|ACTIVE',
'ItemCount' => <integer>,
'KeySchema' => [
[
'AttributeName' => '<string>',
'KeyType' => 'HASH|RANGE',
],
// ...
],
'OnDemandThroughput' => [
'MaxReadRequestUnits' => <integer>,
'MaxWriteRequestUnits' => <integer>,
],
'Projection' => [
'NonKeyAttributes' => ['<string>', ...],
'ProjectionType' => 'ALL|KEYS_ONLY|INCLUDE',
],
'ProvisionedThroughput' => [
'LastDecreaseDateTime' => <DateTime>,
'LastIncreaseDateTime' => <DateTime>,
'NumberOfDecreasesToday' => <integer>,
'ReadCapacityUnits' => <integer>,
'WriteCapacityUnits' => <integer>,
],
'WarmThroughput' => [
'ReadUnitsPerSecond' => <integer>,
'Status' => 'CREATING|UPDATING|DELETING|ACTIVE',
'WriteUnitsPerSecond' => <integer>,
],
],
// ...
],
'GlobalTableVersion' => '<string>',
'GlobalTableWitnesses' => [
[
'RegionName' => '<string>',
'WitnessStatus' => 'CREATING|DELETING|ACTIVE',
],
// ...
],
'ItemCount' => <integer>,
'KeySchema' => [
[
'AttributeName' => '<string>',
'KeyType' => 'HASH|RANGE',
],
// ...
],
'LatestStreamArn' => '<string>',
'LatestStreamLabel' => '<string>',
'LocalSecondaryIndexes' => [
[
'IndexArn' => '<string>',
'IndexName' => '<string>',
'IndexSizeBytes' => <integer>,
'ItemCount' => <integer>,
'KeySchema' => [
[
'AttributeName' => '<string>',
'KeyType' => 'HASH|RANGE',
],
// ...
],
'Projection' => [
'NonKeyAttributes' => ['<string>', ...],
'ProjectionType' => 'ALL|KEYS_ONLY|INCLUDE',
],
],
// ...
],
'MultiRegionConsistency' => 'EVENTUAL|STRONG',
'OnDemandThroughput' => [
'MaxReadRequestUnits' => <integer>,
'MaxWriteRequestUnits' => <integer>,
],
'ProvisionedThroughput' => [
'LastDecreaseDateTime' => <DateTime>,
'LastIncreaseDateTime' => <DateTime>,
'NumberOfDecreasesToday' => <integer>,
'ReadCapacityUnits' => <integer>,
'WriteCapacityUnits' => <integer>,
],
'Replicas' => [
[
'GlobalSecondaryIndexes' => [
[
'IndexName' => '<string>',
'OnDemandThroughputOverride' => [
'MaxReadRequestUnits' => <integer>,
],
'ProvisionedThroughputOverride' => [
'ReadCapacityUnits' => <integer>,
],
'WarmThroughput' => [
'ReadUnitsPerSecond' => <integer>,
'Status' => 'CREATING|UPDATING|DELETING|ACTIVE',
'WriteUnitsPerSecond' => <integer>,
],
],
// ...
],
'KMSMasterKeyId' => '<string>',
'OnDemandThroughputOverride' => [
'MaxReadRequestUnits' => <integer>,
],
'ProvisionedThroughputOverride' => [
'ReadCapacityUnits' => <integer>,
],
'RegionName' => '<string>',
'ReplicaInaccessibleDateTime' => <DateTime>,
'ReplicaStatus' => 'CREATING|CREATION_FAILED|UPDATING|DELETING|ACTIVE|REGION_DISABLED|INACCESSIBLE_ENCRYPTION_CREDENTIALS|ARCHIVING|ARCHIVED|REPLICATION_NOT_AUTHORIZED',
'ReplicaStatusDescription' => '<string>',
'ReplicaStatusPercentProgress' => '<string>',
'ReplicaTableClassSummary' => [
'LastUpdateDateTime' => <DateTime>,
'TableClass' => 'STANDARD|STANDARD_INFREQUENT_ACCESS',
],
'WarmThroughput' => [
'ReadUnitsPerSecond' => <integer>,
'Status' => 'CREATING|UPDATING|DELETING|ACTIVE|INACCESSIBLE_ENCRYPTION_CREDENTIALS|ARCHIVING|ARCHIVED|REPLICATION_NOT_AUTHORIZED',
'WriteUnitsPerSecond' => <integer>,
],
],
// ...
],
'RestoreSummary' => [
'RestoreDateTime' => <DateTime>,
'RestoreInProgress' => true || false,
'SourceBackupArn' => '<string>',
'SourceTableArn' => '<string>',
],
'SSEDescription' => [
'InaccessibleEncryptionDateTime' => <DateTime>,
'KMSMasterKeyArn' => '<string>',
'SSEType' => 'AES256|KMS',
'Status' => 'ENABLING|ENABLED|DISABLING|DISABLED|UPDATING',
],
'StreamSpecification' => [
'StreamEnabled' => true || false,
'StreamViewType' => 'NEW_IMAGE|OLD_IMAGE|NEW_AND_OLD_IMAGES|KEYS_ONLY',
],
'TableArn' => '<string>',
'TableClassSummary' => [
'LastUpdateDateTime' => <DateTime>,
'TableClass' => 'STANDARD|STANDARD_INFREQUENT_ACCESS',
],
'TableId' => '<string>',
'TableName' => '<string>',
'TableSizeBytes' => <integer>,
'TableStatus' => 'CREATING|UPDATING|DELETING|ACTIVE|INACCESSIBLE_ENCRYPTION_CREDENTIALS|ARCHIVING|ARCHIVED|REPLICATION_NOT_AUTHORIZED',
'WarmThroughput' => [
'ReadUnitsPerSecond' => <integer>,
'Status' => 'CREATING|UPDATING|DELETING|ACTIVE|INACCESSIBLE_ENCRYPTION_CREDENTIALS|ARCHIVING|ARCHIVED|REPLICATION_NOT_AUTHORIZED',
'WriteUnitsPerSecond' => <integer>,
],
],
]Result Details Members
Represents the properties of the table.
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.
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.
An error occurred on the server side.
This example creates a table named Music.
$result = $client->createTable([
'AttributeDefinitions' => [
[
'AttributeName' => 'Artist',
'AttributeType' => 'S',
],
[
'AttributeName' => 'SongTitle',
'AttributeType' => 'S',
],
],
'KeySchema' => [
[
'AttributeName' => 'Artist',
'KeyType' => 'HASH',
],
[
'AttributeName' => 'SongTitle',
'KeyType' => 'RANGE',
],
],
'ProvisionedThroughput' => [
'ReadCapacityUnits' => 5,
'WriteCapacityUnits' => 5,
],
'TableName' => 'Music',
]);
Result syntax:
[
'TableDescription' => [
'AttributeDefinitions' => [
[
'AttributeName' => 'Artist',
'AttributeType' => 'S',
],
[
'AttributeName' => 'SongTitle',
'AttributeType' => 'S',
],
],
'CreationDateTime' => ,
'ItemCount' => 0,
'KeySchema' => [
[
'AttributeName' => 'Artist',
'KeyType' => 'HASH',
],
[
'AttributeName' => 'SongTitle',
'KeyType' => 'RANGE',
],
],
'ProvisionedThroughput' => [
'ReadCapacityUnits' => 5,
'WriteCapacityUnits' => 5,
],
'TableName' => 'Music',
'TableSizeBytes' => 0,
'TableStatus' => 'CREATING',
],
] DeleteBackup
$result = $client->deleteBackup([/* ... */]); $promise = $client->deleteBackupAsync([/* ... */]);
Deletes an existing backup of a table.
You can call DeleteBackup at a maximum rate of 10 times per second.
$result = $client->deleteBackup([
'BackupArn' => '<string>', // REQUIRED
]);
Parameter Details Members
The ARN associated with the backup.
[
'BackupDescription' => [
'BackupDetails' => [
'BackupArn' => '<string>',
'BackupCreationDateTime' => <DateTime>,
'BackupExpiryDateTime' => <DateTime>,
'BackupName' => '<string>',
'BackupSizeBytes' => <integer>,
'BackupStatus' => 'CREATING|DELETED|AVAILABLE',
'BackupType' => 'USER|SYSTEM|AWS_BACKUP',
],
'SourceTableDetails' => [
'BillingMode' => 'PROVISIONED|PAY_PER_REQUEST',
'ItemCount' => <integer>,
'KeySchema' => [
[
'AttributeName' => '<string>',
'KeyType' => 'HASH|RANGE',
],
// ...
],
'OnDemandThroughput' => [
'MaxReadRequestUnits' => <integer>,
'MaxWriteRequestUnits' => <integer>,
],
'ProvisionedThroughput' => [
'ReadCapacityUnits' => <integer>,
'WriteCapacityUnits' => <integer>,
],
'TableArn' => '<string>',
'TableCreationDateTime' => <DateTime>,
'TableId' => '<string>',
'TableName' => '<string>',
'TableSizeBytes' => <integer>,
],
'SourceTableFeatureDetails' => [
'GlobalSecondaryIndexes' => [
[
'IndexName' => '<string>',
'KeySchema' => [
[
'AttributeName' => '<string>',
'KeyType' => 'HASH|RANGE',
],
// ...
],
'OnDemandThroughput' => [
'MaxReadRequestUnits' => <integer>,
'MaxWriteRequestUnits' => <integer>,
],
'Projection' => [
'NonKeyAttributes' => ['<string>', ...],
'ProjectionType' => 'ALL|KEYS_ONLY|INCLUDE',
],
'ProvisionedThroughput' => [
'ReadCapacityUnits' => <integer>,
'WriteCapacityUnits' => <integer>,
],
],
// ...
],
'LocalSecondaryIndexes' => [
[
'IndexName' => '<string>',
'KeySchema' => [
[
'AttributeName' => '<string>',
'KeyType' => 'HASH|RANGE',
],
// ...
],
'Projection' => [
'NonKeyAttributes' => ['<string>', ...],
'ProjectionType' => 'ALL|KEYS_ONLY|INCLUDE',
],
],
// ...
],
'SSEDescription' => [
'InaccessibleEncryptionDateTime' => <DateTime>,
'KMSMasterKeyArn' => '<string>',
'SSEType' => 'AES256|KMS',
'Status' => 'ENABLING|ENABLED|DISABLING|DISABLED|UPDATING',
],
'StreamDescription' => [
'StreamEnabled' => true || false,
'StreamViewType' => 'NEW_IMAGE|OLD_IMAGE|NEW_AND_OLD_IMAGES|KEYS_ONLY',
],
'TimeToLiveDescription' => [
'AttributeName' => '<string>',
'TimeToLiveStatus' => 'ENABLING|DISABLING|ENABLED|DISABLED',
],
],
],
]Result Details Members
Contains the description of the backup created for the table.
Backup not found for the given BackupARN.
There is another ongoing conflicting backup control plane operation on the table. The backup is either being created, deleted or restored to a table.
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.
An error occurred on the server side.
$result = $client->deleteItem([/* ... */]); $promise = $client->deleteItemAsync([/* ... */]);
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.
Parameter Syntax$result = $client->deleteItem([
'ConditionExpression' => '<string>',
'ConditionalOperator' => 'AND|OR',
'Expected' => [
'<AttributeName>' => [
'AttributeValueList' => [
[
'B' => <string || resource || Psr\Http\Message\StreamInterface>,
'BOOL' => true || false,
'BS' => [<string || resource || Psr\Http\Message\StreamInterface>, ...],
'L' => [
[...], // RECURSIVE
// ...
],
'M' => [
'<AttributeName>' => [...], // RECURSIVE
// ...
],
'N' => '<string>',
'NS' => ['<string>', ...],
'NULL' => true || false,
'S' => '<string>',
'SS' => ['<string>', ...],
],
// ...
],
'ComparisonOperator' => 'EQ|NE|IN|LE|LT|GE|GT|BETWEEN|NOT_NULL|NULL|CONTAINS|NOT_CONTAINS|BEGINS_WITH',
'Exists' => true || false,
'Value' => [
'B' => <string || resource || Psr\Http\Message\StreamInterface>,
'BOOL' => true || false,
'BS' => [<string || resource || Psr\Http\Message\StreamInterface>, ...],
'L' => [
[...], // RECURSIVE
// ...
],
'M' => [
'<AttributeName>' => [...], // RECURSIVE
// ...
],
'N' => '<string>',
'NS' => ['<string>', ...],
'NULL' => true || false,
'S' => '<string>',
'SS' => ['<string>', ...],
],
],
// ...
],
'ExpressionAttributeNames' => ['<string>', ...],
'ExpressionAttributeValues' => [
'<ExpressionAttributeValueVariable>' => [
'B' => <string || resource || Psr\Http\Message\StreamInterface>,
'BOOL' => true || false,
'BS' => [<string || resource || Psr\Http\Message\StreamInterface>, ...],
'L' => [
[...], // RECURSIVE
// ...
],
'M' => [
'<AttributeName>' => [...], // RECURSIVE
// ...
],
'N' => '<string>',
'NS' => ['<string>', ...],
'NULL' => true || false,
'S' => '<string>',
'SS' => ['<string>', ...],
],
// ...
],
'Key' => [ // REQUIRED
'<AttributeName>' => [
'B' => <string || resource || Psr\Http\Message\StreamInterface>,
'BOOL' => true || false,
'BS' => [<string || resource || Psr\Http\Message\StreamInterface>, ...],
'L' => [
[...], // RECURSIVE
// ...
],
'M' => [
'<AttributeName>' => [...], // RECURSIVE
// ...
],
'N' => '<string>',
'NS' => ['<string>', ...],
'NULL' => true || false,
'S' => '<string>',
'SS' => ['<string>', ...],
],
// ...
],
'ReturnConsumedCapacity' => 'INDEXES|TOTAL|NONE',
'ReturnItemCollectionMetrics' => 'SIZE|NONE',
'ReturnValues' => 'NONE|ALL_OLD|UPDATED_OLD|ALL_NEW|UPDATED_NEW',
'ReturnValuesOnConditionCheckFailure' => 'ALL_OLD|NONE',
'TableName' => '<string>', // REQUIRED
]);
Parameter Details Members
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 in the Amazon DynamoDB Developer Guide.
This is a legacy parameter. Use ConditionExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.
This is a legacy parameter. Use ConditionExpression instead. For more information, see Expected in the Amazon DynamoDB Developer Guide.
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 # 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 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 in the Amazon DynamoDB Developer Guide.
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 in the Amazon DynamoDB Developer Guide.
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.
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.
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.
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.
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.
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.
[
'Attributes' => [
'<AttributeName>' => [
'B' => <string || resource || Psr\Http\Message\StreamInterface>,
'BOOL' => true || false,
'BS' => [<string || resource || Psr\Http\Message\StreamInterface>, ...],
'L' => [
[...], // RECURSIVE
// ...
],
'M' => [
'<AttributeName>' => [...], // RECURSIVE
// ...
],
'N' => '<string>',
'NS' => ['<string>', ...],
'NULL' => true || false,
'S' => '<string>',
'SS' => ['<string>', ...],
],
// ...
],
'ConsumedCapacity' => [
'CapacityUnits' => <float>,
'GlobalSecondaryIndexes' => [
'<IndexName>' => [
'CapacityUnits' => <float>,
'ReadCapacityUnits' => <float>,
'WriteCapacityUnits' => <float>,
],
// ...
],
'LocalSecondaryIndexes' => [
'<IndexName>' => [
'CapacityUnits' => <float>,
'ReadCapacityUnits' => <float>,
'WriteCapacityUnits' => <float>,
],
// ...
],
'ReadCapacityUnits' => <float>,
'Table' => [
'CapacityUnits' => <float>,
'ReadCapacityUnits' => <float>,
'WriteCapacityUnits' => <float>,
],
'TableName' => '<string>',
'WriteCapacityUnits' => <float>,
],
'ItemCollectionMetrics' => [
'ItemCollectionKey' => [
'<AttributeName>' => [
'B' => <string || resource || Psr\Http\Message\StreamInterface>,
'BOOL' => true || false,
'BS' => [<string || resource || Psr\Http\Message\StreamInterface>, ...],
'L' => [
[...], // RECURSIVE
// ...
],
'M' => [
'<AttributeName>' => [...], // RECURSIVE
// ...
],
'N' => '<string>',
'NS' => ['<string>', ...],
'NULL' => true || false,
'S' => '<string>',
'SS' => ['<string>', ...],
],
// ...
],
'SizeEstimateRangeGB' => [<float>, ...],
],
]Result Details Members
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.
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 in the Amazon DynamoDB Developer Guide.
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.
A condition specified in the operation failed to be evaluated.
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 field in the returned exception. The Amazon Web Services 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 in the Amazon DynamoDB Developer Guide.
The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be ACTIVE.
An item collection is too large. This exception is only returned for tables that have one or more local secondary indexes.
Operation was rejected because there is an ongoing transaction for the item.
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 field in the returned exception. Contact Amazon Web ServicesSupport to request a quota increase.
An error occurred on the server side.
The request was rejected because one or more items in the request are being modified by a request in another Region.
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 field in the returned exception.
This example deletes an item from the Music table.
$result = $client->deleteItem([
'Key' => [
'Artist' => [
'S' => 'No One You Know',
],
'SongTitle' => [
'S' => 'Scared of My Shadow',
],
],
'TableName' => 'Music',
]);
Result syntax:
[
'ConsumedCapacity' => [
'CapacityUnits' => 1,
'TableName' => 'Music',
],
] DeleteResourcePolicy
$result = $client->deleteResourcePolicy([/* ... */]); $promise = $client->deleteResourcePolicyAsync([/* ... */]);
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.
To make sure that you don't inadvertently lock yourself out of your own resources, the root principal in your Amazon Web Services account can perform DeleteResourcePolicy requests, even if your resource-based policy explicitly denies the root principal's access.
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.
$result = $client->deleteResourcePolicy([
'ExpectedRevisionId' => '<string>',
'ResourceArn' => '<string>', // REQUIRED
]);
Parameter Details Members
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.
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.
[
'RevisionId' => '<string>',
]Result Details Members
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.
The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be ACTIVE.
An error occurred on the server side.
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.
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.
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.
$result = $client->deleteTable([/* ... */]); $promise = $client->deleteTableAsync([/* ... */]);
The DeleteTable operation deletes a table and all of its items. After a DeleteTable request, the specified table is in the DELETING state until DynamoDB completes the deletion. If the table is in the ACTIVE state, you can delete it. If a table is in CREATING or UPDATING states, then DynamoDB returns a ResourceInUseException. If the specified table does not exist, DynamoDB returns a ResourceNotFoundException. If table is already in the DELETING state, no error is returned.
DynamoDB might continue to accept data read and write operations, such as GetItem and PutItem, on a table in the DELETING state until the table deletion is complete. For the full list of table states, see 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.
$result = $client->deleteTable([
'TableName' => '<string>', // REQUIRED
]);
Parameter Details Members
The name of the table to delete. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.
[
'TableDescription' => [
'ArchivalSummary' => [
'ArchivalBackupArn' => '<string>',
'ArchivalDateTime' => <DateTime>,
'ArchivalReason' => '<string>',
],
'AttributeDefinitions' => [
[
'AttributeName' => '<string>',
'AttributeType' => 'S|N|B',
],
// ...
],
'BillingModeSummary' => [
'BillingMode' => 'PROVISIONED|PAY_PER_REQUEST',
'LastUpdateToPayPerRequestDateTime' => <DateTime>,
],
'CreationDateTime' => <DateTime>,
'DeletionProtectionEnabled' => true || false,
'GlobalSecondaryIndexes' => [
[
'Backfilling' => true || false,
'IndexArn' => '<string>',
'IndexName' => '<string>',
'IndexSizeBytes' => <integer>,
'IndexStatus' => 'CREATING|UPDATING|DELETING|ACTIVE',
'ItemCount' => <integer>,
'KeySchema' => [
[
'AttributeName' => '<string>',
'KeyType' => 'HASH|RANGE',
],
// ...
],
'OnDemandThroughput' => [
'MaxReadRequestUnits' => <integer>,
'MaxWriteRequestUnits' => <integer>,
],
'Projection' => [
'NonKeyAttributes' => ['<string>', ...],
'ProjectionType' => 'ALL|KEYS_ONLY|INCLUDE',
],
'ProvisionedThroughput' => [
'LastDecreaseDateTime' => <DateTime>,
'LastIncreaseDateTime' => <DateTime>,
'NumberOfDecreasesToday' => <integer>,
'ReadCapacityUnits' => <integer>,
'WriteCapacityUnits' => <integer>,
],
'WarmThroughput' => [
'ReadUnitsPerSecond' => <integer>,
'Status' => 'CREATING|UPDATING|DELETING|ACTIVE',
'WriteUnitsPerSecond' => <integer>,
],
],
// ...
],
'GlobalTableVersion' => '<string>',
'GlobalTableWitnesses' => [
[
'RegionName' => '<string>',
'WitnessStatus' => 'CREATING|DELETING|ACTIVE',
],
// ...
],
'ItemCount' => <integer>,
'KeySchema' => [
[
'AttributeName' => '<string>',
'KeyType' => 'HASH|RANGE',
],
// ...
],
'LatestStreamArn' => '<string>',
'LatestStreamLabel' => '<string>',
'LocalSecondaryIndexes' => [
[
'IndexArn' => '<string>',
'IndexName' => '<string>',
'IndexSizeBytes' => <integer>,
'ItemCount' => <integer>,
'KeySchema' => [
[
'AttributeName' => '<string>',
'KeyType' => 'HASH|RANGE',
],
// ...
],
'Projection' => [
'NonKeyAttributes' => ['<string>', ...],
'ProjectionType' => 'ALL|KEYS_ONLY|INCLUDE',
],
],
// ...
],
'MultiRegionConsistency' => 'EVENTUAL|STRONG',
'OnDemandThroughput' => [
'MaxReadRequestUnits' => <integer>,
'MaxWriteRequestUnits' => <integer>,
],
'ProvisionedThroughput' => [
'LastDecreaseDateTime' => <DateTime>,
'LastIncreaseDateTime' => <DateTime>,
'NumberOfDecreasesToday' => <integer>,
'ReadCapacityUnits' => <integer>,
'WriteCapacityUnits' => <integer>,
],
'Replicas' => [
[
'GlobalSecondaryIndexes' => [
[
'IndexName' => '<string>',
'OnDemandThroughputOverride' => [
'MaxReadRequestUnits' => <integer>,
],
'ProvisionedThroughputOverride' => [
'ReadCapacityUnits' => <integer>,
],
'WarmThroughput' => [
'ReadUnitsPerSecond' => <integer>,
'Status' => 'CREATING|UPDATING|DELETING|ACTIVE',
'WriteUnitsPerSecond' => <integer>,
],
],
// ...
],
'KMSMasterKeyId' => '<string>',
'OnDemandThroughputOverride' => [
'MaxReadRequestUnits' => <integer>,
],
'ProvisionedThroughputOverride' => [
'ReadCapacityUnits' => <integer>,
],
'RegionName' => '<string>',
'ReplicaInaccessibleDateTime' => <DateTime>,
'ReplicaStatus' => 'CREATING|CREATION_FAILED|UPDATING|DELETING|ACTIVE|REGION_DISABLED|INACCESSIBLE_ENCRYPTION_CREDENTIALS|ARCHIVING|ARCHIVED|REPLICATION_NOT_AUTHORIZED',
'ReplicaStatusDescription' => '<string>',
'ReplicaStatusPercentProgress' => '<string>',
'ReplicaTableClassSummary' => [
'LastUpdateDateTime' => <DateTime>,
'TableClass' => 'STANDARD|STANDARD_INFREQUENT_ACCESS',
],
'WarmThroughput' => [
'ReadUnitsPerSecond' => <integer>,
'Status' => 'CREATING|UPDATING|DELETING|ACTIVE|INACCESSIBLE_ENCRYPTION_CREDENTIALS|ARCHIVING|ARCHIVED|REPLICATION_NOT_AUTHORIZED',
'WriteUnitsPerSecond' => <integer>,
],
],
// ...
],
'RestoreSummary' => [
'RestoreDateTime' => <DateTime>,
'RestoreInProgress' => true || false,
'SourceBackupArn' => '<string>',
'SourceTableArn' => '<string>',
],
'SSEDescription' => [
'InaccessibleEncryptionDateTime' => <DateTime>,
'KMSMasterKeyArn' => '<string>',
'SSEType' => 'AES256|KMS',
'Status' => 'ENABLING|ENABLED|DISABLING|DISABLED|UPDATING',
],
'StreamSpecification' => [
'StreamEnabled' => true || false,
'StreamViewType' => 'NEW_IMAGE|OLD_IMAGE|NEW_AND_OLD_IMAGES|KEYS_ONLY',
],
'TableArn' => '<string>',
'TableClassSummary' => [
'LastUpdateDateTime' => <DateTime>,
'TableClass' => 'STANDARD|STANDARD_INFREQUENT_ACCESS',
],
'TableId' => '<string>',
'TableName' => '<string>',
'TableSizeBytes' => <integer>,
'TableStatus' => 'CREATING|UPDATING|DELETING|ACTIVE|INACCESSIBLE_ENCRYPTION_CREDENTIALS|ARCHIVING|ARCHIVED|REPLICATION_NOT_AUTHORIZED',
'WarmThroughput' => [
'ReadUnitsPerSecond' => <integer>,
'Status' => 'CREATING|UPDATING|DELETING|ACTIVE|INACCESSIBLE_ENCRYPTION_CREDENTIALS|ARCHIVING|ARCHIVED|REPLICATION_NOT_AUTHORIZED',
'WriteUnitsPerSecond' => <integer>,
],
],
]Result Details Members
Represents the properties of a table.
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.
The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be ACTIVE.
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.
An error occurred on the server side.
This example deletes the Music table.
$result = $client->deleteTable([
'TableName' => 'Music',
]);
Result syntax:
[
'TableDescription' => [
'ItemCount' => 0,
'ProvisionedThroughput' => [
'NumberOfDecreasesToday' => 1,
'ReadCapacityUnits' => 5,
'WriteCapacityUnits' => 5,
],
'TableName' => 'Music',
'TableSizeBytes' => 0,
'TableStatus' => 'DELETING',
],
] DescribeBackup
$result = $client->describeBackup([/* ... */]); $promise = $client->describeBackupAsync([/* ... */]);
Describes an existing backup of a table.
You can call DescribeBackup at a maximum rate of 10 times per second.
$result = $client->describeBackup([
'BackupArn' => '<string>', // REQUIRED
]);
Parameter Details Members
The Amazon Resource Name (ARN) associated with the backup.
[
'BackupDescription' => [
'BackupDetails' => [
'BackupArn' => '<string>',
'BackupCreationDateTime' => <DateTime>,
'BackupExpiryDateTime' => <DateTime>,
'BackupName' => '<string>',
'BackupSizeBytes' => <integer>,
'BackupStatus' => 'CREATING|DELETED|AVAILABLE',
'BackupType' => 'USER|SYSTEM|AWS_BACKUP',
],
'SourceTableDetails' => [
'BillingMode' => 'PROVISIONED|PAY_PER_REQUEST',
'ItemCount' => <integer>,
'KeySchema' => [
[
'AttributeName' => '<string>',
'KeyType' => 'HASH|RANGE',
],
// ...
],
'OnDemandThroughput' => [
'MaxReadRequestUnits' => <integer>,
'MaxWriteRequestUnits' => <integer>,
],
'ProvisionedThroughput' => [
'ReadCapacityUnits' => <integer>,
'WriteCapacityUnits' => <integer>,
],
'TableArn' => '<string>',
'TableCreationDateTime' => <DateTime>,
'TableId' => '<string>',
'TableName' => '<string>',
'TableSizeBytes' => <integer>,
],
'SourceTableFeatureDetails' => [
'GlobalSecondaryIndexes' => [
[
'IndexName' => '<string>',
'KeySchema' => [
[
'AttributeName' => '<string>',
'KeyType' => 'HASH|RANGE',
],
// ...
],
'OnDemandThroughput' => [
'MaxReadRequestUnits' => <integer>,
'MaxWriteRequestUnits' => <integer>,
],
'Projection' => [
'NonKeyAttributes' => ['<string>', ...],
'ProjectionType' => 'ALL|KEYS_ONLY|INCLUDE',
],
'ProvisionedThroughput' => [
'ReadCapacityUnits' => <integer>,
'WriteCapacityUnits' => <integer>,
],
],
// ...
],
'LocalSecondaryIndexes' => [
[
'IndexName' => '<string>',
'KeySchema' => [
[
'AttributeName' => '<string>',
'KeyType' => 'HASH|RANGE',
],
// ...
],
'Projection' => [
'NonKeyAttributes' => ['<string>', ...],
'ProjectionType' => 'ALL|KEYS_ONLY|INCLUDE',
],
],
// ...
],
'SSEDescription' => [
'InaccessibleEncryptionDateTime' => <DateTime>,
'KMSMasterKeyArn' => '<string>',
'SSEType' => 'AES256|KMS',
'Status' => 'ENABLING|ENABLED|DISABLING|DISABLED|UPDATING',
],
'StreamDescription' => [
'StreamEnabled' => true || false,
'StreamViewType' => 'NEW_IMAGE|OLD_IMAGE|NEW_AND_OLD_IMAGES|KEYS_ONLY',
],
'TimeToLiveDescription' => [
'AttributeName' => '<string>',
'TimeToLiveStatus' => 'ENABLING|DISABLING|ENABLED|DISABLED',
],
],
],
]Result Details Members
Contains the description of the backup created for the table.
Backup not found for the given BackupARN.
An error occurred on the server side.
$result = $client->describeContinuousBackups([/* ... */]); $promise = $client->describeContinuousBackupsAsync([/* ... */]);
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.
$result = $client->describeContinuousBackups([
'TableName' => '<string>', // REQUIRED
]);
Parameter Details Members
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.
[
'ContinuousBackupsDescription' => [
'ContinuousBackupsStatus' => 'ENABLED|DISABLED',
'PointInTimeRecoveryDescription' => [
'EarliestRestorableDateTime' => <DateTime>,
'LatestRestorableDateTime' => <DateTime>,
'PointInTimeRecoveryStatus' => 'ENABLED|DISABLED',
'RecoveryPeriodInDays' => <integer>,
],
],
]Result Details Members
Represents the continuous backups and point in time recovery settings on the table.
A source table with the name TableName does not currently exist within the subscriber's account or the subscriber is operating in the wrong Amazon Web Services Region.
An error occurred on the server side.
$result = $client->describeContributorInsights([/* ... */]); $promise = $client->describeContributorInsightsAsync([/* ... */]);
Returns information about contributor insights for a given table or global secondary index.
Parameter Syntax$result = $client->describeContributorInsights([
'IndexName' => '<string>',
'TableName' => '<string>', // REQUIRED
]);
Parameter Details Members
The name of the global secondary index to describe, if applicable.
The name of the table to describe. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.
[
'ContributorInsightsMode' => 'ACCESSED_AND_THROTTLED_KEYS|THROTTLED_KEYS',
'ContributorInsightsRuleList' => ['<string>', ...],
'ContributorInsightsStatus' => 'ENABLING|ENABLED|DISABLING|DISABLED|FAILED',
'FailureException' => [
'ExceptionDescription' => '<string>',
'ExceptionName' => '<string>',
],
'IndexName' => '<string>',
'LastUpdateDateTime' => <DateTime>,
'TableName' => '<string>',
]Result Details Members
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.
List of names of the associated contributor insights rules.
Current status of contributor insights.
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.
The name of the global secondary index being described.
Timestamp of the last time the status was changed.
The name of the table being described.
The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be ACTIVE.
An error occurred on the server side.
$result = $client->describeEndpoints([/* ... */]); $promise = $client->describeEndpointsAsync([/* ... */]);
Returns the regional endpoint information. For more information on policy permissions, please see Internetwork traffic privacy.
Parameter Syntax$result = $client->describeEndpoints([ ]);Parameter Details Result Syntax
[
'Endpoints' => [
[
'Address' => '<string>',
'CachePeriodInMinutes' => <integer>,
],
// ...
],
]Result Details Members
List of endpoints.
There are no errors described for this operation.
DescribeExport$result = $client->describeExport([/* ... */]); $promise = $client->describeExportAsync([/* ... */]);
Describes an existing table export.
Parameter Syntax$result = $client->describeExport([
'ExportArn' => '<string>', // REQUIRED
]);
Parameter Details Members
The Amazon Resource Name (ARN) associated with the export.
[
'ExportDescription' => [
'BilledSizeBytes' => <integer>,
'ClientToken' => '<string>',
'EndTime' => <DateTime>,
'ExportArn' => '<string>',
'ExportFormat' => 'DYNAMODB_JSON|ION',
'ExportManifest' => '<string>',
'ExportStatus' => 'IN_PROGRESS|COMPLETED|FAILED',
'ExportTime' => <DateTime>,
'ExportType' => 'FULL_EXPORT|INCREMENTAL_EXPORT',
'FailureCode' => '<string>',
'FailureMessage' => '<string>',
'IncrementalExportSpecification' => [
'ExportFromTime' => <DateTime>,
'ExportToTime' => <DateTime>,
'ExportViewType' => 'NEW_IMAGE|NEW_AND_OLD_IMAGES',
],
'ItemCount' => <integer>,
'S3Bucket' => '<string>',
'S3BucketOwner' => '<string>',
'S3Prefix' => '<string>',
'S3SseAlgorithm' => 'AES256|KMS',
'S3SseKmsKeyId' => '<string>',
'StartTime' => <DateTime>,
'TableArn' => '<string>',
'TableId' => '<string>',
],
]Result Details Members
Represents the properties of the export.
The specified export was not found.
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.
An error occurred on the server side.
$result = $client->describeGlobalTable([/* ... */]); $promise = $client->describeGlobalTableAsync([/* ... */]);
Returns information about the specified global table.
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) 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. To update existing global tables from version 2017.11.29 (Legacy) to version 2019.11.21 (Current), see Upgrading global tables.
Parameter Syntax$result = $client->describeGlobalTable([
'GlobalTableName' => '<string>', // REQUIRED
]);
Parameter Details Members
The name of the global table.
[
'GlobalTableDescription' => [
'CreationDateTime' => <DateTime>,
'GlobalTableArn' => '<string>',
'GlobalTableName' => '<string>',
'GlobalTableStatus' => 'CREATING|ACTIVE|DELETING|UPDATING',
'ReplicationGroup' => [
[
'GlobalSecondaryIndexes' => [
[
'IndexName' => '<string>',
'OnDemandThroughputOverride' => [
'MaxReadRequestUnits' => <integer>,
],
'ProvisionedThroughputOverride' => [
'ReadCapacityUnits' => <integer>,
],
'WarmThroughput' => [
'ReadUnitsPerSecond' => <integer>,
'Status' => 'CREATING|UPDATING|DELETING|ACTIVE',
'WriteUnitsPerSecond' => <integer>,
],
],
// ...
],
'KMSMasterKeyId' => '<string>',
'OnDemandThroughputOverride' => [
'MaxReadRequestUnits' => <integer>,
],
'ProvisionedThroughputOverride' => [
'ReadCapacityUnits' => <integer>,
],
'RegionName' => '<string>',
'ReplicaInaccessibleDateTime' => <DateTime>,
'ReplicaStatus' => 'CREATING|CREATION_FAILED|UPDATING|DELETING|ACTIVE|REGION_DISABLED|INACCESSIBLE_ENCRYPTION_CREDENTIALS|ARCHIVING|ARCHIVED|REPLICATION_NOT_AUTHORIZED',
'ReplicaStatusDescription' => '<string>',
'ReplicaStatusPercentProgress' => '<string>',
'ReplicaTableClassSummary' => [
'LastUpdateDateTime' => <DateTime>,
'TableClass' => 'STANDARD|STANDARD_INFREQUENT_ACCESS',
],
'WarmThroughput' => [
'ReadUnitsPerSecond' => <integer>,
'Status' => 'CREATING|UPDATING|DELETING|ACTIVE|INACCESSIBLE_ENCRYPTION_CREDENTIALS|ARCHIVING|ARCHIVED|REPLICATION_NOT_AUTHORIZED',
'WriteUnitsPerSecond' => <integer>,
],
],
// ...
],
],
]Result Details Members
Contains the details of the global table.
An error occurred on the server side.
The specified global table does not exist.
$result = $client->describeGlobalTableSettings([/* ... */]); $promise = $client->describeGlobalTableSettingsAsync([/* ... */]);
Describes Region-specific settings for a global table.
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) 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. To update existing global tables from version 2017.11.29 (Legacy) to version 2019.11.21 (Current), see Upgrading global tables.
Parameter Syntax$result = $client->describeGlobalTableSettings([
'GlobalTableName' => '<string>', // REQUIRED
]);
Parameter Details Members
The name of the global table to describe.
[
'GlobalTableName' => '<string>',
'ReplicaSettings' => [
[
'RegionName' => '<string>',
'ReplicaBillingModeSummary' => [
'BillingMode' => 'PROVISIONED|PAY_PER_REQUEST',
'LastUpdateToPayPerRequestDateTime' => <DateTime>,
],
'ReplicaGlobalSecondaryIndexSettings' => [
[
'IndexName' => '<string>',
'IndexStatus' => 'CREATING|UPDATING|DELETING|ACTIVE',
'ProvisionedReadCapacityAutoScalingSettings' => [
'AutoScalingDisabled' => true || false,
'AutoScalingRoleArn' => '<string>',
'MaximumUnits' => <integer>,
'MinimumUnits' => <integer>,
'ScalingPolicies' => [
[
'PolicyName' => '<string>',
'TargetTrackingScalingPolicyConfiguration' => [
'DisableScaleIn' => true || false,
'ScaleInCooldown' => <integer>,
'ScaleOutCooldown' => <integer>,
'TargetValue' => <float>,
],
],
// ...
],
],
'ProvisionedReadCapacityUnits' => <integer>,
'ProvisionedWriteCapacityAutoScalingSettings' => [
'AutoScalingDisabled' => true || false,
'AutoScalingRoleArn' => '<string>',
'MaximumUnits' => <integer>,
'MinimumUnits' => <integer>,
'ScalingPolicies' => [
[
'PolicyName' => '<string>',
'TargetTrackingScalingPolicyConfiguration' => [
'DisableScaleIn' => true || false,
'ScaleInCooldown' => <integer>,
'ScaleOutCooldown' => <integer>,
'TargetValue' => <float>,
],
],
// ...
],
],
'ProvisionedWriteCapacityUnits' => <integer>,
],
// ...
],
'ReplicaProvisionedReadCapacityAutoScalingSettings' => [
'AutoScalingDisabled' => true || false,
'AutoScalingRoleArn' => '<string>',
'MaximumUnits' => <integer>,
'MinimumUnits' => <integer>,
'ScalingPolicies' => [
[
'PolicyName' => '<string>',
'TargetTrackingScalingPolicyConfiguration' => [
'DisableScaleIn' => true || false,
'ScaleInCooldown' => <integer>,
'ScaleOutCooldown' => <integer>,
'TargetValue' => <float>,
],
],
// ...
],
],
'ReplicaProvisionedReadCapacityUnits' => <integer>,
'ReplicaProvisionedWriteCapacityAutoScalingSettings' => [
'AutoScalingDisabled' => true || false,
'AutoScalingRoleArn' => '<string>',
'MaximumUnits' => <integer>,
'MinimumUnits' => <integer>,
'ScalingPolicies' => [
[
'PolicyName' => '<string>',
'TargetTrackingScalingPolicyConfiguration' => [
'DisableScaleIn' => true || false,
'ScaleInCooldown' => <integer>,
'ScaleOutCooldown' => <integer>,
'TargetValue' => <float>,
],
],
// ...
],
],
'ReplicaProvisionedWriteCapacityUnits' => <integer>,
'ReplicaStatus' => 'CREATING|CREATION_FAILED|UPDATING|DELETING|ACTIVE|REGION_DISABLED|INACCESSIBLE_ENCRYPTION_CREDENTIALS|ARCHIVING|ARCHIVED|REPLICATION_NOT_AUTHORIZED',
'ReplicaTableClassSummary' => [
'LastUpdateDateTime' => <DateTime>,
'TableClass' => 'STANDARD|STANDARD_INFREQUENT_ACCESS',
],
],
// ...
],
]Result Details Members
The name of the global table.
The Region-specific settings for the global table.
The specified global table does not exist.
An error occurred on the server side.
$result = $client->describeImport([/* ... */]); $promise = $client->describeImportAsync([/* ... */]);
Represents the properties of the import.
Parameter Syntax$result = $client->describeImport([
'ImportArn' => '<string>', // REQUIRED
]);
Parameter Details Members
The Amazon Resource Name (ARN) associated with the table you're importing to.
[
'ImportTableDescription' => [
'ClientToken' => '<string>',
'CloudWatchLogGroupArn' => '<string>',
'EndTime' => <DateTime>,
'ErrorCount' => <integer>,
'FailureCode' => '<string>',
'FailureMessage' => '<string>',
'ImportArn' => '<string>',
'ImportStatus' => 'IN_PROGRESS|COMPLETED|CANCELLING|CANCELLED|FAILED',
'ImportedItemCount' => <integer>,
'InputCompressionType' => 'GZIP|ZSTD|NONE',
'InputFormat' => 'DYNAMODB_JSON|ION|CSV',
'InputFormatOptions' => [
'Csv' => [
'Delimiter' => '<string>',
'HeaderList' => ['<string>', ...],
],
],
'ProcessedItemCount' => <integer>,
'ProcessedSizeBytes' => <integer>,
'S3BucketSource' => [
'S3Bucket' => '<string>',
'S3BucketOwner' => '<string>',
'S3KeyPrefix' => '<string>',
],
'StartTime' => <DateTime>,
'TableArn' => '<string>',
'TableCreationParameters' => [
'AttributeDefinitions' => [
[
'AttributeName' => '<string>',
'AttributeType' => 'S|N|B',
],
// ...
],
'BillingMode' => 'PROVISIONED|PAY_PER_REQUEST',
'GlobalSecondaryIndexes' => [
[
'IndexName' => '<string>',
'KeySchema' => [
[
'AttributeName' => '<string>',
'KeyType' => 'HASH|RANGE',
],
// ...
],
'OnDemandThroughput' => [
'MaxReadRequestUnits' => <integer>,
'MaxWriteRequestUnits' => <integer>,
],
'Projection' => [
'NonKeyAttributes' => ['<string>', ...],
'ProjectionType' => 'ALL|KEYS_ONLY|INCLUDE',
],
'ProvisionedThroughput' => [
'ReadCapacityUnits' => <integer>,
'WriteCapacityUnits' => <integer>,
],
'WarmThroughput' => [
'ReadUnitsPerSecond' => <integer>,
'WriteUnitsPerSecond' => <integer>,
],
],
// ...
],
'KeySchema' => [
[
'AttributeName' => '<string>',
'KeyType' => 'HASH|RANGE',
],
// ...
],
'OnDemandThroughput' => [
'MaxReadRequestUnits' => <integer>,
'MaxWriteRequestUnits' => <integer>,
],
'ProvisionedThroughput' => [
'ReadCapacityUnits' => <integer>,
'WriteCapacityUnits' => <integer>,
],
'SSESpecification' => [
'Enabled' => true || false,
'KMSMasterKeyId' => '<string>',
'SSEType' => 'AES256|KMS',
],
'TableName' => '<string>',
],
'TableId' => '<string>',
],
]Result Details Members
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.
The specified import was not found.
$result = $client->describeKinesisStreamingDestination([/* ... */]); $promise = $client->describeKinesisStreamingDestinationAsync([/* ... */]);
Returns information about the status of Kinesis streaming.
Parameter Syntax$result = $client->describeKinesisStreamingDestination([
'TableName' => '<string>', // REQUIRED
]);
Parameter Details Members
The name of the table being described. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.
[
'KinesisDataStreamDestinations' => [
[
'ApproximateCreationDateTimePrecision' => 'MILLISECOND|MICROSECOND',
'DestinationStatus' => 'ENABLING|ACTIVE|DISABLING|DISABLED|ENABLE_FAILED|UPDATING',
'DestinationStatusDescription' => '<string>',
'StreamArn' => '<string>',
],
// ...
],
'TableName' => '<string>',
]Result Details Members
The list of replica structures for the table being described.
The name of the table being described.
The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be ACTIVE.
An error occurred on the server side.
$result = $client->describeLimits([/* ... */]); $promise = $client->describeLimitsAsync([/* ... */]);
Returns the current provisioned-capacity quotas for your Amazon Web Services 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 Amazon Web Services 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 page in the Amazon DynamoDB Developer Guide.
Although you can increase these quotas by filing a case at Amazon Web Services Support Center, obtaining the increase is not instantaneous. The DescribeLimits action lets you write code to compare the capacity you are currently using to those 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 Amazon Web Services SDKs to do the following:
Call DescribeLimits for a particular Region to obtain your current account quotas on provisioned capacity there.
Create a variable to hold the aggregate read capacity units provisioned for all your tables in that Region, and one to hold the aggregate write capacity units. Zero them both.
Call ListTables to obtain a list of all your DynamoDB tables.
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.
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.
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.
$result = $client->describeLimits([ ]);Parameter Details Result Syntax
[
'AccountMaxReadCapacityUnits' => <integer>,
'AccountMaxWriteCapacityUnits' => <integer>,
'TableMaxReadCapacityUnits' => <integer>,
'TableMaxWriteCapacityUnits' => <integer>,
]Result Details Members
The maximum total read capacity units that your account allows you to provision across all of your tables in this Region.
The maximum total write capacity units that your account allows you to provision across all of your tables in this Region.
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).
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).
An error occurred on the server side.
The following example returns the maximum read and write capacity units per table, and for the AWS account, in the current AWS region.
$result = $client->describeLimits([ ]);
Result syntax:
[
'AccountMaxReadCapacityUnits' => 20000,
'AccountMaxWriteCapacityUnits' => 20000,
'TableMaxReadCapacityUnits' => 10000,
'TableMaxWriteCapacityUnits' => 10000,
] DescribeTable
$result = $client->describeTable([/* ... */]); $promise = $client->describeTableAsync([/* ... */]);
Returns information about the table, including the current status of the table, when it was created, the primary key schema, and any indexes on the table.
If you issue a DescribeTable request immediately after a CreateTable request, DynamoDB might return a ResourceNotFoundException. This is because DescribeTable uses an eventually consistent query, and the metadata for your table might not be available at that moment. Wait for a few seconds, and then try the DescribeTable request again.
$result = $client->describeTable([
'TableName' => '<string>', // REQUIRED
]);
Parameter Details Members
The name of the table to describe. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.
[
'Table' => [
'ArchivalSummary' => [
'ArchivalBackupArn' => '<string>',
'ArchivalDateTime' => <DateTime>,
'ArchivalReason' => '<string>',
],
'AttributeDefinitions' => [
[
'AttributeName' => '<string>',
'AttributeType' => 'S|N|B',
],
// ...
],
'BillingModeSummary' => [
'BillingMode' => 'PROVISIONED|PAY_PER_REQUEST',
'LastUpdateToPayPerRequestDateTime' => <DateTime>,
],
'CreationDateTime' => <DateTime>,
'DeletionProtectionEnabled' => true || false,
'GlobalSecondaryIndexes' => [
[
'Backfilling' => true || false,
'IndexArn' => '<string>',
'IndexName' => '<string>',
'IndexSizeBytes' => <integer>,
'IndexStatus' => 'CREATING|UPDATING|DELETING|ACTIVE',
'ItemCount' => <integer>,
'KeySchema' => [
[
'AttributeName' => '<string>',
'KeyType' => 'HASH|RANGE',
],
// ...
],
'OnDemandThroughput' => [
'MaxReadRequestUnits' => <integer>,
'MaxWriteRequestUnits' => <integer>,
],
'Projection' => [
'NonKeyAttributes' => ['<string>', ...],
'ProjectionType' => 'ALL|KEYS_ONLY|INCLUDE',
],
'ProvisionedThroughput' => [
'LastDecreaseDateTime' => <DateTime>,
'LastIncreaseDateTime' => <DateTime>,
'NumberOfDecreasesToday' => <integer>,
'ReadCapacityUnits' => <integer>,
'WriteCapacityUnits' => <integer>,
],
'WarmThroughput' => [
'ReadUnitsPerSecond' => <integer>,
'Status' => 'CREATING|UPDATING|DELETING|ACTIVE',
'WriteUnitsPerSecond' => <integer>,
],
],
// ...
],
'GlobalTableVersion' => '<string>',
'GlobalTableWitnesses' => [
[
'RegionName' => '<string>',
'WitnessStatus' => 'CREATING|DELETING|ACTIVE',
],
// ...
],
'ItemCount' => <integer>,
'KeySchema' => [
[
'AttributeName' => '<string>',
'KeyType' => 'HASH|RANGE',
],
// ...
],
'LatestStreamArn' => '<string>',
'LatestStreamLabel' => '<string>',
'LocalSecondaryIndexes' => [
[
'IndexArn' => '<string>',
'IndexName' => '<string>',
'IndexSizeBytes' => <integer>,
'ItemCount' => <integer>,
'KeySchema' => [
[
'AttributeName' => '<string>',
'KeyType' => 'HASH|RANGE',
],
// ...
],
'Projection' => [
'NonKeyAttributes' => ['<string>', ...],
'ProjectionType' => 'ALL|KEYS_ONLY|INCLUDE',
],
],
// ...
],
'MultiRegionConsistency' => 'EVENTUAL|STRONG',
'OnDemandThroughput' => [
'MaxReadRequestUnits' => <integer>,
'MaxWriteRequestUnits' => <integer>,
],
'ProvisionedThroughput' => [
'LastDecreaseDateTime' => <DateTime>,
'LastIncreaseDateTime' => <DateTime>,
'NumberOfDecreasesToday' => <integer>,
'ReadCapacityUnits' => <integer>,
'WriteCapacityUnits' => <integer>,
],
'Replicas' => [
[
'GlobalSecondaryIndexes' => [
[
'IndexName' => '<string>',
'OnDemandThroughputOverride' => [
'MaxReadRequestUnits' => <integer>,
],
'ProvisionedThroughputOverride' => [
'ReadCapacityUnits' => <integer>,
],
'WarmThroughput' => [
'ReadUnitsPerSecond' => <integer>,
'Status' => 'CREATING|UPDATING|DELETING|ACTIVE',
'WriteUnitsPerSecond' => <integer>,
],
],
// ...
],
'KMSMasterKeyId' => '<string>',
'OnDemandThroughputOverride' => [
'MaxReadRequestUnits' => <integer>,
],
'ProvisionedThroughputOverride' => [
'ReadCapacityUnits' => <integer>,
],
'RegionName' => '<string>',
'ReplicaInaccessibleDateTime' => <DateTime>,
'ReplicaStatus' => 'CREATING|CREATION_FAILED|UPDATING|DELETING|ACTIVE|REGION_DISABLED|INACCESSIBLE_ENCRYPTION_CREDENTIALS|ARCHIVING|ARCHIVED|REPLICATION_NOT_AUTHORIZED',
'ReplicaStatusDescription' => '<string>',
'ReplicaStatusPercentProgress' => '<string>',
'ReplicaTableClassSummary' => [
'LastUpdateDateTime' => <DateTime>,
'TableClass' => 'STANDARD|STANDARD_INFREQUENT_ACCESS',
],
'WarmThroughput' => [
'ReadUnitsPerSecond' => <integer>,
'Status' => 'CREATING|UPDATING|DELETING|ACTIVE|INACCESSIBLE_ENCRYPTION_CREDENTIALS|ARCHIVING|ARCHIVED|REPLICATION_NOT_AUTHORIZED',
'WriteUnitsPerSecond' => <integer>,
],
],
// ...
],
'RestoreSummary' => [
'RestoreDateTime' => <DateTime>,
'RestoreInProgress' => true || false,
'SourceBackupArn' => '<string>',
'SourceTableArn' => '<string>',
],
'SSEDescription' => [
'InaccessibleEncryptionDateTime' => <DateTime>,
'KMSMasterKeyArn' => '<string>',
'SSEType' => 'AES256|KMS',
'Status' => 'ENABLING|ENABLED|DISABLING|DISABLED|UPDATING',
],
'StreamSpecification' => [
'StreamEnabled' => true || false,
'StreamViewType' => 'NEW_IMAGE|OLD_IMAGE|NEW_AND_OLD_IMAGES|KEYS_ONLY',
],
'TableArn' => '<string>',
'TableClassSummary' => [
'LastUpdateDateTime' => <DateTime>,
'TableClass' => 'STANDARD|STANDARD_INFREQUENT_ACCESS',
],
'TableId' => '<string>',
'TableName' => '<string>',
'TableSizeBytes' => <integer>,
'TableStatus' => 'CREATING|UPDATING|DELETING|ACTIVE|INACCESSIBLE_ENCRYPTION_CREDENTIALS|ARCHIVING|ARCHIVED|REPLICATION_NOT_AUTHORIZED',
'WarmThroughput' => [
'ReadUnitsPerSecond' => <integer>,
'Status' => 'CREATING|UPDATING|DELETING|ACTIVE|INACCESSIBLE_ENCRYPTION_CREDENTIALS|ARCHIVING|ARCHIVED|REPLICATION_NOT_AUTHORIZED',
'WriteUnitsPerSecond' => <integer>,
],
],
]Result Details Members
The properties of the table.
The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be ACTIVE.
An error occurred on the server side.
This example describes the Music table.
$result = $client->describeTable([
'TableName' => 'Music',
]);
Result syntax:
[
'Table' => [
'AttributeDefinitions' => [
[
'AttributeName' => 'Artist',
'AttributeType' => 'S',
],
[
'AttributeName' => 'SongTitle',
'AttributeType' => 'S',
],
],
'CreationDateTime' => ,
'ItemCount' => 0,
'KeySchema' => [
[
'AttributeName' => 'Artist',
'KeyType' => 'HASH',
],
[
'AttributeName' => 'SongTitle',
'KeyType' => 'RANGE',
],
],
'ProvisionedThroughput' => [
'NumberOfDecreasesToday' => 1,
'ReadCapacityUnits' => 5,
'WriteCapacityUnits' => 5,
],
'TableName' => 'Music',
'TableSizeBytes' => 0,
'TableStatus' => 'ACTIVE',
],
] DescribeTableReplicaAutoScaling
$result = $client->describeTableReplicaAutoScaling([/* ... */]); $promise = $client->describeTableReplicaAutoScalingAsync([/* ... */]);
Describes auto scaling settings across replicas of the global table at once.
Parameter Syntax$result = $client->describeTableReplicaAutoScaling([
'TableName' => '<string>', // REQUIRED
]);
Parameter Details Members
The name of the table. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.
[
'TableAutoScalingDescription' => [
'Replicas' => [
[
'GlobalSecondaryIndexes' => [
[
'IndexName' => '<string>',
'IndexStatus' => 'CREATING|UPDATING|DELETING|ACTIVE',
'ProvisionedReadCapacityAutoScalingSettings' => [
'AutoScalingDisabled' => true || false,
'AutoScalingRoleArn' => '<string>',
'MaximumUnits' => <integer>,
'MinimumUnits' => <integer>,
'ScalingPolicies' => [
[
'PolicyName' => '<string>',
'TargetTrackingScalingPolicyConfiguration' => [
'DisableScaleIn' => true || false,
'ScaleInCooldown' => <integer>,
'ScaleOutCooldown' => <integer>,
'TargetValue' => <float>,
],
],
// ...
],
],
'ProvisionedWriteCapacityAutoScalingSettings' => [
'AutoScalingDisabled' => true || false,
'AutoScalingRoleArn' => '<string>',
'MaximumUnits' => <integer>,
'MinimumUnits' => <integer>,
'ScalingPolicies' => [
[
'PolicyName' => '<string>',
'TargetTrackingScalingPolicyConfiguration' => [
'DisableScaleIn' => true || false,
'ScaleInCooldown' => <integer>,
'ScaleOutCooldown' => <integer>,
'TargetValue' => <float>,
],
],
// ...
],
],
],
// ...
],
'RegionName' => '<string>',
'ReplicaProvisionedReadCapacityAutoScalingSettings' => [
'AutoScalingDisabled' => true || false,
'AutoScalingRoleArn' => '<string>',
'MaximumUnits' => <integer>,
'MinimumUnits' => <integer>,
'ScalingPolicies' => [
[
'PolicyName' => '<string>',
'TargetTrackingScalingPolicyConfiguration' => [
'DisableScaleIn' => true || false,
'ScaleInCooldown' => <integer>,
'ScaleOutCooldown' => <integer>,
'TargetValue' => <float>,
],
],
// ...
],
],
'ReplicaProvisionedWriteCapacityAutoScalingSettings' => [
'AutoScalingDisabled' => true || false,
'AutoScalingRoleArn' => '<string>',
'MaximumUnits' => <integer>,
'MinimumUnits' => <integer>,
'ScalingPolicies' => [
[
'PolicyName' => '<string>',
'TargetTrackingScalingPolicyConfiguration' => [
'DisableScaleIn' => true || false,
'ScaleInCooldown' => <integer>,
'ScaleOutCooldown' => <integer>,
'TargetValue' => <float>,
],
],
// ...
],
],
'ReplicaStatus' => 'CREATING|CREATION_FAILED|UPDATING|DELETING|ACTIVE|REGION_DISABLED|INACCESSIBLE_ENCRYPTION_CREDENTIALS|ARCHIVING|ARCHIVED|REPLICATION_NOT_AUTHORIZED',
],
// ...
],
'TableName' => '<string>',
'TableStatus' => 'CREATING|UPDATING|DELETING|ACTIVE|INACCESSIBLE_ENCRYPTION_CREDENTIALS|ARCHIVING|ARCHIVED|REPLICATION_NOT_AUTHORIZED',
],
]Result Details Members
Represents the auto scaling properties of the table.
The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be ACTIVE.
An error occurred on the server side.
$result = $client->describeTimeToLive([/* ... */]); $promise = $client->describeTimeToLiveAsync([/* ... */]);
Gives a description of the Time to Live (TTL) status on the specified table.
Parameter Syntax$result = $client->describeTimeToLive([
'TableName' => '<string>', // REQUIRED
]);
Parameter Details Members
The name of the table to be described. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.
[
'TimeToLiveDescription' => [
'AttributeName' => '<string>',
'TimeToLiveStatus' => 'ENABLING|DISABLING|ENABLED|DISABLED',
],
]Result Details Members
The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be ACTIVE.
An error occurred on the server side.
$result = $client->disableKinesisStreamingDestination([/* ... */]); $promise = $client->disableKinesisStreamingDestinationAsync([/* ... */]);
Stops replication from the DynamoDB table to the Kinesis data stream. This is done without deleting either of the resources.
Parameter Syntax$result = $client->disableKinesisStreamingDestination([
'EnableKinesisStreamingConfiguration' => [
'ApproximateCreationDateTimePrecision' => 'MILLISECOND|MICROSECOND',
],
'StreamArn' => '<string>', // REQUIRED
'TableName' => '<string>', // REQUIRED
]);
Parameter Details Members
The source for the Kinesis streaming information that is being enabled.
The ARN for a Kinesis data stream.
The name of the DynamoDB table. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.
[
'DestinationStatus' => 'ENABLING|ACTIVE|DISABLING|DISABLED|ENABLE_FAILED|UPDATING',
'EnableKinesisStreamingConfiguration' => [
'ApproximateCreationDateTimePrecision' => 'MILLISECOND|MICROSECOND',
],
'StreamArn' => '<string>',
'TableName' => '<string>',
]Result Details Members
The current status of the replication.
The destination for the Kinesis streaming information that is being enabled.
The ARN for the specific Kinesis data stream.
The name of the table being modified.
An error occurred on the server side.
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.
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.
The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be ACTIVE.
$result = $client->enableKinesisStreamingDestination([/* ... */]); $promise = $client->enableKinesisStreamingDestinationAsync([/* ... */]);
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.
Parameter Syntax$result = $client->enableKinesisStreamingDestination([
'EnableKinesisStreamingConfiguration' => [
'ApproximateCreationDateTimePrecision' => 'MILLISECOND|MICROSECOND',
],
'StreamArn' => '<string>', // REQUIRED
'TableName' => '<string>', // REQUIRED
]);
Parameter Details Members
The source for the Kinesis streaming information that is being enabled.
The ARN for a Kinesis data stream.
The name of the DynamoDB table. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.
[
'DestinationStatus' => 'ENABLING|ACTIVE|DISABLING|DISABLED|ENABLE_FAILED|UPDATING',
'EnableKinesisStreamingConfiguration' => [
'ApproximateCreationDateTimePrecision' => 'MILLISECOND|MICROSECOND',
],
'StreamArn' => '<string>',
'TableName' => '<string>',
]Result Details Members
The current status of the replication.
The destination for the Kinesis streaming information that is being enabled.
The ARN for the specific Kinesis data stream.
The name of the table being modified.
An error occurred on the server side.
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.
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.
The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be ACTIVE.
$result = $client->executeStatement([/* ... */]); $promise = $client->executeStatementAsync([/* ... */]);
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.
$result = $client->executeStatement([
'ConsistentRead' => true || false,
'Limit' => <integer>,
'NextToken' => '<string>',
'Parameters' => [
[
'B' => <string || resource || Psr\Http\Message\StreamInterface>,
'BOOL' => true || false,
'BS' => [<string || resource || Psr\Http\Message\StreamInterface>, ...],
'L' => [
[...], // RECURSIVE
// ...
],
'M' => [
'<AttributeName>' => [...], // RECURSIVE
// ...
],
'N' => '<string>',
'NS' => ['<string>', ...],
'NULL' => true || false,
'S' => '<string>',
'SS' => ['<string>', ...],
],
// ...
],
'ReturnConsumedCapacity' => 'INDEXES|TOTAL|NONE',
'ReturnValuesOnConditionCheckFailure' => 'ALL_OLD|NONE',
'Statement' => '<string>', // REQUIRED
]);
Parameter Details Members
The consistency of a read operation. If set to true, then a strongly consistent read is used; otherwise, an eventually consistent read is used.
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.
Set this value to get remaining results, if NextToken was returned in the statement response.
The parameters for the PartiQL statement, if any.
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.
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.
The PartiQL statement representing the operation to run.
[
'ConsumedCapacity' => [
'CapacityUnits' => <float>,
'GlobalSecondaryIndexes' => [
'<IndexName>' => [
'CapacityUnits' => <float>,
'ReadCapacityUnits' => <float>,
'WriteCapacityUnits' => <float>,
],
// ...
],
'LocalSecondaryIndexes' => [
'<IndexName>' => [
'CapacityUnits' => <float>,
'ReadCapacityUnits' => <float>,
'WriteCapacityUnits' => <float>,
],
// ...
],
'ReadCapacityUnits' => <float>,
'Table' => [
'CapacityUnits' => <float>,
'ReadCapacityUnits' => <float>,
'WriteCapacityUnits' => <float>,
],
'TableName' => '<string>',
'WriteCapacityUnits' => <float>,
],
'Items' => [
[
'<AttributeName>' => [
'B' => <string || resource || Psr\Http\Message\StreamInterface>,
'BOOL' => true || false,
'BS' => [<string || resource || Psr\Http\Message\StreamInterface>, ...],
'L' => [
[...], // RECURSIVE
// ...
],
'M' => [
'<AttributeName>' => [...], // RECURSIVE
// ...
],
'N' => '<string>',
'NS' => ['<string>', ...],
'NULL' => true || false,
'S' => '<string>',
'SS' => ['<string>', ...],
],
// ...
],
// ...
],
'LastEvaluatedKey' => [
'<AttributeName>' => [
'B' => <string || resource || Psr\Http\Message\StreamInterface>,
'BOOL' => true || false,
'BS' => [<string || resource || Psr\Http\Message\StreamInterface>, ...],
'L' => [
[...], // RECURSIVE
// ...
],
'M' => [
'<AttributeName>' => [...], // RECURSIVE
// ...
],
'N' => '<string>',
'NS' => ['<string>', ...],
'NULL' => true || false,
'S' => '<string>',
'SS' => ['<string>', ...],
],
// ...
],
'NextToken' => '<string>',
]Result Details Members
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 in the Amazon DynamoDB Developer Guide.
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.
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.
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.
A condition specified in the operation failed to be evaluated.
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 field in the returned exception. The Amazon Web Services 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 in the Amazon DynamoDB Developer Guide.
The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be ACTIVE.
An item collection is too large. This exception is only returned for tables that have one or more local secondary indexes.
Operation was rejected because there is an ongoing transaction for the item.
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 field in the returned exception. Contact Amazon Web ServicesSupport to request a quota increase.
An error occurred on the server side.
There was an attempt to insert an item with the same primary key as an item that already exists in the DynamoDB table.
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 field in the returned exception.
$result = $client->executeTransaction([/* ... */]); $promise = $client->executeTransactionAsync([/* ... */]);
This operation allows you to perform transactional reads or writes on data stored in DynamoDB, using PartiQL.
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 API.
$result = $client->executeTransaction([
'ClientRequestToken' => '<string>',
'ReturnConsumedCapacity' => 'INDEXES|TOTAL|NONE',
'TransactStatements' => [ // REQUIRED
[
'Parameters' => [
[
'B' => <string || resource || Psr\Http\Message\StreamInterface>,
'BOOL' => true || false,
'BS' => [<string || resource || Psr\Http\Message\StreamInterface>, ...],
'L' => [
[...], // RECURSIVE
// ...
],
'M' => [
'<AttributeName>' => [...], // RECURSIVE
// ...
],
'N' => '<string>',
'NS' => ['<string>', ...],
'NULL' => true || false,
'S' => '<string>',
'SS' => ['<string>', ...],
],
// ...
],
'ReturnValuesOnConditionCheckFailure' => 'ALL_OLD|NONE',
'Statement' => '<string>', // REQUIRED
],
// ...
],
]);
Parameter Details Members
Set this value to get remaining results, if NextToken was returned in the statement response.
Determines the level of detail about either provisioned or on-demand throughput consumption that is returned in the response. For more information, see TransactGetItems and TransactWriteItems.
The list of PartiQL statements representing the transaction to run.
[
'ConsumedCapacity' => [
[
'CapacityUnits' => <float>,
'GlobalSecondaryIndexes' => [
'<IndexName>' => [
'CapacityUnits' => <float>,
'ReadCapacityUnits' => <float>,
'WriteCapacityUnits' => <float>,
],
// ...
],
'LocalSecondaryIndexes' => [
'<IndexName>' => [
'CapacityUnits' => <float>,
'ReadCapacityUnits' => <float>,
'WriteCapacityUnits' => <float>,
],
// ...
],
'ReadCapacityUnits' => <float>,
'Table' => [
'CapacityUnits' => <float>,
'ReadCapacityUnits' => <float>,
'WriteCapacityUnits' => <float>,
],
'TableName' => '<string>',
'WriteCapacityUnits' => <float>,
],
// ...
],
'Responses' => [
[
'Item' => [
'<AttributeName>' => [
'B' => <string || resource || Psr\Http\Message\StreamInterface>,
'BOOL' => true || false,
'BS' => [<string || resource || Psr\Http\Message\StreamInterface>, ...],
'L' => [
[...], // RECURSIVE
// ...
],
'M' => [
'<AttributeName>' => [...], // RECURSIVE
// ...
],
'N' => '<string>',
'NS' => ['<string>', ...],
'NULL' => true || false,
'S' => '<string>',
'SS' => ['<string>', ...],
],
// ...
],
],
// ...
],
]Result Details Members
The capacity units consumed by the entire operation. The values of the list are ordered according to the ordering of the statements.
The response to a PartiQL transaction.
The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be ACTIVE.
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.
If using Java, DynamoDB lists the cancellation reasons on the CancellationReasons property. This property is not set for other languages. 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.
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.
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.
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.
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.
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, 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 * 2, exponential backoff)
3500-4500 third attempt
4500-6500 third sleep/delay (500 * 2^2)
6500-7500 fourth attempt (this can trigger inline recovery since 5 seconds have elapsed since the first attempt reached TC)
DynamoDB rejected the request because you retried a request with a different payload but with an idempotent token that was already used.
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 field in the returned exception. The Amazon Web Services 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 in the Amazon DynamoDB Developer Guide.
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 field in the returned exception. Contact Amazon Web ServicesSupport to request a quota increase.
An error occurred on the server side.
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 field in the returned exception.
$result = $client->exportTableToPointInTime([/* ... */]); $promise = $client->exportTableToPointInTimeAsync([/* ... */]);
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.
Parameter Syntax$result = $client->exportTableToPointInTime([
'ClientToken' => '<string>',
'ExportFormat' => 'DYNAMODB_JSON|ION',
'ExportTime' => <integer || string || DateTime>,
'ExportType' => 'FULL_EXPORT|INCREMENTAL_EXPORT',
'IncrementalExportSpecification' => [
'ExportFromTime' => <integer || string || DateTime>,
'ExportToTime' => <integer || string || DateTime>,
'ExportViewType' => 'NEW_IMAGE|NEW_AND_OLD_IMAGES',
],
'S3Bucket' => '<string>', // REQUIRED
'S3BucketOwner' => '<string>',
'S3Prefix' => '<string>',
'S3SseAlgorithm' => 'AES256|KMS',
'S3SseKmsKeyId' => '<string>',
'TableArn' => '<string>', // REQUIRED
]);
Parameter Details Members
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 ImportConflictException.
The format for the exported data. Valid values for ExportFormat are DYNAMODB_JSON or ION.
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.
Choice of whether to execute as a full export or incremental export. Valid values are FULL_EXPORT or INCREMENTAL_EXPORT. The default value is FULL_EXPORT. If INCREMENTAL_EXPORT is provided, the IncrementalExportSpecification must also be used.
Optional object containing the parameters specific to an incremental export.
The name of the Amazon S3 bucket to export the snapshot to.
The ID of the Amazon Web Services 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.
The Amazon S3 bucket prefix to use as the file name and path of the exported snapshot.
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 KMS managed keys
The ID of the KMS managed key used to encrypt the S3 bucket where export data will be stored (if applicable).
The Amazon Resource Name (ARN) associated with the table to export.
[
'ExportDescription' => [
'BilledSizeBytes' => <integer>,
'ClientToken' => '<string>',
'EndTime' => <DateTime>,
'ExportArn' => '<string>',
'ExportFormat' => 'DYNAMODB_JSON|ION',
'ExportManifest' => '<string>',
'ExportStatus' => 'IN_PROGRESS|COMPLETED|FAILED',
'ExportTime' => <DateTime>,
'ExportType' => 'FULL_EXPORT|INCREMENTAL_EXPORT',
'FailureCode' => '<string>',
'FailureMessage' => '<string>',
'IncrementalExportSpecification' => [
'ExportFromTime' => <DateTime>,
'ExportToTime' => <DateTime>,
'ExportViewType' => 'NEW_IMAGE|NEW_AND_OLD_IMAGES',
],
'ItemCount' => <integer>,
'S3Bucket' => '<string>',
'S3BucketOwner' => '<string>',
'S3Prefix' => '<string>',
'S3SseAlgorithm' => 'AES256|KMS',
'S3SseKmsKeyId' => '<string>',
'StartTime' => <DateTime>,
'TableArn' => '<string>',
'TableId' => '<string>',
],
]Result Details Members
Contains a description of the table export.
A source table with the name TableName does not currently exist within the subscriber's account or the subscriber is operating in the wrong Amazon Web Services Region.
Point in time recovery has not yet been enabled for this source table.
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.
The specified ExportTime is outside of the point in time recovery window.
There was a conflict when writing to the specified S3 bucket.
An error occurred on the server side.
$result = $client->getItem([/* ... */]); $promise = $client->getItemAsync([/* ... */]);
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.
$result = $client->getItem([
'AttributesToGet' => ['<string>', ...],
'ConsistentRead' => true || false,
'ExpressionAttributeNames' => ['<string>', ...],
'Key' => [ // REQUIRED
'<AttributeName>' => [
'B' => <string || resource || Psr\Http\Message\StreamInterface>,
'BOOL' => true || false,
'BS' => [<string || resource || Psr\Http\Message\StreamInterface>, ...],
'L' => [
[...], // RECURSIVE
// ...
],
'M' => [
'<AttributeName>' => [...], // RECURSIVE
// ...
],
'N' => '<string>',
'NS' => ['<string>', ...],
'NULL' => true || false,
'S' => '<string>',
'SS' => ['<string>', ...],
],
// ...
],
'ProjectionExpression' => '<string>',
'ReturnConsumedCapacity' => 'INDEXES|TOTAL|NONE',
'TableName' => '<string>', // REQUIRED
]);
Parameter Details Members
This is a legacy parameter. Use ProjectionExpression instead. For more information, see AttributesToGet in the Amazon DynamoDB Developer Guide.
Determines the read consistency model: If set to true, then the operation uses strongly consistent reads; otherwise, the operation uses eventually consistent reads.
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 # 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 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 in the Amazon DynamoDB Developer Guide.
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.
A string that identifies one or more attributes to retrieve from the table. These attributes can include scalars, sets, or elements of a JSON document. The attributes in the expression must be separated by commas.
If no attribute names are specified, then all attributes are returned. If any of the requested attributes are not found, they do not appear in the result.
For more information, see Specifying Item Attributes in the Amazon DynamoDB Developer Guide.
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.
The name of the table containing the requested item. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.
[
'ConsumedCapacity' => [
'CapacityUnits' => <float>,
'GlobalSecondaryIndexes' => [
'<IndexName>' => [
'CapacityUnits' => <float>,
'ReadCapacityUnits' => <float>,
'WriteCapacityUnits' => <float>,
],
// ...
],
'LocalSecondaryIndexes' => [
'<IndexName>' => [
'CapacityUnits' => <float>,
'ReadCapacityUnits' => <float>,
'WriteCapacityUnits' => <float>,
],
// ...
],
'ReadCapacityUnits' => <float>,
'Table' => [
'CapacityUnits' => <float>,
'ReadCapacityUnits' => <float>,
'WriteCapacityUnits' => <float>,
],
'TableName' => '<string>',
'WriteCapacityUnits' => <float>,
],
'Item' => [
'<AttributeName>' => [
'B' => <string || resource || Psr\Http\Message\StreamInterface>,
'BOOL' => true || false,
'BS' => [<string || resource || Psr\Http\Message\StreamInterface>, ...],
'L' => [
[...], // RECURSIVE
// ...
],
'M' => [
'<AttributeName>' => [...], // RECURSIVE
// ...
],
'N' => '<string>',
'NS' => ['<string>', ...],
'NULL' => true || false,
'S' => '<string>',
'SS' => ['<string>', ...],
],
// ...
],
]Result Details Members
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 in the Amazon DynamoDB Developer Guide.
A map of attribute names to AttributeValue objects, as specified by ProjectionExpression.
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 field in the returned exception. The Amazon Web Services 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 in the Amazon DynamoDB Developer Guide.
The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be ACTIVE.
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 field in the returned exception. Contact Amazon Web ServicesSupport to request a quota increase.
An error occurred on the server side.
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 field in the returned exception.
This example retrieves an item from the Music table. The table has a partition key and a sort key (Artist and SongTitle), so you must specify both of these attributes.
$result = $client->getItem([
'Key' => [
'Artist' => [
'S' => 'Acme Band',
],
'SongTitle' => [
'S' => 'Happy Day',
],
],
'TableName' => 'Music',
]);
Result syntax:
[
'Item' => [
'AlbumTitle' => [
'S' => 'Songs About Life',
],
'Artist' => [
'S' => 'Acme Band',
],
'SongTitle' => [
'S' => 'Happy Day',
],
],
] GetResourcePolicy
$result = $client->getResourcePolicy([/* ... */]); $promise = $client->getResourcePolicyAsync([/* ... */]);
Returns the resource-based policy document attached to the resource, which can be a table or stream, in JSON format.
GetResourcePolicy follows an eventually consistent 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 GetResourcePolicyrequest 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.
$result = $client->getResourcePolicy([
'ResourceArn' => '<string>', // REQUIRED
]);
Parameter Details Members
The Amazon Resource Name (ARN) of the DynamoDB resource to which the policy is attached. The resources you can specify include tables and streams.
[
'Policy' => '<string>',
'RevisionId' => '<string>',
]Result Details Members
The resource-based policy document attached to the resource, which can be a table or stream, in JSON format.
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.
The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be ACTIVE.
An error occurred on the server side.
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.
$result = $client->importTable([/* ... */]); $promise = $client->importTableAsync([/* ... */]);
Imports table data from an S3 bucket.
Parameter Syntax$result = $client->importTable([
'ClientToken' => '<string>',
'InputCompressionType' => 'GZIP|ZSTD|NONE',
'InputFormat' => 'DYNAMODB_JSON|ION|CSV', // REQUIRED
'InputFormatOptions' => [
'Csv' => [
'Delimiter' => '<string>',
'HeaderList' => ['<string>', ...],
],
],
'S3BucketSource' => [ // REQUIRED
'S3Bucket' => '<string>', // REQUIRED
'S3BucketOwner' => '<string>',
'S3KeyPrefix' => '<string>',
],
'TableCreationParameters' => [ // REQUIRED
'AttributeDefinitions' => [ // REQUIRED
[
'AttributeName' => '<string>', // REQUIRED
'AttributeType' => 'S|N|B', // REQUIRED
],
// ...
],
'BillingMode' => 'PROVISIONED|PAY_PER_REQUEST',
'GlobalSecondaryIndexes' => [
[
'IndexName' => '<string>', // REQUIRED
'KeySchema' => [ // REQUIRED
[
'AttributeName' => '<string>', // REQUIRED
'KeyType' => 'HASH|RANGE', // REQUIRED
],
// ...
],
'OnDemandThroughput' => [
'MaxReadRequestUnits' => <integer>,
'MaxWriteRequestUnits' => <integer>,
],
'Projection' => [ // REQUIRED
'NonKeyAttributes' => ['<string>', ...],
'ProjectionType' => 'ALL|KEYS_ONLY|INCLUDE',
],
'ProvisionedThroughput' => [
'ReadCapacityUnits' => <integer>, // REQUIRED
'WriteCapacityUnits' => <integer>, // REQUIRED
],
'WarmThroughput' => [
'ReadUnitsPerSecond' => <integer>,
'WriteUnitsPerSecond' => <integer>,
],
],
// ...
],
'KeySchema' => [ // REQUIRED
[
'AttributeName' => '<string>', // REQUIRED
'KeyType' => 'HASH|RANGE', // REQUIRED
],
// ...
],
'OnDemandThroughput' => [
'MaxReadRequestUnits' => <integer>,
'MaxWriteRequestUnits' => <integer>,
],
'ProvisionedThroughput' => [
'ReadCapacityUnits' => <integer>, // REQUIRED
'WriteCapacityUnits' => <integer>, // REQUIRED
],
'SSESpecification' => [
'Enabled' => true || false,
'KMSMasterKeyId' => '<string>',
'SSEType' => 'AES256|KMS',
],
'TableName' => '<string>', // REQUIRED
],
]);
Parameter Details Members
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 of compression to be used on the input coming from the imported table.
The format of the source data. Valid values for ImportFormat are CSV, DYNAMODB_JSON or ION.
Additional properties that specify how the input is formatted,
The S3 bucket that provides the source for the import.
Parameters for the table to import the data into.
[
'ImportTableDescription' => [
'ClientToken' => '<string>',
'CloudWatchLogGroupArn' => '<string>',
'EndTime' => <DateTime>,
'ErrorCount' => <integer>,
'FailureCode' => '<string>',
'FailureMessage' => '<string>',
'ImportArn' => '<string>',
'ImportStatus' => 'IN_PROGRESS|COMPLETED|CANCELLING|CANCELLED|FAILED',
'ImportedItemCount' => <integer>,
'InputCompressionType' => 'GZIP|ZSTD|NONE',
'InputFormat' => 'DYNAMODB_JSON|ION|CSV',
'InputFormatOptions' => [
'Csv' => [
'Delimiter' => '<string>',
'HeaderList' => ['<string>', ...],
],
],
'ProcessedItemCount' => <integer>,
'ProcessedSizeBytes' => <integer>,
'S3BucketSource' => [
'S3Bucket' => '<string>',
'S3BucketOwner' => '<string>',
'S3KeyPrefix' => '<string>',
],
'StartTime' => <DateTime>,
'TableArn' => '<string>',
'TableCreationParameters' => [
'AttributeDefinitions' => [
[
'AttributeName' => '<string>',
'AttributeType' => 'S|N|B',
],
// ...
],
'BillingMode' => 'PROVISIONED|PAY_PER_REQUEST',
'GlobalSecondaryIndexes' => [
[
'IndexName' => '<string>',
'KeySchema' => [
[
'AttributeName' => '<string>',
'KeyType' => 'HASH|RANGE',
],
// ...
],
'OnDemandThroughput' => [
'MaxReadRequestUnits' => <integer>,
'MaxWriteRequestUnits' => <integer>,
],
'Projection' => [
'NonKeyAttributes' => ['<string>', ...],
'ProjectionType' => 'ALL|KEYS_ONLY|INCLUDE',
],
'ProvisionedThroughput' => [
'ReadCapacityUnits' => <integer>,
'WriteCapacityUnits' => <integer>,
],
'WarmThroughput' => [
'ReadUnitsPerSecond' => <integer>,
'WriteUnitsPerSecond' => <integer>,
],
],
// ...
],
'KeySchema' => [
[
'AttributeName' => '<string>',
'KeyType' => 'HASH|RANGE',
],
// ...
],
'OnDemandThroughput' => [
'MaxReadRequestUnits' => <integer>,
'MaxWriteRequestUnits' => <integer>,
],
'ProvisionedThroughput' => [
'ReadCapacityUnits' => <integer>,
'WriteCapacityUnits' => <integer>,
],
'SSESpecification' => [
'Enabled' => true || false,
'KMSMasterKeyId' => '<string>',
'SSEType' => 'AES256|KMS',
],
'TableName' => '<string>',
],
'TableId' => '<string>',
],
]Result Details Members
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.
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.
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.
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.
$result = $client->listBackups([/* ... */]); $promise = $client->listBackupsAsync([/* ... */]);
List DynamoDB backups that are associated with an Amazon Web Services account and weren't made with Amazon Web Services 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 Amazon Web Services Backup, use the Amazon Web Services Backup list API.
Parameter Syntax$result = $client->listBackups([
'BackupType' => 'USER|SYSTEM|AWS_BACKUP|ALL',
'ExclusiveStartBackupArn' => '<string>',
'Limit' => <integer>,
'TableName' => '<string>',
'TimeRangeLowerBound' => <integer || string || DateTime>,
'TimeRangeUpperBound' => <integer || string || DateTime>,
]);
Parameter Details Members
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).
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.
Maximum number of backups to return at once.
Lists the backups from the table specified in TableName. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.
Only backups created after this time are listed. TimeRangeLowerBound is inclusive.
Only backups created before this time are listed. TimeRangeUpperBound is exclusive.
[
'BackupSummaries' => [
[
'BackupArn' => '<string>',
'BackupCreationDateTime' => <DateTime>,
'BackupExpiryDateTime' => <DateTime>,
'BackupName' => '<string>',
'BackupSizeBytes' => <integer>,
'BackupStatus' => 'CREATING|DELETED|AVAILABLE',
'BackupType' => 'USER|SYSTEM|AWS_BACKUP',
'TableArn' => '<string>',
'TableId' => '<string>',
'TableName' => '<string>',
],
// ...
],
'LastEvaluatedBackupArn' => '<string>',
]Result Details Members
List of BackupSummary objects.
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.
An error occurred on the server side.
$result = $client->listContributorInsights([/* ... */]); $promise = $client->listContributorInsightsAsync([/* ... */]);
Returns a list of ContributorInsightsSummary for a table and all its global secondary indexes.
Parameter Syntax$result = $client->listContributorInsights([
'MaxResults' => <integer>,
'NextToken' => '<string>',
'TableName' => '<string>',
]);
Parameter Details Members
Maximum number of results to return per page.
A token to for the desired page, if there is one.
The name of the table. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.
[
'ContributorInsightsSummaries' => [
[
'ContributorInsightsMode' => 'ACCESSED_AND_THROTTLED_KEYS|THROTTLED_KEYS',
'ContributorInsightsStatus' => 'ENABLING|ENABLED|DISABLING|DISABLED|FAILED',
'IndexName' => '<string>',
'TableName' => '<string>',
],
// ...
],
'NextToken' => '<string>',
]Result Details Members
A list of ContributorInsightsSummary.
A token to go to the next page if there is one.
The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be ACTIVE.
An error occurred on the server side.
$result = $client->listExports([/* ... */]); $promise = $client->listExportsAsync([/* ... */]);
Lists completed exports within the past 90 days.
Parameter Syntax$result = $client->listExports([
'MaxResults' => <integer>,
'NextToken' => '<string>',
'TableArn' => '<string>',
]);
Parameter Details Members
Maximum number of results to return per page.
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.
The Amazon Resource Name (ARN) associated with the exported table.
[
'ExportSummaries' => [
[
'ExportArn' => '<string>',
'ExportStatus' => 'IN_PROGRESS|COMPLETED|FAILED',
'ExportType' => 'FULL_EXPORT|INCREMENTAL_EXPORT',
],
// ...
],
'NextToken' => '<string>',
]Result Details Members
A list of ExportSummary objects.
If this value is returned, there are additional results to be displayed. To retrieve them, call ListExports again, with NextToken set to this value.
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.
An error occurred on the server side.
$result = $client->listGlobalTables([/* ... */]); $promise = $client->listGlobalTablesAsync([/* ... */]);
Lists all global tables that have a replica in the specified Region.
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) 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. To update existing global tables from version 2017.11.29 (Legacy) to version 2019.11.21 (Current), see Upgrading global tables.
Parameter Syntax$result = $client->listGlobalTables([
'ExclusiveStartGlobalTableName' => '<string>',
'Limit' => <integer>,
'RegionName' => '<string>',
]);
Parameter Details Members
The first global table name that this operation will evaluate.
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.
Lists the global tables in a specific Region.
[
'GlobalTables' => [
[
'GlobalTableName' => '<string>',
'ReplicationGroup' => [
[
'RegionName' => '<string>',
],
// ...
],
],
// ...
],
'LastEvaluatedGlobalTableName' => '<string>',
]Result Details Members
List of global table names.
Last evaluated global table name.
An error occurred on the server side.
$result = $client->listImports([/* ... */]); $promise = $client->listImportsAsync([/* ... */]);
Lists completed imports within the past 90 days.
Parameter Syntax$result = $client->listImports([
'NextToken' => '<string>',
'PageSize' => <integer>,
'TableArn' => '<string>',
]);
Parameter Details Members
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.
The number of ImportSummary objects returned in a single page.
The Amazon Resource Name (ARN) associated with the table that was imported to.
[
'ImportSummaryList' => [
[
'CloudWatchLogGroupArn' => '<string>',
'EndTime' => <DateTime>,
'ImportArn' => '<string>',
'ImportStatus' => 'IN_PROGRESS|COMPLETED|CANCELLING|CANCELLED|FAILED',
'InputFormat' => 'DYNAMODB_JSON|ION|CSV',
'S3BucketSource' => [
'S3Bucket' => '<string>',
'S3BucketOwner' => '<string>',
'S3KeyPrefix' => '<string>',
],
'StartTime' => <DateTime>,
'TableArn' => '<string>',
],
// ...
],
'NextToken' => '<string>',
]Result Details Members
A list of ImportSummary objects.
If this value is returned, there are additional results to be displayed. To retrieve them, call ListImports again, with NextToken set to this value.
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.
$result = $client->listTables([/* ... */]); $promise = $client->listTablesAsync([/* ... */]);
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.
$result = $client->listTables([
'ExclusiveStartTableName' => '<string>',
'Limit' => <integer>,
]);
Parameter Details Members
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.
A maximum number of table names to return. If this parameter is not specified, the limit is 100.
[
'LastEvaluatedTableName' => '<string>',
'TableNames' => ['<string>', ...],
]Result Details Members
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.
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.
An error occurred on the server side.
This example lists all of the tables associated with the current AWS account and endpoint.
$result = $client->listTables([ ]);
Result syntax:
[
'TableNames' => [
'Forum',
'ProductCatalog',
'Reply',
'Thread',
],
] ListTagsOfResource
$result = $client->listTagsOfResource([/* ... */]); $promise = $client->listTagsOfResourceAsync([/* ... */]);
List all tags on an Amazon DynamoDB resource. You can call ListTagsOfResource up to 10 times per second, per account.
For an overview on tagging DynamoDB resources, see Tagging for DynamoDB in the Amazon DynamoDB Developer Guide.
Parameter Syntax$result = $client->listTagsOfResource([
'NextToken' => '<string>',
'ResourceArn' => '<string>', // REQUIRED
]);
Parameter Details Members
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.
The Amazon DynamoDB resource with tags to be listed. This value is an Amazon Resource Name (ARN).
[
'NextToken' => '<string>',
'Tags' => [
[
'Key' => '<string>',
'Value' => '<string>',
],
// ...
],
]Result Details Members
If this value is returned, there are additional results to be displayed. To retrieve them, call ListTagsOfResource again, with NextToken set to this value.
The tags currently associated with the Amazon DynamoDB resource.
The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be ACTIVE.
An error occurred on the server side.
$result = $client->putItem([/* ... */]); $promise = $client->putItemAsync([/* ... */]);
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.
To prevent a new item from replacing an existing item, use a conditional expression that contains the attribute_not_exists function with the name of the attribute being used as the partition key for the table. Since every record must contain that attribute, the attribute_not_exists function will only succeed if no matching item exists.
For more information about PutItem, see Working with Items in the Amazon DynamoDB Developer Guide.
$result = $client->putItem([
'ConditionExpression' => '<string>',
'ConditionalOperator' => 'AND|OR',
'Expected' => [
'<AttributeName>' => [
'AttributeValueList' => [
[
'B' => <string || resource || Psr\Http\Message\StreamInterface>,
'BOOL' => true || false,
'BS' => [<string || resource || Psr\Http\Message\StreamInterface>, ...],
'L' => [
[...], // RECURSIVE
// ...
],
'M' => [
'<AttributeName>' => [...], // RECURSIVE
// ...
],
'N' => '<string>',
'NS' => ['<string>', ...],
'NULL' => true || false,
'S' => '<string>',
'SS' => ['<string>', ...],
],
// ...
],
'ComparisonOperator' => 'EQ|NE|IN|LE|LT|GE|GT|BETWEEN|NOT_NULL|NULL|CONTAINS|NOT_CONTAINS|BEGINS_WITH',
'Exists' => true || false,
'Value' => [
'B' => <string || resource || Psr\Http\Message\StreamInterface>,
'BOOL' => true || false,
'BS' => [<string || resource || Psr\Http\Message\StreamInterface>, ...],
'L' => [
[...], // RECURSIVE
// ...
],
'M' => [
'<AttributeName>' => [...], // RECURSIVE
// ...
],
'N' => '<string>',
'NS' => ['<string>', ...],
'NULL' => true || false,
'S' => '<string>',
'SS' => ['<string>', ...],
],
],
// ...
],
'ExpressionAttributeNames' => ['<string>', ...],
'ExpressionAttributeValues' => [
'<ExpressionAttributeValueVariable>' => [
'B' => <string || resource || Psr\Http\Message\StreamInterface>,
'BOOL' => true || false,
'BS' => [<string || resource || Psr\Http\Message\StreamInterface>, ...],
'L' => [
[...], // RECURSIVE
// ...
],
'M' => [
'<AttributeName>' => [...], // RECURSIVE
// ...
],
'N' => '<string>',
'NS' => ['<string>', ...],
'NULL' => true || false,
'S' => '<string>',
'SS' => ['<string>', ...],
],
// ...
],
'Item' => [ // REQUIRED
'<AttributeName>' => [
'B' => <string || resource || Psr\Http\Message\StreamInterface>,
'BOOL' => true || false,
'BS' => [<string || resource || Psr\Http\Message\StreamInterface>, ...],
'L' => [
[...], // RECURSIVE
// ...
],
'M' => [
'<AttributeName>' => [...], // RECURSIVE
// ...
],
'N' => '<string>',
'NS' => ['<string>', ...],
'NULL' => true || false,
'S' => '<string>',
'SS' => ['<string>', ...],
],
// ...
],
'ReturnConsumedCapacity' => 'INDEXES|TOTAL|NONE',
'ReturnItemCollectionMetrics' => 'SIZE|NONE',
'ReturnValues' => 'NONE|ALL_OLD|UPDATED_OLD|ALL_NEW|UPDATED_NEW',
'ReturnValuesOnConditionCheckFailure' => 'ALL_OLD|NONE',
'TableName' => '<string>', // REQUIRED
]);
Parameter Details Members
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 in the Amazon DynamoDB Developer Guide.
This is a legacy parameter. Use ConditionExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.
This is a legacy parameter. Use ConditionExpression instead. For more information, see Expected in the Amazon DynamoDB Developer Guide.
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 # 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 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 in the Amazon DynamoDB Developer Guide.
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 in the Amazon DynamoDB Developer Guide.
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 in the Amazon DynamoDB Developer Guide.
Each element in the Item map is an AttributeValue object.
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.
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.
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.
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.
The name of the table to contain the item. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.
[
'Attributes' => [
'<AttributeName>' => [
'B' => <string || resource || Psr\Http\Message\StreamInterface>,
'BOOL' => true || false,
'BS' => [<string || resource || Psr\Http\Message\StreamInterface>, ...],
'L' => [
[...], // RECURSIVE
// ...
],
'M' => [
'<AttributeName>' => [...], // RECURSIVE
// ...
],
'N' => '<string>',
'NS' => ['<string>', ...],
'NULL' => true || false,
'S' => '<string>',
'SS' => ['<string>', ...],
],
// ...
],
'ConsumedCapacity' => [
'CapacityUnits' => <float>,
'GlobalSecondaryIndexes' => [
'<IndexName>' => [
'CapacityUnits' => <float>,
'ReadCapacityUnits' => <float>,
'WriteCapacityUnits' => <float>,
],
// ...
],
'LocalSecondaryIndexes' => [
'<IndexName>' => [
'CapacityUnits' => <float>,
'ReadCapacityUnits' => <float>,
'WriteCapacityUnits' => <float>,
],
// ...
],
'ReadCapacityUnits' => <float>,
'Table' => [
'CapacityUnits' => <float>,
'ReadCapacityUnits' => <float>,
'WriteCapacityUnits' => <float>,
],
'TableName' => '<string>',
'WriteCapacityUnits' => <float>,
],
'ItemCollectionMetrics' => [
'ItemCollectionKey' => [
'<AttributeName>' => [
'B' => <string || resource || Psr\Http\Message\StreamInterface>,
'BOOL' => true || false,
'BS' => [<string || resource || Psr\Http\Message\StreamInterface>, ...],
'L' => [
[...], // RECURSIVE
// ...
],
'M' => [
'<AttributeName>' => [...], // RECURSIVE
// ...
],
'N' => '<string>',
'NS' => ['<string>', ...],
'NULL' => true || false,
'S' => '<string>',
'SS' => ['<string>', ...],
],
// ...
],
'SizeEstimateRangeGB' => [<float>, ...],
],
]Result Details Members
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.
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 in the Amazon DynamoDB Developer Guide.
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.
A condition specified in the operation failed to be evaluated.
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 field in the returned exception. The Amazon Web Services 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 in the Amazon DynamoDB Developer Guide.
The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be ACTIVE.
An item collection is too large. This exception is only returned for tables that have one or more local secondary indexes.
Operation was rejected because there is an ongoing transaction for the item.
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 field in the returned exception. Contact Amazon Web ServicesSupport to request a quota increase.
An error occurred on the server side.
The request was rejected because one or more items in the request are being modified by a request in another Region.
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 field in the returned exception.
This example adds a new item to the Music table.
$result = $client->putItem([
'Item' => [
'AlbumTitle' => [
'S' => 'Somewhat Famous',
],
'Artist' => [
'S' => 'No One You Know',
],
'SongTitle' => [
'S' => 'Call Me Today',
],
],
'ReturnConsumedCapacity' => 'TOTAL',
'TableName' => 'Music',
]);
Result syntax:
[
'ConsumedCapacity' => [
'CapacityUnits' => 1,
'TableName' => 'Music',
],
] PutResourcePolicy
$result = $client->putResourcePolicy([/* ... */]); $promise = $client->putResourcePolicyAsync([/* ... */]);
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 eventually consistent .
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.
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.
$result = $client->putResourcePolicy([
'ConfirmRemoveSelfResourceAccess' => true || false,
'ExpectedRevisionId' => '<string>',
'Policy' => '<string>', // REQUIRED
'ResourceArn' => '<string>', // REQUIRED
]);
Parameter Details Members
Set this parameter to true to confirm that you want to remove your permissions to change the policy of this resource in the future.
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.
An Amazon Web Services 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.
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.
[
'RevisionId' => '<string>',
]Result Details Members
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.
The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be ACTIVE.
An error occurred on the server side.
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.
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.
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.
$result = $client->query([/* ... */]); $promise = $client->queryAsync([/* ... */]);
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.
DynamoDB calculates the number of read capacity units consumed based on item size, not on the amount of data that is returned to an application. The number of capacity units consumed will be the same whether you request all of the attributes (the default behavior) or just some of them (using a projection expression). The number will also be the same whether or not you use a FilterExpression.
Query results are always sorted by the sort key value. If the data type of the sort key is Number, the results are returned in numeric order; otherwise, the results are returned in order of UTF-8 bytes. By default, the sort order is ascending. To reverse the order, set the ScanIndexForward parameter to false.
A single Query operation will read up to the maximum number of items set (if using the Limit parameter) or a maximum of 1 MB of data and then apply any filtering to the results using FilterExpression. If LastEvaluatedKey is present in the response, you will need to paginate the result set. For more information, see Paginating the Results in the Amazon DynamoDB Developer Guide.
FilterExpression is applied after a Query finishes, but before the results are returned. A FilterExpression cannot contain partition key or sort key attributes. You need to specify those attributes in the KeyConditionExpression.
A Query operation can return an empty result set and a LastEvaluatedKey if all the items read for the page of results are filtered out.
You can query a table, a local secondary index, or a global secondary index. For a query on a table or on a local secondary index, you can set the ConsistentRead parameter to true and obtain a strongly consistent result. Global secondary indexes support eventually consistent reads only, so do not specify ConsistentRead when querying a global secondary index.
$result = $client->query([
'AttributesToGet' => ['<string>', ...],
'ConditionalOperator' => 'AND|OR',
'ConsistentRead' => true || false,
'ExclusiveStartKey' => [
'<AttributeName>' => [
'B' => <string || resource || Psr\Http\Message\StreamInterface>,
'BOOL' => true || false,
'BS' => [<string || resource || Psr\Http\Message\StreamInterface>, ...],
'L' => [
[...], // RECURSIVE
// ...
],
'M' => [
'<AttributeName>' => [...], // RECURSIVE
// ...
],
'N' => '<string>',
'NS' => ['<string>', ...],
'NULL' => true || false,
'S' => '<string>',
'SS' => ['<string>', ...],
],
// ...
],
'ExpressionAttributeNames' => ['<string>', ...],
'ExpressionAttributeValues' => [
'<ExpressionAttributeValueVariable>' => [
'B' => <string || resource || Psr\Http\Message\StreamInterface>,
'BOOL' => true || false,
'BS' => [<string || resource || Psr\Http\Message\StreamInterface>, ...],
'L' => [
[...], // RECURSIVE
// ...
],
'M' => [
'<AttributeName>' => [...], // RECURSIVE
// ...
],
'N' => '<string>',
'NS' => ['<string>', ...],
'NULL' => true || false,
'S' => '<string>',
'SS' => ['<string>', ...],
],
// ...
],
'FilterExpression' => '<string>',
'IndexName' => '<string>',
'KeyConditionExpression' => '<string>',
'KeyConditions' => [
'<AttributeName>' => [
'AttributeValueList' => [
[
'B' => <string || resource || Psr\Http\Message\StreamInterface>,
'BOOL' => true || false,
'BS' => [<string || resource || Psr\Http\Message\StreamInterface>, ...],
'L' => [
[...], // RECURSIVE
// ...
],
'M' => [
'<AttributeName>' => [...], // RECURSIVE
// ...
],
'N' => '<string>',
'NS' => ['<string>', ...],
'NULL' => true || false,
'S' => '<string>',
'SS' => ['<string>', ...],
],
// ...
],
'ComparisonOperator' => 'EQ|NE|IN|LE|LT|GE|GT|BETWEEN|NOT_NULL|NULL|CONTAINS|NOT_CONTAINS|BEGINS_WITH', // REQUIRED
],
// ...
],
'Limit' => <integer>,
'ProjectionExpression' => '<string>',
'QueryFilter' => [
'<AttributeName>' => [
'AttributeValueList' => [
[
'B' => <string || resource || Psr\Http\Message\StreamInterface>,
'BOOL' => true || false,
'BS' => [<string || resource || Psr\Http\Message\StreamInterface>, ...],
'L' => [
[...], // RECURSIVE
// ...
],
'M' => [
'<AttributeName>' => [...], // RECURSIVE
// ...
],
'N' => '<string>',
'NS' => ['<string>', ...],
'NULL' => true || false,
'S' => '<string>',
'SS' => ['<string>', ...],
],
// ...
],
'ComparisonOperator' => 'EQ|NE|IN|LE|LT|GE|GT|BETWEEN|NOT_NULL|NULL|CONTAINS|NOT_CONTAINS|BEGINS_WITH', // REQUIRED
],
// ...
],
'ReturnConsumedCapacity' => 'INDEXES|TOTAL|NONE',
'ScanIndexForward' => true || false,
'Select' => 'ALL_ATTRIBUTES|ALL_PROJECTED_ATTRIBUTES|SPECIFIC_ATTRIBUTES|COUNT',
'TableName' => '<string>', // REQUIRED
]);
Parameter Details Members
This is a legacy parameter. Use ProjectionExpression instead. For more information, see AttributesToGet in the Amazon DynamoDB Developer Guide.
This is a legacy parameter. Use FilterExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.
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.
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.
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 # 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 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 in the Amazon DynamoDB Developer Guide.
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 in the Amazon DynamoDB Developer Guide.
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 in the Amazon DynamoDB Developer Guide.
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.
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 in the Amazon DynamoDB Developer Guide.
For more information on ExpressionAttributeNames and ExpressionAttributeValues, see Using Placeholders for Attribute Names and Values in the Amazon DynamoDB Developer Guide.
This is a legacy parameter. Use KeyConditionExpression instead. For more information, see KeyConditions in the Amazon DynamoDB Developer Guide.
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 in the Amazon DynamoDB Developer Guide.
A string that identifies one or more attributes to retrieve from the table. These attributes can include scalars, sets, or elements of a JSON document. The attributes in the expression must be separated by commas.
If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.
For more information, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
This is a legacy parameter. Use FilterExpression instead. For more information, see QueryFilter in the Amazon DynamoDB Developer Guide.
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.
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.
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.
The name of the table containing the requested items. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.
[
'ConsumedCapacity' => [
'CapacityUnits' => <float>,
'GlobalSecondaryIndexes' => [
'<IndexName>' => [
'CapacityUnits' => <float>,
'ReadCapacityUnits' => <float>,
'WriteCapacityUnits' => <float>,
],
// ...
],
'LocalSecondaryIndexes' => [
'<IndexName>' => [
'CapacityUnits' => <float>,
'ReadCapacityUnits' => <float>,
'WriteCapacityUnits' => <float>,
],
// ...
],
'ReadCapacityUnits' => <float>,
'Table' => [
'CapacityUnits' => <float>,
'ReadCapacityUnits' => <float>,
'WriteCapacityUnits' => <float>,
],
'TableName' => '<string>',
'WriteCapacityUnits' => <float>,
],
'Count' => <integer>,
'Items' => [
[
'<AttributeName>' => [
'B' => <string || resource || Psr\Http\Message\StreamInterface>,
'BOOL' => true || false,
'BS' => [<string || resource || Psr\Http\Message\StreamInterface>, ...],
'L' => [
[...], // RECURSIVE
// ...
],
'M' => [
'<AttributeName>' => [...], // RECURSIVE
// ...
],
'N' => '<string>',
'NS' => ['<string>', ...],
'NULL' => true || false,
'S' => '<string>',
'SS' => ['<string>', ...],
],
// ...
],
// ...
],
'LastEvaluatedKey' => [
'<AttributeName>' => [
'B' => <string || resource || Psr\Http\Message\StreamInterface>,
'BOOL' => true || false,
'BS' => [<string || resource || Psr\Http\Message\StreamInterface>, ...],
'L' => [
[...], // RECURSIVE
// ...
],
'M' => [
'<AttributeName>' => [...], // RECURSIVE
// ...
],
'N' => '<string>',
'NS' => ['<string>', ...],
'NULL' => true || false,
'S' => '<string>',
'SS' => ['<string>', ...],
],
// ...
],
'ScannedCount' => <integer>,
]Result Details Members
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 in the Amazon DynamoDB Developer Guide.
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.
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.
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.
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 in the Amazon DynamoDB Developer Guide.
If you did not use a filter in the request, then ScannedCount is the same as Count.
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 field in the returned exception. The Amazon Web Services 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 in the Amazon DynamoDB Developer Guide.
The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be ACTIVE.
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 field in the returned exception. Contact Amazon Web ServicesSupport to request a quota increase.
An error occurred on the server side.
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 field in the returned exception.
This example queries items in the Music table. The table has a partition key and sort key (Artist and SongTitle), but this query only specifies the partition key value. It returns song titles by the artist named "No One You Know".
$result = $client->query([
'ExpressionAttributeValues' => [
':v1' => [
'S' => 'No One You Know',
],
],
'KeyConditionExpression' => 'Artist = :v1',
'ProjectionExpression' => 'SongTitle',
'TableName' => 'Music',
]);
Result syntax:
[
'ConsumedCapacity' => [
],
'Count' => 2,
'Items' => [
[
'SongTitle' => [
'S' => 'Call Me Today',
],
],
],
'ScannedCount' => 2,
] RestoreTableFromBackup
$result = $client->restoreTableFromBackup([/* ... */]); $promise = $client->restoreTableFromBackupAsync([/* ... */]);
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
$result = $client->restoreTableFromBackup([
'BackupArn' => '<string>', // REQUIRED
'BillingModeOverride' => 'PROVISIONED|PAY_PER_REQUEST',
'GlobalSecondaryIndexOverride' => [
[
'IndexName' => '<string>', // REQUIRED
'KeySchema' => [ // REQUIRED
[
'AttributeName' => '<string>', // REQUIRED
'KeyType' => 'HASH|RANGE', // REQUIRED
],
// ...
],
'OnDemandThroughput' => [
'MaxReadRequestUnits' => <integer>,
'MaxWriteRequestUnits' => <integer>,
],
'Projection' => [ // REQUIRED
'NonKeyAttributes' => ['<string>', ...],
'ProjectionType' => 'ALL|KEYS_ONLY|INCLUDE',
],
'ProvisionedThroughput' => [
'ReadCapacityUnits' => <integer>, // REQUIRED
'WriteCapacityUnits' => <integer>, // REQUIRED
],
'WarmThroughput' => [
'ReadUnitsPerSecond' => <integer>,
'WriteUnitsPerSecond' => <integer>,
],
],
// ...
],
'LocalSecondaryIndexOverride' => [
[
'IndexName' => '<string>', // REQUIRED
'KeySchema' => [ // REQUIRED
[
'AttributeName' => '<string>', // REQUIRED
'KeyType' => 'HASH|RANGE', // REQUIRED
],
// ...
],
'Projection' => [ // REQUIRED
'NonKeyAttributes' => ['<string>', ...],
'ProjectionType' => 'ALL|KEYS_ONLY|INCLUDE',
],
],
// ...
],
'OnDemandThroughputOverride' => [
'MaxReadRequestUnits' => <integer>,
'MaxWriteRequestUnits' => <integer>,
],
'ProvisionedThroughputOverride' => [
'ReadCapacityUnits' => <integer>, // REQUIRED
'WriteCapacityUnits' => <integer>, // REQUIRED
],
'SSESpecificationOverride' => [
'Enabled' => true || false,
'KMSMasterKeyId' => '<string>',
'SSEType' => 'AES256|KMS',
],
'TargetTableName' => '<string>', // REQUIRED
]);
Parameter Details Members
The Amazon Resource Name (ARN) associated with the backup.
The billing mode of the restored table.
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.
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.
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.
Provisioned throughput settings for the restored table.
The new server-side encryption settings for the restored table.
The name of the new table to which the backup must be restored.
[
'TableDescription' => [
'ArchivalSummary' => [
'ArchivalBackupArn' => '<string>',
'ArchivalDateTime' => <DateTime>,
'ArchivalReason' => '<string>',
],
'AttributeDefinitions' => [
[
'AttributeName' => '<string>',
'AttributeType' => 'S|N|B',
],
// ...
],
'BillingModeSummary' => [
'BillingMode' => 'PROVISIONED|PAY_PER_REQUEST',
'LastUpdateToPayPerRequestDateTime' => <DateTime>,
],
'CreationDateTime' => <DateTime>,
'DeletionProtectionEnabled' => true || false,
'GlobalSecondaryIndexes' => [
[
'Backfilling' => true || false,
'IndexArn' => '<string>',
'IndexName' => '<string>',
'IndexSizeBytes' => <integer>,
'IndexStatus' => 'CREATING|UPDATING|DELETING|ACTIVE',
'ItemCount' => <integer>,
'KeySchema' => [
[
'AttributeName' => '<string>',
'KeyType' => 'HASH|RANGE',
],
// ...
],
'OnDemandThroughput' => [
'MaxReadRequestUnits' => <integer>,
'MaxWriteRequestUnits' => <integer>,
],
'Projection' => [
'NonKeyAttributes' => ['<string>', ...],
'ProjectionType' => 'ALL|KEYS_ONLY|INCLUDE',
],
'ProvisionedThroughput' => [
'LastDecreaseDateTime' => <DateTime>,
'LastIncreaseDateTime' => <DateTime>,
'NumberOfDecreasesToday' => <integer>,
'ReadCapacityUnits' => <integer>,
'WriteCapacityUnits' => <integer>,
],
'WarmThroughput' => [
'ReadUnitsPerSecond' => <integer>,
'Status' => 'CREATING|UPDATING|DELETING|ACTIVE',
'WriteUnitsPerSecond' => <integer>,
],
],
// ...
],
'GlobalTableVersion' => '<string>',
'GlobalTableWitnesses' => [
[
'RegionName' => '<string>',
'WitnessStatus' => 'CREATING|DELETING|ACTIVE',
],
// ...
],
'ItemCount' => <integer>,
'KeySchema' => [
[
'AttributeName' => '<string>',
'KeyType' => 'HASH|RANGE',
],
// ...
],
'LatestStreamArn' => '<string>',
'LatestStreamLabel' => '<string>',
'LocalSecondaryIndexes' => [
[
'IndexArn' => '<string>',
'IndexName' => '<string>',
'IndexSizeBytes' => <integer>,
'ItemCount' => <integer>,
'KeySchema' => [
[
'AttributeName' => '<string>',
'KeyType' => 'HASH|RANGE',
],
// ...
],
'Projection' => [
'NonKeyAttributes' => ['<string>', ...],
'ProjectionType' => 'ALL|KEYS_ONLY|INCLUDE',
],
],
// ...
],
'MultiRegionConsistency' => 'EVENTUAL|STRONG',
'OnDemandThroughput' => [
'MaxReadRequestUnits' => <integer>,
'MaxWriteRequestUnits' => <integer>,
],
'ProvisionedThroughput' => [
'LastDecreaseDateTime' => <DateTime>,
'LastIncreaseDateTime' => <DateTime>,
'NumberOfDecreasesToday' => <integer>,
'ReadCapacityUnits' => <integer>,
'WriteCapacityUnits' => <integer>,
],
'Replicas' => [
[
'GlobalSecondaryIndexes' => [
[
'IndexName' => '<string>',
'OnDemandThroughputOverride' => [
'MaxReadRequestUnits' => <integer>,
],
'ProvisionedThroughputOverride' => [
'ReadCapacityUnits' => <integer>,
],
'WarmThroughput' => [
'ReadUnitsPerSecond' => <integer>,
'Status' => 'CREATING|UPDATING|DELETING|ACTIVE',
'WriteUnitsPerSecond' => <integer>,
],
],
// ...
],
'KMSMasterKeyId' => '<string>',
'OnDemandThroughputOverride' => [
'MaxReadRequestUnits' => <integer>,
],
'ProvisionedThroughputOverride' => [
'ReadCapacityUnits' => <integer>,
],
'RegionName' => '<string>',
'ReplicaInaccessibleDateTime' => <DateTime>,
'ReplicaStatus' => 'CREATING|CREATION_FAILED|UPDATING|DELETING|ACTIVE|REGION_DISABLED|INACCESSIBLE_ENCRYPTION_CREDENTIALS|ARCHIVING|ARCHIVED|REPLICATION_NOT_AUTHORIZED',
'ReplicaStatusDescription' => '<string>',
'ReplicaStatusPercentProgress' => '<string>',
'ReplicaTableClassSummary' => [
'LastUpdateDateTime' => <DateTime>,
'TableClass' => 'STANDARD|STANDARD_INFREQUENT_ACCESS',
],
'WarmThroughput' => [
'ReadUnitsPerSecond' => <integer>,
'Status' => 'CREATING|UPDATING|DELETING|ACTIVE|INACCESSIBLE_ENCRYPTION_CREDENTIALS|ARCHIVING|ARCHIVED|REPLICATION_NOT_AUTHORIZED',
'WriteUnitsPerSecond' => <integer>,
],
],
// ...
],
'RestoreSummary' => [
'RestoreDateTime' => <DateTime>,
'RestoreInProgress' => true || false,
'SourceBackupArn' => '<string>',
'SourceTableArn' => '<string>',
],
'SSEDescription' => [
'InaccessibleEncryptionDateTime' => <DateTime>,
'KMSMasterKeyArn' => '<string>',
'SSEType' => 'AES256|KMS',
'Status' => 'ENABLING|ENABLED|DISABLING|DISABLED|UPDATING',
],
'StreamSpecification' => [
'StreamEnabled' => true || false,
'StreamViewType' => 'NEW_IMAGE|OLD_IMAGE|NEW_AND_OLD_IMAGES|KEYS_ONLY',
],
'TableArn' => '<string>',
'TableClassSummary' => [
'LastUpdateDateTime' => <DateTime>,
'TableClass' => 'STANDARD|STANDARD_INFREQUENT_ACCESS',
],
'TableId' => '<string>',
'TableName' => '<string>',
'TableSizeBytes' => <integer>,
'TableStatus' => 'CREATING|UPDATING|DELETING|ACTIVE|INACCESSIBLE_ENCRYPTION_CREDENTIALS|ARCHIVING|ARCHIVED|REPLICATION_NOT_AUTHORIZED',
'WarmThroughput' => [
'ReadUnitsPerSecond' => <integer>,
'Status' => 'CREATING|UPDATING|DELETING|ACTIVE|INACCESSIBLE_ENCRYPTION_CREDENTIALS|ARCHIVING|ARCHIVED|REPLICATION_NOT_AUTHORIZED',
'WriteUnitsPerSecond' => <integer>,
],
],
]Result Details Members
The description of the table created from an existing backup.
A target table with the specified name already exists.
A target table with the specified name is either being created or deleted.
Backup not found for the given BackupARN.
There is another ongoing conflicting backup control plane operation on the table. The backup is either being created, deleted or restored to a table.
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.
An error occurred on the server side.
$result = $client->restoreTableToPointInTime([/* ... */]); $promise = $client->restoreTableToPointInTimeAsync([/* ... */]);
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
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
$result = $client->restoreTableToPointInTime([
'BillingModeOverride' => 'PROVISIONED|PAY_PER_REQUEST',
'GlobalSecondaryIndexOverride' => [
[
'IndexName' => '<string>', // REQUIRED
'KeySchema' => [ // REQUIRED
[
'AttributeName' => '<string>', // REQUIRED
'KeyType' => 'HASH|RANGE', // REQUIRED
],
// ...
],
'OnDemandThroughput' => [
'MaxReadRequestUnits' => <integer>,
'MaxWriteRequestUnits' => <integer>,
],
'Projection' => [ // REQUIRED
'NonKeyAttributes' => ['<string>', ...],
'ProjectionType' => 'ALL|KEYS_ONLY|INCLUDE',
],
'ProvisionedThroughput' => [
'ReadCapacityUnits' => <integer>, // REQUIRED
'WriteCapacityUnits' => <integer>, // REQUIRED
],
'WarmThroughput' => [
'ReadUnitsPerSecond' => <integer>,
'WriteUnitsPerSecond' => <integer>,
],
],
// ...
],
'LocalSecondaryIndexOverride' => [
[
'IndexName' => '<string>', // REQUIRED
'KeySchema' => [ // REQUIRED
[
'AttributeName' => '<string>', // REQUIRED
'KeyType' => 'HASH|RANGE', // REQUIRED
],
// ...
],
'Projection' => [ // REQUIRED
'NonKeyAttributes' => ['<string>', ...],
'ProjectionType' => 'ALL|KEYS_ONLY|INCLUDE',
],
],
// ...
],
'OnDemandThroughputOverride' => [
'MaxReadRequestUnits' => <integer>,
'MaxWriteRequestUnits' => <integer>,
],
'ProvisionedThroughputOverride' => [
'ReadCapacityUnits' => <integer>, // REQUIRED
'WriteCapacityUnits' => <integer>, // REQUIRED
],
'RestoreDateTime' => <integer || string || DateTime>,
'SSESpecificationOverride' => [
'Enabled' => true || false,
'KMSMasterKeyId' => '<string>',
'SSEType' => 'AES256|KMS',
],
'SourceTableArn' => '<string>',
'SourceTableName' => '<string>',
'TargetTableName' => '<string>', // REQUIRED
'UseLatestRestorableTime' => true || false,
]);
Parameter Details Members
The billing mode of the restored table.
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.
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.
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.
Provisioned throughput settings for the restored table.
Time in the past to restore the table to.
The new server-side encryption settings for the restored table.
The DynamoDB table that will be restored. This value is an Amazon Resource Name (ARN).
Name of the source table that is being restored.
The name of the new table to which it must be restored to.
Restore the table to the latest possible time. LatestRestorableDateTime is typically 5 minutes before the current time.
[
'TableDescription' => [
'ArchivalSummary' => [
'ArchivalBackupArn' => '<string>',
'ArchivalDateTime' => <DateTime>,
'ArchivalReason' => '<string>',
],
'AttributeDefinitions' => [
[
'AttributeName' => '<string>',
'AttributeType' => 'S|N|B',
],
// ...
],
'BillingModeSummary' => [
'BillingMode' => 'PROVISIONED|PAY_PER_REQUEST',
'LastUpdateToPayPerRequestDateTime' => <DateTime>,
],
'CreationDateTime' => <DateTime>,
'DeletionProtectionEnabled' => true || false,
'GlobalSecondaryIndexes' => [
[
'Backfilling' => true || false,
'IndexArn' => '<string>',
'IndexName' => '<string>',
'IndexSizeBytes' => <integer>,
'IndexStatus' => 'CREATING|UPDATING|DELETING|ACTIVE',
'ItemCount' => <integer>,
'KeySchema' => [
[
'AttributeName' => '<string>',
'KeyType' => 'HASH|RANGE',
],
// ...
],
'OnDemandThroughput' => [
'MaxReadRequestUnits' => <integer>,
'MaxWriteRequestUnits' => <integer>,
],
'Projection' => [
'NonKeyAttributes' => ['<string>', ...],
'ProjectionType' => 'ALL|KEYS_ONLY|INCLUDE',
],
'ProvisionedThroughput' => [
'LastDecreaseDateTime' => <DateTime>,
'LastIncreaseDateTime' => <DateTime>,
'NumberOfDecreasesToday' => <integer>,
'ReadCapacityUnits' => <integer>,
'WriteCapacityUnits' => <integer>,
],
'WarmThroughput' => [
'ReadUnitsPerSecond' => <integer>,
'Status' => 'CREATING|UPDATING|DELETING|ACTIVE',
'WriteUnitsPerSecond' => <integer>,
],
],
// ...
],
'GlobalTableVersion' => '<string>',
'GlobalTableWitnesses' => [
[
'RegionName' => '<string>',
'WitnessStatus' => 'CREATING|DELETING|ACTIVE',
],
// ...
],
'ItemCount' => <integer>,
'KeySchema' => [
[
'AttributeName' => '<string>',
'KeyType' => 'HASH|RANGE',
],
// ...
],
'LatestStreamArn' => '<string>',
'LatestStreamLabel' => '<string>',
'LocalSecondaryIndexes' => [
[
'IndexArn' => '<string>',
'IndexName' => '<string>',
'IndexSizeBytes' => <integer>,
'ItemCount' => <integer>,
'KeySchema' => [
[
'AttributeName' => '<string>',
'KeyType' => 'HASH|RANGE',
],
// ...
],
'Projection' => [
'NonKeyAttributes' => ['<string>', ...],
'ProjectionType' => 'ALL|KEYS_ONLY|INCLUDE',
],
],
// ...
],
'MultiRegionConsistency' => 'EVENTUAL|STRONG',
'OnDemandThroughput' => [
'MaxReadRequestUnits' => <integer>,
'MaxWriteRequestUnits' => <integer>,
],
'ProvisionedThroughput' => [
'LastDecreaseDateTime' => <DateTime>,
'LastIncreaseDateTime' => <DateTime>,
'NumberOfDecreasesToday' => <integer>,
'ReadCapacityUnits' => <integer>,
'WriteCapacityUnits' => <integer>,
],
'Replicas' => [
[
'GlobalSecondaryIndexes' => [
[
'IndexName' => '<string>',
'OnDemandThroughputOverride' => [
'MaxReadRequestUnits' => <integer>,
],
'ProvisionedThroughputOverride' => [
'ReadCapacityUnits' => <integer>,
],
'WarmThroughput' => [
'ReadUnitsPerSecond' => <integer>,
'Status' => 'CREATING|UPDATING|DELETING|ACTIVE',
'WriteUnitsPerSecond' => <integer>,
],
],
// ...
],
'KMSMasterKeyId' => '<string>',
'OnDemandThroughputOverride' => [
'MaxReadRequestUnits' => <integer>,
],
'ProvisionedThroughputOverride' => [
'ReadCapacityUnits' => <integer>,
],
'RegionName' => '<string>',
'ReplicaInaccessibleDateTime' => <DateTime>,
'ReplicaStatus' => 'CREATING|CREATION_FAILED|UPDATING|DELETING|ACTIVE|REGION_DISABLED|INACCESSIBLE_ENCRYPTION_CREDENTIALS|ARCHIVING|ARCHIVED|REPLICATION_NOT_AUTHORIZED',
'ReplicaStatusDescription' => '<string>',
'ReplicaStatusPercentProgress' => '<string>',
'ReplicaTableClassSummary' => [
'LastUpdateDateTime' => <DateTime>,
'TableClass' => 'STANDARD|STANDARD_INFREQUENT_ACCESS',
],
'WarmThroughput' => [
'ReadUnitsPerSecond' => <integer>,
'Status' => 'CREATING|UPDATING|DELETING|ACTIVE|INACCESSIBLE_ENCRYPTION_CREDENTIALS|ARCHIVING|ARCHIVED|REPLICATION_NOT_AUTHORIZED',
'WriteUnitsPerSecond' => <integer>,
],
],
// ...
],
'RestoreSummary' => [
'RestoreDateTime' => <DateTime>,
'RestoreInProgress' => true || false,
'SourceBackupArn' => '<string>',
'SourceTableArn' => '<string>',
],
'SSEDescription' => [
'InaccessibleEncryptionDateTime' => <DateTime>,
'KMSMasterKeyArn' => '<string>',
'SSEType' => 'AES256|KMS',
'Status' => 'ENABLING|ENABLED|DISABLING|DISABLED|UPDATING',
],
'StreamSpecification' => [
'StreamEnabled' => true || false,
'StreamViewType' => 'NEW_IMAGE|OLD_IMAGE|NEW_AND_OLD_IMAGES|KEYS_ONLY',
],
'TableArn' => '<string>',
'TableClassSummary' => [
'LastUpdateDateTime' => <DateTime>,
'TableClass' => 'STANDARD|STANDARD_INFREQUENT_ACCESS',
],
'TableId' => '<string>',
'TableName' => '<string>',
'TableSizeBytes' => <integer>,
'TableStatus' => 'CREATING|UPDATING|DELETING|ACTIVE|INACCESSIBLE_ENCRYPTION_CREDENTIALS|ARCHIVING|ARCHIVED|REPLICATION_NOT_AUTHORIZED',
'WarmThroughput' => [
'ReadUnitsPerSecond' => <integer>,
'Status' => 'CREATING|UPDATING|DELETING|ACTIVE|INACCESSIBLE_ENCRYPTION_CREDENTIALS|ARCHIVING|ARCHIVED|REPLICATION_NOT_AUTHORIZED',
'WriteUnitsPerSecond' => <integer>,
],
],
]Result Details Members
Represents the properties of a table.
A target table with the specified name already exists.
A source table with the name TableName does not currently exist within the subscriber's account or the subscriber is operating in the wrong Amazon Web Services Region.
A target table with the specified name is either being created or deleted.
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.
An invalid restore time was specified. RestoreDateTime must be between EarliestRestorableDateTime and LatestRestorableDateTime.
Point in time recovery has not yet been enabled for this source table.
An error occurred on the server side.
$result = $client->scan([/* ... */]); $promise = $client->scanAsync([/* ... */]);
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.
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 in the Amazon DynamoDB Developer Guide.
Scan operations proceed sequentially; however, for faster performance on a large table or secondary index, applications can request a parallel Scan operation by providing the Segment and TotalSegments parameters. For more information, see Parallel Scan in the Amazon DynamoDB Developer Guide.
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.
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.
$result = $client->scan([
'AttributesToGet' => ['<string>', ...],
'ConditionalOperator' => 'AND|OR',
'ConsistentRead' => true || false,
'ExclusiveStartKey' => [
'<AttributeName>' => [
'B' => <string || resource || Psr\Http\Message\StreamInterface>,
'BOOL' => true || false,
'BS' => [<string || resource || Psr\Http\Message\StreamInterface>, ...],
'L' => [
[...], // RECURSIVE
// ...
],
'M' => [
'<AttributeName>' => [...], // RECURSIVE
// ...
],
'N' => '<string>',
'NS' => ['<string>', ...],
'NULL' => true || false,
'S' => '<string>',
'SS' => ['<string>', ...],
],
// ...
],
'ExpressionAttributeNames' => ['<string>', ...],
'ExpressionAttributeValues' => [
'<ExpressionAttributeValueVariable>' => [
'B' => <string || resource || Psr\Http\Message\StreamInterface>,
'BOOL' => true || false,
'BS' => [<string || resource || Psr\Http\Message\StreamInterface>, ...],
'L' => [
[...], // RECURSIVE
// ...
],
'M' => [
'<AttributeName>' => [...], // RECURSIVE
// ...
],
'N' => '<string>',
'NS' => ['<string>', ...],
'NULL' => true || false,
'S' => '<string>',
'SS' => ['<string>', ...],
],
// ...
],
'FilterExpression' => '<string>',
'IndexName' => '<string>',
'Limit' => <integer>,
'ProjectionExpression' => '<string>',
'ReturnConsumedCapacity' => 'INDEXES|TOTAL|NONE',
'ScanFilter' => [
'<AttributeName>' => [
'AttributeValueList' => [
[
'B' => <string || resource || Psr\Http\Message\StreamInterface>,
'BOOL' => true || false,
'BS' => [<string || resource || Psr\Http\Message\StreamInterface>, ...],
'L' => [
[...], // RECURSIVE
// ...
],
'M' => [
'<AttributeName>' => [...], // RECURSIVE
// ...
],
'N' => '<string>',
'NS' => ['<string>', ...],
'NULL' => true || false,
'S' => '<string>',
'SS' => ['<string>', ...],
],
// ...
],
'ComparisonOperator' => 'EQ|NE|IN|LE|LT|GE|GT|BETWEEN|NOT_NULL|NULL|CONTAINS|NOT_CONTAINS|BEGINS_WITH', // REQUIRED
],
// ...
],
'Segment' => <integer>,
'Select' => 'ALL_ATTRIBUTES|ALL_PROJECTED_ATTRIBUTES|SPECIFIC_ATTRIBUTES|COUNT',
'TableName' => '<string>', // REQUIRED
'TotalSegments' => <integer>,
]);
Parameter Details Members
This is a legacy parameter. Use ProjectionExpression instead. For more information, see AttributesToGet in the Amazon DynamoDB Developer Guide.
This is a legacy parameter. Use FilterExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.
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.
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.
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 # 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 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 in the Amazon DynamoDB Developer Guide.
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 in the Amazon DynamoDB Developer Guide.
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 in the Amazon DynamoDB Developer Guide.
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.
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 in the Amazon DynamoDB Developer Guide.
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 in the Amazon DynamoDB Developer Guide.
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.
This is a legacy parameter. Use FilterExpression instead. For more information, see ScanFilter in the Amazon DynamoDB Developer Guide.
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.
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.
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.
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.
[
'ConsumedCapacity' => [
'CapacityUnits' => <float>,
'GlobalSecondaryIndexes' => [
'<IndexName>' => [
'CapacityUnits' => <float>,
'ReadCapacityUnits' => <float>,
'WriteCapacityUnits' => <float>,
],
// ...
],
'LocalSecondaryIndexes' => [
'<IndexName>' => [
'CapacityUnits' => <float>,
'ReadCapacityUnits' => <float>,
'WriteCapacityUnits' => <float>,
],
// ...
],
'ReadCapacityUnits' => <float>,
'Table' => [
'CapacityUnits' => <float>,
'ReadCapacityUnits' => <float>,
'WriteCapacityUnits' => <float>,
],
'TableName' => '<string>',
'WriteCapacityUnits' => <float>,
],
'Count' => <integer>,
'Items' => [
[
'<AttributeName>' => [
'B' => <string || resource || Psr\Http\Message\StreamInterface>,
'BOOL' => true || false,
'BS' => [<string || resource || Psr\Http\Message\StreamInterface>, ...],
'L' => [
[...], // RECURSIVE
// ...
],
'M' => [
'<AttributeName>' => [...], // RECURSIVE
// ...
],
'N' => '<string>',
'NS' => ['<string>', ...],
'NULL' => true || false,
'S' => '<string>',
'SS' => ['<string>', ...],
],
// ...
],
// ...
],
'LastEvaluatedKey' => [
'<AttributeName>' => [
'B' => <string || resource || Psr\Http\Message\StreamInterface>,
'BOOL' => true || false,
'BS' => [<string || resource || Psr\Http\Message\StreamInterface>, ...],
'L' => [
[...], // RECURSIVE
// ...
],
'M' => [
'<AttributeName>' => [...], // RECURSIVE
// ...
],
'N' => '<string>',
'NS' => ['<string>', ...],
'NULL' => true || false,
'S' => '<string>',
'SS' => ['<string>', ...],
],
// ...
],
'ScannedCount' => <integer>,
]Result Details Members
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 in the Amazon DynamoDB Developer Guide.
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.
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.
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.
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 in the Amazon DynamoDB Developer Guide.
If you did not use a filter in the request, then ScannedCount is the same as Count.
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 field in the returned exception. The Amazon Web Services 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 in the Amazon DynamoDB Developer Guide.
The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be ACTIVE.
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 field in the returned exception. Contact Amazon Web ServicesSupport to request a quota increase.
An error occurred on the server side.
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 field in the returned exception.
This example scans the entire Music table, and then narrows the results to songs by the artist "No One You Know". For each item, only the album title and song title are returned.
$result = $client->scan([
'ExpressionAttributeNames' => [
'#AT' => 'AlbumTitle',
'#ST' => 'SongTitle',
],
'ExpressionAttributeValues' => [
':a' => [
'S' => 'No One You Know',
],
],
'FilterExpression' => 'Artist = :a',
'ProjectionExpression' => '#ST, #AT',
'TableName' => 'Music',
]);
Result syntax:
[
'ConsumedCapacity' => [
],
'Count' => 2,
'Items' => [
[
'AlbumTitle' => [
'S' => 'Somewhat Famous',
],
'SongTitle' => [
'S' => 'Call Me Today',
],
],
[
'AlbumTitle' => [
'S' => 'Blue Sky Blues',
],
'SongTitle' => [
'S' => 'Scared of My Shadow',
],
],
],
'ScannedCount' => 3,
] TagResource
$result = $client->tagResource([/* ... */]); $promise = $client->tagResourceAsync([/* ... */]);
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 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 in the Amazon DynamoDB Developer Guide.
Parameter Syntax$result = $client->tagResource([
'ResourceArn' => '<string>', // REQUIRED
'Tags' => [ // REQUIRED
[
'Key' => '<string>', // REQUIRED
'Value' => '<string>', // REQUIRED
],
// ...
],
]);
Parameter Details Members
Identifies the Amazon DynamoDB resource to which tags should be added. This value is an Amazon Resource Name (ARN).
The tags to be assigned to the Amazon DynamoDB resource.
[]Result Details
The results for this operation are always empty.
ErrorsThere 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.
The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be ACTIVE.
An error occurred on the server side.
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.
$result = $client->transactGetItems([/* ... */]); $promise = $client->transactGetItemsAsync([/* ... */]);
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 Amazon Web Services 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.
$result = $client->transactGetItems([
'ReturnConsumedCapacity' => 'INDEXES|TOTAL|NONE',
'TransactItems' => [ // REQUIRED
[
'Get' => [ // REQUIRED
'ExpressionAttributeNames' => ['<string>', ...],
'Key' => [ // REQUIRED
'<AttributeName>' => [
'B' => <string || resource || Psr\Http\Message\StreamInterface>,
'BOOL' => true || false,
'BS' => [<string || resource || Psr\Http\Message\StreamInterface>, ...],
'L' => [
[...], // RECURSIVE
// ...
],
'M' => [
'<AttributeName>' => [...], // RECURSIVE
// ...
],
'N' => '<string>',
'NS' => ['<string>', ...],
'NULL' => true || false,
'S' => '<string>',
'SS' => ['<string>', ...],
],
// ...
],
'ProjectionExpression' => '<string>',
'TableName' => '<string>', // REQUIRED
],
],
// ...
],
]);
Parameter Details Members
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.
An ordered array of up to 100 TransactGetItem objects, each of which contains a Get structure.
[
'ConsumedCapacity' => [
[
'CapacityUnits' => <float>,
'GlobalSecondaryIndexes' => [
'<IndexName>' => [
'CapacityUnits' => <float>,
'ReadCapacityUnits' => <float>,
'WriteCapacityUnits' => <float>,
],
// ...
],
'LocalSecondaryIndexes' => [
'<IndexName>' => [
'CapacityUnits' => <float>,
'ReadCapacityUnits' => <float>,
'WriteCapacityUnits' => <float>,
],
// ...
],
'ReadCapacityUnits' => <float>,
'Table' => [
'CapacityUnits' => <float>,
'ReadCapacityUnits' => <float>,
'WriteCapacityUnits' => <float>,
],
'TableName' => '<string>',
'WriteCapacityUnits' => <float>,
],
// ...
],
'Responses' => [
[
'Item' => [
'<AttributeName>' => [
'B' => <string || resource || Psr\Http\Message\StreamInterface>,
'BOOL' => true || false,
'BS' => [<string || resource || Psr\Http\Message\StreamInterface>, ...],
'L' => [
[...], // RECURSIVE
// ...
],
'M' => [
'<AttributeName>' => [...], // RECURSIVE
// ...
],
'N' => '<string>',
'NS' => ['<string>', ...],
'NULL' => true || false,
'S' => '<string>',
'SS' => ['<string>', ...],
],
// ...
],
],
// ...
],
]Result Details Members
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.
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.
The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be ACTIVE.
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.
If using Java, DynamoDB lists the cancellation reasons on the CancellationReasons property. This property is not set for other languages. 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.
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.
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.
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.
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.
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 field in the returned exception. The Amazon Web Services 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 in the Amazon DynamoDB Developer Guide.
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 field in the returned exception. Contact Amazon Web ServicesSupport to request a quota increase.
An error occurred on the server side.
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 field in the returned exception.
$result = $client->transactWriteItems([/* ... */]); $promise = $client->transactWriteItemsAsync([/* ... */]);
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 Amazon Web Services 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.
$result = $client->transactWriteItems([
'ClientRequestToken' => '<string>',
'ReturnConsumedCapacity' => 'INDEXES|TOTAL|NONE',
'ReturnItemCollectionMetrics' => 'SIZE|NONE',
'TransactItems' => [ // REQUIRED
[
'ConditionCheck' => [
'ConditionExpression' => '<string>', // REQUIRED
'ExpressionAttributeNames' => ['<string>', ...],
'ExpressionAttributeValues' => [
'<ExpressionAttributeValueVariable>' => [
'B' => <string || resource || Psr\Http\Message\StreamInterface>,
'BOOL' => true || false,
'BS' => [<string || resource || Psr\Http\Message\StreamInterface>, ...],
'L' => [
[...], // RECURSIVE
// ...
],
'M' => [
'<AttributeName>' => [...], // RECURSIVE
// ...
],
'N' => '<string>',
'NS' => ['<string>', ...],
'NULL' => true || false,
'S' => '<string>',
'SS' => ['<string>', ...],
],
// ...
],
'Key' => [ // REQUIRED
'<AttributeName>' => [
'B' => <string || resource || Psr\Http\Message\StreamInterface>,
'BOOL' => true || false,
'BS' => [<string || resource || Psr\Http\Message\StreamInterface>, ...],
'L' => [
[...], // RECURSIVE
// ...
],
'M' => [
'<AttributeName>' => [...], // RECURSIVE
// ...
],
'N' => '<string>',
'NS' => ['<string>', ...],
'NULL' => true || false,
'S' => '<string>',
'SS' => ['<string>', ...],
],
// ...
],
'ReturnValuesOnConditionCheckFailure' => 'ALL_OLD|NONE',
'TableName' => '<string>', // REQUIRED
],
'Delete' => [
'ConditionExpression' => '<string>',
'ExpressionAttributeNames' => ['<string>', ...],
'ExpressionAttributeValues' => [
'<ExpressionAttributeValueVariable>' => [
'B' => <string || resource || Psr\Http\Message\StreamInterface>,
'BOOL' => true || false,
'BS' => [<string || resource || Psr\Http\Message\StreamInterface>, ...],
'L' => [
[...], // RECURSIVE
// ...
],
'M' => [
'<AttributeName>' => [...], // RECURSIVE
// ...
],
'N' => '<string>',
'NS' => ['<string>', ...],
'NULL' => true || false,
'S' => '<string>',
'SS' => ['<string>', ...],
],
// ...
],
'Key' => [ // REQUIRED
'<AttributeName>' => [
'B' => <string || resource || Psr\Http\Message\StreamInterface>,
'BOOL' => true || false,
'BS' => [<string || resource || Psr\Http\Message\StreamInterface>, ...],
'L' => [
[...], // RECURSIVE
// ...
],
'M' => [
'<AttributeName>' => [...], // RECURSIVE
// ...
],
'N' => '<string>',
'NS' => ['<string>', ...],
'NULL' => true || false,
'S' => '<string>',
'SS' => ['<string>', ...],
],
// ...
],
'ReturnValuesOnConditionCheckFailure' => 'ALL_OLD|NONE',
'TableName' => '<string>', // REQUIRED
],
'Put' => [
'ConditionExpression' => '<string>',
'ExpressionAttributeNames' => ['<string>', ...],
'ExpressionAttributeValues' => [
'<ExpressionAttributeValueVariable>' => [
'B' => <string || resource || Psr\Http\Message\StreamInterface>,
'BOOL' => true || false,
'BS' => [<string || resource || Psr\Http\Message\StreamInterface>, ...],
'L' => [
[...], // RECURSIVE
// ...
],
'M' => [
'<AttributeName>' => [...], // RECURSIVE
// ...
],
'N' => '<string>',
'NS' => ['<string>', ...],
'NULL' => true || false,
'S' => '<string>',
'SS' => ['<string>', ...],
],
// ...
],
'Item' => [ // REQUIRED
'<AttributeName>' => [
'B' => <string || resource || Psr\Http\Message\StreamInterface>,
'BOOL' => true || false,
'BS' => [<string || resource || Psr\Http\Message\StreamInterface>, ...],
'L' => [
[...], // RECURSIVE
// ...
],
'M' => [
'<AttributeName>' => [...], // RECURSIVE
// ...
],
'N' => '<string>',
'NS' => ['<string>', ...],
'NULL' => true || false,
'S' => '<string>',
'SS' => ['<string>', ...],
],
// ...
],
'ReturnValuesOnConditionCheckFailure' => 'ALL_OLD|NONE',
'TableName' => '<string>', // REQUIRED
],
'Update' => [
'ConditionExpression' => '<string>',
'ExpressionAttributeNames' => ['<string>', ...],
'ExpressionAttributeValues' => [
'<ExpressionAttributeValueVariable>' => [
'B' => <string || resource || Psr\Http\Message\StreamInterface>,
'BOOL' => true || false,
'BS' => [<string || resource || Psr\Http\Message\StreamInterface>, ...],
'L' => [
[...], // RECURSIVE
// ...
],
'M' => [
'<AttributeName>' => [...], // RECURSIVE
// ...
],
'N' => '<string>',
'NS' => ['<string>', ...],
'NULL' => true || false,
'S' => '<string>',
'SS' => ['<string>', ...],
],
// ...
],
'Key' => [ // REQUIRED
'<AttributeName>' => [
'B' => <string || resource || Psr\Http\Message\StreamInterface>,
'BOOL' => true || false,
'BS' => [<string || resource || Psr\Http\Message\StreamInterface>, ...],
'L' => [
[...], // RECURSIVE
// ...
],
'M' => [
'<AttributeName>' => [...], // RECURSIVE
// ...
],
'N' => '<string>',
'NS' => ['<string>', ...],
'NULL' => true || false,
'S' => '<string>',
'SS' => ['<string>', ...],
],
// ...
],
'ReturnValuesOnConditionCheckFailure' => 'ALL_OLD|NONE',
'TableName' => '<string>', // REQUIRED
'UpdateExpression' => '<string>', // REQUIRED
],
],
// ...
],
]);
Parameter Details Members
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.
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.
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.
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 Amazon Web Services account and Region, and no two of them can operate on the same item.
[
'ConsumedCapacity' => [
[
'CapacityUnits' => <float>,
'GlobalSecondaryIndexes' => [
'<IndexName>' => [
'CapacityUnits' => <float>,
'ReadCapacityUnits' => <float>,
'WriteCapacityUnits' => <float>,
],
// ...
],
'LocalSecondaryIndexes' => [
'<IndexName>' => [
'CapacityUnits' => <float>,
'ReadCapacityUnits' => <float>,
'WriteCapacityUnits' => <float>,
],
// ...
],
'ReadCapacityUnits' => <float>,
'Table' => [
'CapacityUnits' => <float>,
'ReadCapacityUnits' => <float>,
'WriteCapacityUnits' => <float>,
],
'TableName' => '<string>',
'WriteCapacityUnits' => <float>,
],
// ...
],
'ItemCollectionMetrics' => [
'<TableArn>' => [
[
'ItemCollectionKey' => [
'<AttributeName>' => [
'B' => <string || resource || Psr\Http\Message\StreamInterface>,
'BOOL' => true || false,
'BS' => [<string || resource || Psr\Http\Message\StreamInterface>, ...],
'L' => [
[...], // RECURSIVE
// ...
],
'M' => [
'<AttributeName>' => [...], // RECURSIVE
// ...
],
'N' => '<string>',
'NS' => ['<string>', ...],
'NULL' => true || false,
'S' => '<string>',
'SS' => ['<string>', ...],
],
// ...
],
'SizeEstimateRangeGB' => [<float>, ...],
],
// ...
],
// ...
],
]Result Details Members
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.
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.
The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be ACTIVE.
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.
If using Java, DynamoDB lists the cancellation reasons on the CancellationReasons property. This property is not set for other languages. 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.
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.
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.
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.
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.
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, 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 * 2, exponential backoff)
3500-4500 third attempt
4500-6500 third sleep/delay (500 * 2^2)
6500-7500 fourth attempt (this can trigger inline recovery since 5 seconds have elapsed since the first attempt reached TC)
DynamoDB rejected the request because you retried a request with a different payload but with an idempotent token that was already used.
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 field in the returned exception. The Amazon Web Services 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 in the Amazon DynamoDB Developer Guide.
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 field in the returned exception. Contact Amazon Web ServicesSupport to request a quota increase.
An error occurred on the server side.
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 field in the returned exception.
$result = $client->untagResource([/* ... */]); $promise = $client->untagResourceAsync([/* ... */]);
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 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 in the Amazon DynamoDB Developer Guide.
Parameter Syntax$result = $client->untagResource([
'ResourceArn' => '<string>', // REQUIRED
'TagKeys' => ['<string>', ...], // REQUIRED
]);
Parameter Details Members
The DynamoDB resource that the tags will be removed from. This value is an Amazon Resource Name (ARN).
A list of tag keys. Existing tags of the resource whose keys are members of this list will be removed from the DynamoDB resource.
[]Result Details
The results for this operation are always empty.
ErrorsThere 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.
The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be ACTIVE.
An error occurred on the server side.
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.
$result = $client->updateContinuousBackups([/* ... */]); $promise = $client->updateContinuousBackupsAsync([/* ... */]);
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.
$result = $client->updateContinuousBackups([
'PointInTimeRecoverySpecification' => [ // REQUIRED
'PointInTimeRecoveryEnabled' => true || false, // REQUIRED
'RecoveryPeriodInDays' => <integer>,
],
'TableName' => '<string>', // REQUIRED
]);
Parameter Details Members
Represents the settings used to enable point in time recovery.
The name of the table. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.
[
'ContinuousBackupsDescription' => [
'ContinuousBackupsStatus' => 'ENABLED|DISABLED',
'PointInTimeRecoveryDescription' => [
'EarliestRestorableDateTime' => <DateTime>,
'LatestRestorableDateTime' => <DateTime>,
'PointInTimeRecoveryStatus' => 'ENABLED|DISABLED',
'RecoveryPeriodInDays' => <integer>,
],
],
]Result Details Members
Represents the continuous backups and point in time recovery settings on the table.
A source table with the name TableName does not currently exist within the subscriber's account or the subscriber is operating in the wrong Amazon Web Services Region.
Backups have not yet been enabled for this table.
An error occurred on the server side.
$result = $client->updateContributorInsights([/* ... */]); $promise = $client->updateContributorInsightsAsync([/* ... */]);
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 Amazon Web Services Key Management Service (KMS) to encrypt this tableâs partition key and sort key data with an Amazon Web Services managed key or customer managed key, you should not enable CloudWatch Contributor Insights for DynamoDB for this table.
Parameter Syntax$result = $client->updateContributorInsights([
'ContributorInsightsAction' => 'ENABLE|DISABLE', // REQUIRED
'ContributorInsightsMode' => 'ACCESSED_AND_THROTTLED_KEYS|THROTTLED_KEYS',
'IndexName' => '<string>',
'TableName' => '<string>', // REQUIRED
]);
Parameter Details Members
Represents the contributor insights action.
Specifies whether to track all access and throttled events or throttled events only for the DynamoDB table or index.
The global secondary index name, if applicable.
The name of the table. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.
[
'ContributorInsightsMode' => 'ACCESSED_AND_THROTTLED_KEYS|THROTTLED_KEYS',
'ContributorInsightsStatus' => 'ENABLING|ENABLED|DISABLING|DISABLED|FAILED',
'IndexName' => '<string>',
'TableName' => '<string>',
]Result Details Members
The updated mode of CloudWatch Contributor Insights that determines whether to monitor all access and throttled events or to track throttled events exclusively.
The status of contributor insights
The name of the global secondary index, if applicable.
The name of the table.
The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be ACTIVE.
An error occurred on the server side.
$result = $client->updateGlobalTable([/* ... */]); $promise = $client->updateGlobalTableAsync([/* ... */]);
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.
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) 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. To update existing global tables from version 2017.11.29 (Legacy) to version 2019.11.21 (Current), see Upgrading global tables.
If you are using global tables Version 2019.11.21 (Current) you can use UpdateTable 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.
$result = $client->updateGlobalTable([
'GlobalTableName' => '<string>', // REQUIRED
'ReplicaUpdates' => [ // REQUIRED
[
'Create' => [
'RegionName' => '<string>', // REQUIRED
],
'Delete' => [
'RegionName' => '<string>', // REQUIRED
],
],
// ...
],
]);
Parameter Details Members
The global table name.
A list of Regions that should be added or removed from the global table.
[
'GlobalTableDescription' => [
'CreationDateTime' => <DateTime>,
'GlobalTableArn' => '<string>',
'GlobalTableName' => '<string>',
'GlobalTableStatus' => 'CREATING|ACTIVE|DELETING|UPDATING',
'ReplicationGroup' => [
[
'GlobalSecondaryIndexes' => [
[
'IndexName' => '<string>',
'OnDemandThroughputOverride' => [
'MaxReadRequestUnits' => <integer>,
],
'ProvisionedThroughputOverride' => [
'ReadCapacityUnits' => <integer>,
],
'WarmThroughput' => [
'ReadUnitsPerSecond' => <integer>,
'Status' => 'CREATING|UPDATING|DELETING|ACTIVE',
'WriteUnitsPerSecond' => <integer>,
],
],
// ...
],
'KMSMasterKeyId' => '<string>',
'OnDemandThroughputOverride' => [
'MaxReadRequestUnits' => <integer>,
],
'ProvisionedThroughputOverride' => [
'ReadCapacityUnits' => <integer>,
],
'RegionName' => '<string>',
'ReplicaInaccessibleDateTime' => <DateTime>,
'ReplicaStatus' => 'CREATING|CREATION_FAILED|UPDATING|DELETING|ACTIVE|REGION_DISABLED|INACCESSIBLE_ENCRYPTION_CREDENTIALS|ARCHIVING|ARCHIVED|REPLICATION_NOT_AUTHORIZED',
'ReplicaStatusDescription' => '<string>',
'ReplicaStatusPercentProgress' => '<string>',
'ReplicaTableClassSummary' => [
'LastUpdateDateTime' => <DateTime>,
'TableClass' => 'STANDARD|STANDARD_INFREQUENT_ACCESS',
],
'WarmThroughput' => [
'ReadUnitsPerSecond' => <integer>,
'Status' => 'CREATING|UPDATING|DELETING|ACTIVE|INACCESSIBLE_ENCRYPTION_CREDENTIALS|ARCHIVING|ARCHIVED|REPLICATION_NOT_AUTHORIZED',
'WriteUnitsPerSecond' => <integer>,
],
],
// ...
],
],
]Result Details Members
Contains the details of the global table.
An error occurred on the server side.
The specified global table does not exist.
The specified replica is already part of the global table.
The specified replica is no longer part of the global table.
A source table with the name TableName does not currently exist within the subscriber's account or the subscriber is operating in the wrong Amazon Web Services Region.
$result = $client->updateGlobalTableSettings([/* ... */]); $promise = $client->updateGlobalTableSettingsAsync([/* ... */]);
Updates settings for a global table.
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) 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. To update existing global tables from version 2017.11.29 (Legacy) to version 2019.11.21 (Current), see Upgrading global tables.
Parameter Syntax$result = $client->updateGlobalTableSettings([
'GlobalTableBillingMode' => 'PROVISIONED|PAY_PER_REQUEST',
'GlobalTableGlobalSecondaryIndexSettingsUpdate' => [
[
'IndexName' => '<string>', // REQUIRED
'ProvisionedWriteCapacityAutoScalingSettingsUpdate' => [
'AutoScalingDisabled' => true || false,
'AutoScalingRoleArn' => '<string>',
'MaximumUnits' => <integer>,
'MinimumUnits' => <integer>,
'ScalingPolicyUpdate' => [
'PolicyName' => '<string>',
'TargetTrackingScalingPolicyConfiguration' => [ // REQUIRED
'DisableScaleIn' => true || false,
'ScaleInCooldown' => <integer>,
'ScaleOutCooldown' => <integer>,
'TargetValue' => <float>, // REQUIRED
],
],
],
'ProvisionedWriteCapacityUnits' => <integer>,
],
// ...
],
'GlobalTableName' => '<string>', // REQUIRED
'GlobalTableProvisionedWriteCapacityAutoScalingSettingsUpdate' => [
'AutoScalingDisabled' => true || false,
'AutoScalingRoleArn' => '<string>',
'MaximumUnits' => <integer>,
'MinimumUnits' => <integer>,
'ScalingPolicyUpdate' => [
'PolicyName' => '<string>',
'TargetTrackingScalingPolicyConfiguration' => [ // REQUIRED
'DisableScaleIn' => true || false,
'ScaleInCooldown' => <integer>,
'ScaleOutCooldown' => <integer>,
'TargetValue' => <float>, // REQUIRED
],
],
],
'GlobalTableProvisionedWriteCapacityUnits' => <integer>,
'ReplicaSettingsUpdate' => [
[
'RegionName' => '<string>', // REQUIRED
'ReplicaGlobalSecondaryIndexSettingsUpdate' => [
[
'IndexName' => '<string>', // REQUIRED
'ProvisionedReadCapacityAutoScalingSettingsUpdate' => [
'AutoScalingDisabled' => true || false,
'AutoScalingRoleArn' => '<string>',
'MaximumUnits' => <integer>,
'MinimumUnits' => <integer>,
'ScalingPolicyUpdate' => [
'PolicyName' => '<string>',
'TargetTrackingScalingPolicyConfiguration' => [ // REQUIRED
'DisableScaleIn' => true || false,
'ScaleInCooldown' => <integer>,
'ScaleOutCooldown' => <integer>,
'TargetValue' => <float>, // REQUIRED
],
],
],
'ProvisionedReadCapacityUnits' => <integer>,
],
// ...
],
'ReplicaProvisionedReadCapacityAutoScalingSettingsUpdate' => [
'AutoScalingDisabled' => true || false,
'AutoScalingRoleArn' => '<string>',
'MaximumUnits' => <integer>,
'MinimumUnits' => <integer>,
'ScalingPolicyUpdate' => [
'PolicyName' => '<string>',
'TargetTrackingScalingPolicyConfiguration' => [ // REQUIRED
'DisableScaleIn' => true || false,
'ScaleInCooldown' => <integer>,
'ScaleOutCooldown' => <integer>,
'TargetValue' => <float>, // REQUIRED
],
],
],
'ReplicaProvisionedReadCapacityUnits' => <integer>,
'ReplicaTableClass' => 'STANDARD|STANDARD_INFREQUENT_ACCESS',
],
// ...
],
]);
Parameter Details Members
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.
PAY_PER_REQUEST - We recommend using PAY_PER_REQUEST for unpredictable workloads. PAY_PER_REQUEST sets the billing mode to On-demand capacity mode.
Represents the settings of a global secondary index for a global table that will be modified.
The name of the global table
Auto scaling settings for managing provisioned write capacity for the global table.
The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException.
Represents the settings for a global table in a Region that will be modified.
[
'GlobalTableName' => '<string>',
'ReplicaSettings' => [
[
'RegionName' => '<string>',
'ReplicaBillingModeSummary' => [
'BillingMode' => 'PROVISIONED|PAY_PER_REQUEST',
'LastUpdateToPayPerRequestDateTime' => <DateTime>,
],
'ReplicaGlobalSecondaryIndexSettings' => [
[
'IndexName' => '<string>',
'IndexStatus' => 'CREATING|UPDATING|DELETING|ACTIVE',
'ProvisionedReadCapacityAutoScalingSettings' => [
'AutoScalingDisabled' => true || false,
'AutoScalingRoleArn' => '<string>',
'MaximumUnits' => <integer>,
'MinimumUnits' => <integer>,
'ScalingPolicies' => [
[
'PolicyName' => '<string>',
'TargetTrackingScalingPolicyConfiguration' => [
'DisableScaleIn' => true || false,
'ScaleInCooldown' => <integer>,
'ScaleOutCooldown' => <integer>,
'TargetValue' => <float>,
],
],
// ...
],
],
'ProvisionedReadCapacityUnits' => <integer>,
'ProvisionedWriteCapacityAutoScalingSettings' => [
'AutoScalingDisabled' => true || false,
'AutoScalingRoleArn' => '<string>',
'MaximumUnits' => <integer>,
'MinimumUnits' => <integer>,
'ScalingPolicies' => [
[
'PolicyName' => '<string>',
'TargetTrackingScalingPolicyConfiguration' => [
'DisableScaleIn' => true || false,
'ScaleInCooldown' => <integer>,
'ScaleOutCooldown' => <integer>,
'TargetValue' => <float>,
],
],
// ...
],
],
'ProvisionedWriteCapacityUnits' => <integer>,
],
// ...
],
'ReplicaProvisionedReadCapacityAutoScalingSettings' => [
'AutoScalingDisabled' => true || false,
'AutoScalingRoleArn' => '<string>',
'MaximumUnits' => <integer>,
'MinimumUnits' => <integer>,
'ScalingPolicies' => [
[
'PolicyName' => '<string>',
'TargetTrackingScalingPolicyConfiguration' => [
'DisableScaleIn' => true || false,
'ScaleInCooldown' => <integer>,
'ScaleOutCooldown' => <integer>,
'TargetValue' => <float>,
],
],
// ...
],
],
'ReplicaProvisionedReadCapacityUnits' => <integer>,
'ReplicaProvisionedWriteCapacityAutoScalingSettings' => [
'AutoScalingDisabled' => true || false,
'AutoScalingRoleArn' => '<string>',
'MaximumUnits' => <integer>,
'MinimumUnits' => <integer>,
'ScalingPolicies' => [
[
'PolicyName' => '<string>',
'TargetTrackingScalingPolicyConfiguration' => [
'DisableScaleIn' => true || false,
'ScaleInCooldown' => <integer>,
'ScaleOutCooldown' => <integer>,
'TargetValue' => <float>,
],
],
// ...
],
],
'ReplicaProvisionedWriteCapacityUnits' => <integer>,
'ReplicaStatus' => 'CREATING|CREATION_FAILED|UPDATING|DELETING|ACTIVE|REGION_DISABLED|INACCESSIBLE_ENCRYPTION_CREDENTIALS|ARCHIVING|ARCHIVED|REPLICATION_NOT_AUTHORIZED',
'ReplicaTableClassSummary' => [
'LastUpdateDateTime' => <DateTime>,
'TableClass' => 'STANDARD|STANDARD_INFREQUENT_ACCESS',
],
],
// ...
],
]Result Details Members
The name of the global table.
The Region-specific settings for the global table.
The specified global table does not exist.
The specified replica is no longer part of the global table.
The operation tried to access a nonexistent index.
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.
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.
An error occurred on the server side.
$result = $client->updateItem([/* ... */]); $promise = $client->updateItemAsync([/* ... */]);
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.
$result = $client->updateItem([
'AttributeUpdates' => [
'<AttributeName>' => [
'Action' => 'ADD|PUT|DELETE',
'Value' => [
'B' => <string || resource || Psr\Http\Message\StreamInterface>,
'BOOL' => true || false,
'BS' => [<string || resource || Psr\Http\Message\StreamInterface>, ...],
'L' => [
[...], // RECURSIVE
// ...
],
'M' => [
'<AttributeName>' => [...], // RECURSIVE
// ...
],
'N' => '<string>',
'NS' => ['<string>', ...],
'NULL' => true || false,
'S' => '<string>',
'SS' => ['<string>', ...],
],
],
// ...
],
'ConditionExpression' => '<string>',
'ConditionalOperator' => 'AND|OR',
'Expected' => [
'<AttributeName>' => [
'AttributeValueList' => [
[
'B' => <string || resource || Psr\Http\Message\StreamInterface>,
'BOOL' => true || false,
'BS' => [<string || resource || Psr\Http\Message\StreamInterface>, ...],
'L' => [
[...], // RECURSIVE
// ...
],
'M' => [
'<AttributeName>' => [...], // RECURSIVE
// ...
],
'N' => '<string>',
'NS' => ['<string>', ...],
'NULL' => true || false,
'S' => '<string>',
'SS' => ['<string>', ...],
],
// ...
],
'ComparisonOperator' => 'EQ|NE|IN|LE|LT|GE|GT|BETWEEN|NOT_NULL|NULL|CONTAINS|NOT_CONTAINS|BEGINS_WITH',
'Exists' => true || false,
'Value' => [
'B' => <string || resource || Psr\Http\Message\StreamInterface>,
'BOOL' => true || false,
'BS' => [<string || resource || Psr\Http\Message\StreamInterface>, ...],
'L' => [
[...], // RECURSIVE
// ...
],
'M' => [
'<AttributeName>' => [...], // RECURSIVE
// ...
],
'N' => '<string>',
'NS' => ['<string>', ...],
'NULL' => true || false,
'S' => '<string>',
'SS' => ['<string>', ...],
],
],
// ...
],
'ExpressionAttributeNames' => ['<string>', ...],
'ExpressionAttributeValues' => [
'<ExpressionAttributeValueVariable>' => [
'B' => <string || resource || Psr\Http\Message\StreamInterface>,
'BOOL' => true || false,
'BS' => [<string || resource || Psr\Http\Message\StreamInterface>, ...],
'L' => [
[...], // RECURSIVE
// ...
],
'M' => [
'<AttributeName>' => [...], // RECURSIVE
// ...
],
'N' => '<string>',
'NS' => ['<string>', ...],
'NULL' => true || false,
'S' => '<string>',
'SS' => ['<string>', ...],
],
// ...
],
'Key' => [ // REQUIRED
'<AttributeName>' => [
'B' => <string || resource || Psr\Http\Message\StreamInterface>,
'BOOL' => true || false,
'BS' => [<string || resource || Psr\Http\Message\StreamInterface>, ...],
'L' => [
[...], // RECURSIVE
// ...
],
'M' => [
'<AttributeName>' => [...], // RECURSIVE
// ...
],
'N' => '<string>',
'NS' => ['<string>', ...],
'NULL' => true || false,
'S' => '<string>',
'SS' => ['<string>', ...],
],
// ...
],
'ReturnConsumedCapacity' => 'INDEXES|TOTAL|NONE',
'ReturnItemCollectionMetrics' => 'SIZE|NONE',
'ReturnValues' => 'NONE|ALL_OLD|UPDATED_OLD|ALL_NEW|UPDATED_NEW',
'ReturnValuesOnConditionCheckFailure' => 'ALL_OLD|NONE',
'TableName' => '<string>', // REQUIRED
'UpdateExpression' => '<string>',
]);
Parameter Details Members
This is a legacy parameter. Use UpdateExpression instead. For more information, see AttributeUpdates in the Amazon DynamoDB Developer Guide.
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 in the Amazon DynamoDB Developer Guide.
This is a legacy parameter. Use ConditionExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.
This is a legacy parameter. Use ConditionExpression instead. For more information, see Expected in the Amazon DynamoDB Developer Guide.
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 # 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 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 in the Amazon DynamoDB Developer Guide.
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 in the Amazon DynamoDB Developer Guide.
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.
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.
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.
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.
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.
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.
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.
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.
The ADD action only supports Number and set data types. In addition, ADD can only be used on top-level attributes, not nested attributes.
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.
The DELETE action only supports set data types. In addition, DELETE can only be used on top-level attributes, not nested attributes.
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 in the Amazon DynamoDB Developer Guide.
[
'Attributes' => [
'<AttributeName>' => [
'B' => <string || resource || Psr\Http\Message\StreamInterface>,
'BOOL' => true || false,
'BS' => [<string || resource || Psr\Http\Message\StreamInterface>, ...],
'L' => [
[...], // RECURSIVE
// ...
],
'M' => [
'<AttributeName>' => [...], // RECURSIVE
// ...
],
'N' => '<string>',
'NS' => ['<string>', ...],
'NULL' => true || false,
'S' => '<string>',
'SS' => ['<string>', ...],
],
// ...
],
'ConsumedCapacity' => [
'CapacityUnits' => <float>,
'GlobalSecondaryIndexes' => [
'<IndexName>' => [
'CapacityUnits' => <float>,
'ReadCapacityUnits' => <float>,
'WriteCapacityUnits' => <float>,
],
// ...
],
'LocalSecondaryIndexes' => [
'<IndexName>' => [
'CapacityUnits' => <float>,
'ReadCapacityUnits' => <float>,
'WriteCapacityUnits' => <float>,
],
// ...
],
'ReadCapacityUnits' => <float>,
'Table' => [
'CapacityUnits' => <float>,
'ReadCapacityUnits' => <float>,
'WriteCapacityUnits' => <float>,
],
'TableName' => '<string>',
'WriteCapacityUnits' => <float>,
],
'ItemCollectionMetrics' => [
'ItemCollectionKey' => [
'<AttributeName>' => [
'B' => <string || resource || Psr\Http\Message\StreamInterface>,
'BOOL' => true || false,
'BS' => [<string || resource || Psr\Http\Message\StreamInterface>, ...],
'L' => [
[...], // RECURSIVE
// ...
],
'M' => [
'<AttributeName>' => [...], // RECURSIVE
// ...
],
'N' => '<string>',
'NS' => ['<string>', ...],
'NULL' => true || false,
'S' => '<string>',
'SS' => ['<string>', ...],
],
// ...
],
'SizeEstimateRangeGB' => [<float>, ...],
],
]Result Details Members
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.
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 in the Amazon DynamoDB Developer Guide.
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.
A condition specified in the operation failed to be evaluated.
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 field in the returned exception. The Amazon Web Services 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 in the Amazon DynamoDB Developer Guide.
The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be ACTIVE.
An item collection is too large. This exception is only returned for tables that have one or more local secondary indexes.
Operation was rejected because there is an ongoing transaction for the item.
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 field in the returned exception. Contact Amazon Web ServicesSupport to request a quota increase.
An error occurred on the server side.
The request was rejected because one or more items in the request are being modified by a request in another Region.
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 field in the returned exception.
This example updates an item in the Music table. It adds a new attribute (Year) and modifies the AlbumTitle attribute. All of the attributes in the item, as they appear after the update, are returned in the response.
$result = $client->updateItem([
'ExpressionAttributeNames' => [
'#AT' => 'AlbumTitle',
'#Y' => 'Year',
],
'ExpressionAttributeValues' => [
':t' => [
'S' => 'Louder Than Ever',
],
':y' => [
'N' => '2015',
],
],
'Key' => [
'Artist' => [
'S' => 'Acme Band',
],
'SongTitle' => [
'S' => 'Happy Day',
],
],
'ReturnValues' => 'ALL_NEW',
'TableName' => 'Music',
'UpdateExpression' => 'SET #Y = :y, #AT = :t',
]);
Result syntax:
[
'Attributes' => [
'AlbumTitle' => [
'S' => 'Louder Than Ever',
],
'Artist' => [
'S' => 'Acme Band',
],
'SongTitle' => [
'S' => 'Happy Day',
],
'Year' => [
'N' => '2015',
],
],
] UpdateKinesisStreamingDestination
$result = $client->updateKinesisStreamingDestination([/* ... */]); $promise = $client->updateKinesisStreamingDestinationAsync([/* ... */]);
The command to update the Kinesis stream destination.
Parameter Syntax$result = $client->updateKinesisStreamingDestination([
'StreamArn' => '<string>', // REQUIRED
'TableName' => '<string>', // REQUIRED
'UpdateKinesisStreamingConfiguration' => [
'ApproximateCreationDateTimePrecision' => 'MILLISECOND|MICROSECOND',
],
]);
Parameter Details Members
The Amazon Resource Name (ARN) for the Kinesis stream input.
The table name for the Kinesis streaming destination input. You can also provide the ARN of the table in this parameter.
The command to update the Kinesis stream configuration.
[
'DestinationStatus' => 'ENABLING|ACTIVE|DISABLING|DISABLED|ENABLE_FAILED|UPDATING',
'StreamArn' => '<string>',
'TableName' => '<string>',
'UpdateKinesisStreamingConfiguration' => [
'ApproximateCreationDateTimePrecision' => 'MILLISECOND|MICROSECOND',
],
]Result Details Members
The status of the attempt to update the Kinesis streaming destination output.
The ARN for the Kinesis stream input.
The table name for the Kinesis streaming destination output.
The command to update the Kinesis streaming destination configuration.
An error occurred on the server side.
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.
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.
The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be ACTIVE.
$result = $client->updateTable([/* ... */]); $promise = $client->updateTableAsync([/* ... */]);
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.
$result = $client->updateTable([
'AttributeDefinitions' => [
[
'AttributeName' => '<string>', // REQUIRED
'AttributeType' => 'S|N|B', // REQUIRED
],
// ...
],
'BillingMode' => 'PROVISIONED|PAY_PER_REQUEST',
'DeletionProtectionEnabled' => true || false,
'GlobalSecondaryIndexUpdates' => [
[
'Create' => [
'IndexName' => '<string>', // REQUIRED
'KeySchema' => [ // REQUIRED
[
'AttributeName' => '<string>', // REQUIRED
'KeyType' => 'HASH|RANGE', // REQUIRED
],
// ...
],
'OnDemandThroughput' => [
'MaxReadRequestUnits' => <integer>,
'MaxWriteRequestUnits' => <integer>,
],
'Projection' => [ // REQUIRED
'NonKeyAttributes' => ['<string>', ...],
'ProjectionType' => 'ALL|KEYS_ONLY|INCLUDE',
],
'ProvisionedThroughput' => [
'ReadCapacityUnits' => <integer>, // REQUIRED
'WriteCapacityUnits' => <integer>, // REQUIRED
],
'WarmThroughput' => [
'ReadUnitsPerSecond' => <integer>,
'WriteUnitsPerSecond' => <integer>,
],
],
'Delete' => [
'IndexName' => '<string>', // REQUIRED
],
'Update' => [
'IndexName' => '<string>', // REQUIRED
'OnDemandThroughput' => [
'MaxReadRequestUnits' => <integer>,
'MaxWriteRequestUnits' => <integer>,
],
'ProvisionedThroughput' => [
'ReadCapacityUnits' => <integer>, // REQUIRED
'WriteCapacityUnits' => <integer>, // REQUIRED
],
'WarmThroughput' => [
'ReadUnitsPerSecond' => <integer>,
'WriteUnitsPerSecond' => <integer>,
],
],
],
// ...
],
'GlobalTableWitnessUpdates' => [
[
'Create' => [
'RegionName' => '<string>', // REQUIRED
],
'Delete' => [
'RegionName' => '<string>', // REQUIRED
],
],
// ...
],
'MultiRegionConsistency' => 'EVENTUAL|STRONG',
'OnDemandThroughput' => [
'MaxReadRequestUnits' => <integer>,
'MaxWriteRequestUnits' => <integer>,
],
'ProvisionedThroughput' => [
'ReadCapacityUnits' => <integer>, // REQUIRED
'WriteCapacityUnits' => <integer>, // REQUIRED
],
'ReplicaUpdates' => [
[
'Create' => [
'GlobalSecondaryIndexes' => [
[
'IndexName' => '<string>', // REQUIRED
'OnDemandThroughputOverride' => [
'MaxReadRequestUnits' => <integer>,
],
'ProvisionedThroughputOverride' => [
'ReadCapacityUnits' => <integer>,
],
],
// ...
],
'KMSMasterKeyId' => '<string>',
'OnDemandThroughputOverride' => [
'MaxReadRequestUnits' => <integer>,
],
'ProvisionedThroughputOverride' => [
'ReadCapacityUnits' => <integer>,
],
'RegionName' => '<string>', // REQUIRED
'TableClassOverride' => 'STANDARD|STANDARD_INFREQUENT_ACCESS',
],
'Delete' => [
'RegionName' => '<string>', // REQUIRED
],
'Update' => [
'GlobalSecondaryIndexes' => [
[
'IndexName' => '<string>', // REQUIRED
'OnDemandThroughputOverride' => [
'MaxReadRequestUnits' => <integer>,
],
'ProvisionedThroughputOverride' => [
'ReadCapacityUnits' => <integer>,
],
],
// ...
],
'KMSMasterKeyId' => '<string>',
'OnDemandThroughputOverride' => [
'MaxReadRequestUnits' => <integer>,
],
'ProvisionedThroughputOverride' => [
'ReadCapacityUnits' => <integer>,
],
'RegionName' => '<string>', // REQUIRED
'TableClassOverride' => 'STANDARD|STANDARD_INFREQUENT_ACCESS',
],
],
// ...
],
'SSESpecification' => [
'Enabled' => true || false,
'KMSMasterKeyId' => '<string>',
'SSEType' => 'AES256|KMS',
],
'StreamSpecification' => [
'StreamEnabled' => true || false, // REQUIRED
'StreamViewType' => 'NEW_IMAGE|OLD_IMAGE|NEW_AND_OLD_IMAGES|KEYS_ONLY',
],
'TableClass' => 'STANDARD|STANDARD_INFREQUENT_ACCESS',
'TableName' => '<string>', // REQUIRED
'WarmThroughput' => [
'ReadUnitsPerSecond' => <integer>,
'WriteUnitsPerSecond' => <integer>,
],
]);
Parameter Details Members
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.
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.
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.
Indicates whether deletion protection is to be enabled (true) or disabled (false) on the table.
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 in the Amazon DynamoDB Developer Guide.
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) in the Amazon DynamoDB Developer Guide
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 actions in the 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 in DynamoDB developer guide.
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.
The new provisioned throughput settings for the specified table or index.
A list of replica update actions (create, delete, or update) for the table.
The new server-side encryption settings for the specified table.
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.
The table class of the table to be updated. Valid values are STANDARD and STANDARD_INFREQUENT_ACCESS.
The name of the table to be updated. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.
Represents the warm throughput (in read units per second and write units per second) for updating a table.
[
'TableDescription' => [
'ArchivalSummary' => [
'ArchivalBackupArn' => '<string>',
'ArchivalDateTime' => <DateTime>,
'ArchivalReason' => '<string>',
],
'AttributeDefinitions' => [
[
'AttributeName' => '<string>',
'AttributeType' => 'S|N|B',
],
// ...
],
'BillingModeSummary' => [
'BillingMode' => 'PROVISIONED|PAY_PER_REQUEST',
'LastUpdateToPayPerRequestDateTime' => <DateTime>,
],
'CreationDateTime' => <DateTime>,
'DeletionProtectionEnabled' => true || false,
'GlobalSecondaryIndexes' => [
[
'Backfilling' => true || false,
'IndexArn' => '<string>',
'IndexName' => '<string>',
'IndexSizeBytes' => <integer>,
'IndexStatus' => 'CREATING|UPDATING|DELETING|ACTIVE',
'ItemCount' => <integer>,
'KeySchema' => [
[
'AttributeName' => '<string>',
'KeyType' => 'HASH|RANGE',
],
// ...
],
'OnDemandThroughput' => [
'MaxReadRequestUnits' => <integer>,
'MaxWriteRequestUnits' => <integer>,
],
'Projection' => [
'NonKeyAttributes' => ['<string>', ...],
'ProjectionType' => 'ALL|KEYS_ONLY|INCLUDE',
],
'ProvisionedThroughput' => [
'LastDecreaseDateTime' => <DateTime>,
'LastIncreaseDateTime' => <DateTime>,
'NumberOfDecreasesToday' => <integer>,
'ReadCapacityUnits' => <integer>,
'WriteCapacityUnits' => <integer>,
],
'WarmThroughput' => [
'ReadUnitsPerSecond' => <integer>,
'Status' => 'CREATING|UPDATING|DELETING|ACTIVE',
'WriteUnitsPerSecond' => <integer>,
],
],
// ...
],
'GlobalTableVersion' => '<string>',
'GlobalTableWitnesses' => [
[
'RegionName' => '<string>',
'WitnessStatus' => 'CREATING|DELETING|ACTIVE',
],
// ...
],
'ItemCount' => <integer>,
'KeySchema' => [
[
'AttributeName' => '<string>',
'KeyType' => 'HASH|RANGE',
],
// ...
],
'LatestStreamArn' => '<string>',
'LatestStreamLabel' => '<string>',
'LocalSecondaryIndexes' => [
[
'IndexArn' => '<string>',
'IndexName' => '<string>',
'IndexSizeBytes' => <integer>,
'ItemCount' => <integer>,
'KeySchema' => [
[
'AttributeName' => '<string>',
'KeyType' => 'HASH|RANGE',
],
// ...
],
'Projection' => [
'NonKeyAttributes' => ['<string>', ...],
'ProjectionType' => 'ALL|KEYS_ONLY|INCLUDE',
],
],
// ...
],
'MultiRegionConsistency' => 'EVENTUAL|STRONG',
'OnDemandThroughput' => [
'MaxReadRequestUnits' => <integer>,
'MaxWriteRequestUnits' => <integer>,
],
'ProvisionedThroughput' => [
'LastDecreaseDateTime' => <DateTime>,
'LastIncreaseDateTime' => <DateTime>,
'NumberOfDecreasesToday' => <integer>,
'ReadCapacityUnits' => <integer>,
'WriteCapacityUnits' => <integer>,
],
'Replicas' => [
[
'GlobalSecondaryIndexes' => [
[
'IndexName' => '<string>',
'OnDemandThroughputOverride' => [
'MaxReadRequestUnits' => <integer>,
],
'ProvisionedThroughputOverride' => [
'ReadCapacityUnits' => <integer>,
],
'WarmThroughput' => [
'ReadUnitsPerSecond' => <integer>,
'Status' => 'CREATING|UPDATING|DELETING|ACTIVE',
'WriteUnitsPerSecond' => <integer>,
],
],
// ...
],
'KMSMasterKeyId' => '<string>',
'OnDemandThroughputOverride' => [
'MaxReadRequestUnits' => <integer>,
],
'ProvisionedThroughputOverride' => [
'ReadCapacityUnits' => <integer>,
],
'RegionName' => '<string>',
'ReplicaInaccessibleDateTime' => <DateTime>,
'ReplicaStatus' => 'CREATING|CREATION_FAILED|UPDATING|DELETING|ACTIVE|REGION_DISABLED|INACCESSIBLE_ENCRYPTION_CREDENTIALS|ARCHIVING|ARCHIVED|REPLICATION_NOT_AUTHORIZED',
'ReplicaStatusDescription' => '<string>',
'ReplicaStatusPercentProgress' => '<string>',
'ReplicaTableClassSummary' => [
'LastUpdateDateTime' => <DateTime>,
'TableClass' => 'STANDARD|STANDARD_INFREQUENT_ACCESS',
],
'WarmThroughput' => [
'ReadUnitsPerSecond' => <integer>,
'Status' => 'CREATING|UPDATING|DELETING|ACTIVE|INACCESSIBLE_ENCRYPTION_CREDENTIALS|ARCHIVING|ARCHIVED|REPLICATION_NOT_AUTHORIZED',
'WriteUnitsPerSecond' => <integer>,
],
],
// ...
],
'RestoreSummary' => [
'RestoreDateTime' => <DateTime>,
'RestoreInProgress' => true || false,
'SourceBackupArn' => '<string>',
'SourceTableArn' => '<string>',
],
'SSEDescription' => [
'InaccessibleEncryptionDateTime' => <DateTime>,
'KMSMasterKeyArn' => '<string>',
'SSEType' => 'AES256|KMS',
'Status' => 'ENABLING|ENABLED|DISABLING|DISABLED|UPDATING',
],
'StreamSpecification' => [
'StreamEnabled' => true || false,
'StreamViewType' => 'NEW_IMAGE|OLD_IMAGE|NEW_AND_OLD_IMAGES|KEYS_ONLY',
],
'TableArn' => '<string>',
'TableClassSummary' => [
'LastUpdateDateTime' => <DateTime>,
'TableClass' => 'STANDARD|STANDARD_INFREQUENT_ACCESS',
],
'TableId' => '<string>',
'TableName' => '<string>',
'TableSizeBytes' => <integer>,
'TableStatus' => 'CREATING|UPDATING|DELETING|ACTIVE|INACCESSIBLE_ENCRYPTION_CREDENTIALS|ARCHIVING|ARCHIVED|REPLICATION_NOT_AUTHORIZED',
'WarmThroughput' => [
'ReadUnitsPerSecond' => <integer>,
'Status' => 'CREATING|UPDATING|DELETING|ACTIVE|INACCESSIBLE_ENCRYPTION_CREDENTIALS|ARCHIVING|ARCHIVED|REPLICATION_NOT_AUTHORIZED',
'WriteUnitsPerSecond' => <integer>,
],
],
]Result Details Members
Represents the properties of the table.
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.
The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be ACTIVE.
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.
An error occurred on the server side.
This example increases the provisioned read and write capacity on the Music table.
$result = $client->updateTable([
'ProvisionedThroughput' => [
'ReadCapacityUnits' => 10,
'WriteCapacityUnits' => 10,
],
'TableName' => 'MusicCollection',
]);
Result syntax:
[
'TableDescription' => [
'AttributeDefinitions' => [
[
'AttributeName' => 'Artist',
'AttributeType' => 'S',
],
[
'AttributeName' => 'SongTitle',
'AttributeType' => 'S',
],
],
'CreationDateTime' => ,
'ItemCount' => 0,
'KeySchema' => [
[
'AttributeName' => 'Artist',
'KeyType' => 'HASH',
],
[
'AttributeName' => 'SongTitle',
'KeyType' => 'RANGE',
],
],
'ProvisionedThroughput' => [
'LastIncreaseDateTime' => ,
'NumberOfDecreasesToday' => 1,
'ReadCapacityUnits' => 1,
'WriteCapacityUnits' => 1,
],
'TableName' => 'MusicCollection',
'TableSizeBytes' => 0,
'TableStatus' => 'UPDATING',
],
] UpdateTableReplicaAutoScaling
$result = $client->updateTableReplicaAutoScaling([/* ... */]); $promise = $client->updateTableReplicaAutoScalingAsync([/* ... */]);
Updates auto scaling settings on your global tables at once.
Parameter Syntax$result = $client->updateTableReplicaAutoScaling([
'GlobalSecondaryIndexUpdates' => [
[
'IndexName' => '<string>',
'ProvisionedWriteCapacityAutoScalingUpdate' => [
'AutoScalingDisabled' => true || false,
'AutoScalingRoleArn' => '<string>',
'MaximumUnits' => <integer>,
'MinimumUnits' => <integer>,
'ScalingPolicyUpdate' => [
'PolicyName' => '<string>',
'TargetTrackingScalingPolicyConfiguration' => [ // REQUIRED
'DisableScaleIn' => true || false,
'ScaleInCooldown' => <integer>,
'ScaleOutCooldown' => <integer>,
'TargetValue' => <float>, // REQUIRED
],
],
],
],
// ...
],
'ProvisionedWriteCapacityAutoScalingUpdate' => [
'AutoScalingDisabled' => true || false,
'AutoScalingRoleArn' => '<string>',
'MaximumUnits' => <integer>,
'MinimumUnits' => <integer>,
'ScalingPolicyUpdate' => [
'PolicyName' => '<string>',
'TargetTrackingScalingPolicyConfiguration' => [ // REQUIRED
'DisableScaleIn' => true || false,
'ScaleInCooldown' => <integer>,
'ScaleOutCooldown' => <integer>,
'TargetValue' => <float>, // REQUIRED
],
],
],
'ReplicaUpdates' => [
[
'RegionName' => '<string>', // REQUIRED
'ReplicaGlobalSecondaryIndexUpdates' => [
[
'IndexName' => '<string>',
'ProvisionedReadCapacityAutoScalingUpdate' => [
'AutoScalingDisabled' => true || false,
'AutoScalingRoleArn' => '<string>',
'MaximumUnits' => <integer>,
'MinimumUnits' => <integer>,
'ScalingPolicyUpdate' => [
'PolicyName' => '<string>',
'TargetTrackingScalingPolicyConfiguration' => [ // REQUIRED
'DisableScaleIn' => true || false,
'ScaleInCooldown' => <integer>,
'ScaleOutCooldown' => <integer>,
'TargetValue' => <float>, // REQUIRED
],
],
],
],
// ...
],
'ReplicaProvisionedReadCapacityAutoScalingUpdate' => [
'AutoScalingDisabled' => true || false,
'AutoScalingRoleArn' => '<string>',
'MaximumUnits' => <integer>,
'MinimumUnits' => <integer>,
'ScalingPolicyUpdate' => [
'PolicyName' => '<string>',
'TargetTrackingScalingPolicyConfiguration' => [ // REQUIRED
'DisableScaleIn' => true || false,
'ScaleInCooldown' => <integer>,
'ScaleOutCooldown' => <integer>,
'TargetValue' => <float>, // REQUIRED
],
],
],
],
// ...
],
'TableName' => '<string>', // REQUIRED
]);
Parameter Details Members
Represents the auto scaling settings of the global secondary indexes of the replica to be updated.
Represents the auto scaling settings to be modified for a global table or global secondary index.
Represents the auto scaling settings of replicas of the table that will be modified.
The name of the global table to be updated. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.
[
'TableAutoScalingDescription' => [
'Replicas' => [
[
'GlobalSecondaryIndexes' => [
[
'IndexName' => '<string>',
'IndexStatus' => 'CREATING|UPDATING|DELETING|ACTIVE',
'ProvisionedReadCapacityAutoScalingSettings' => [
'AutoScalingDisabled' => true || false,
'AutoScalingRoleArn' => '<string>',
'MaximumUnits' => <integer>,
'MinimumUnits' => <integer>,
'ScalingPolicies' => [
[
'PolicyName' => '<string>',
'TargetTrackingScalingPolicyConfiguration' => [
'DisableScaleIn' => true || false,
'ScaleInCooldown' => <integer>,
'ScaleOutCooldown' => <integer>,
'TargetValue' => <float>,
],
],
// ...
],
],
'ProvisionedWriteCapacityAutoScalingSettings' => [
'AutoScalingDisabled' => true || false,
'AutoScalingRoleArn' => '<string>',
'MaximumUnits' => <integer>,
'MinimumUnits' => <integer>,
'ScalingPolicies' => [
[
'PolicyName' => '<string>',
'TargetTrackingScalingPolicyConfiguration' => [
'DisableScaleIn' => true || false,
'ScaleInCooldown' => <integer>,
'ScaleOutCooldown' => <integer>,
'TargetValue' => <float>,
],
],
// ...
],
],
],
// ...
],
'RegionName' => '<string>',
'ReplicaProvisionedReadCapacityAutoScalingSettings' => [
'AutoScalingDisabled' => true || false,
'AutoScalingRoleArn' => '<string>',
'MaximumUnits' => <integer>,
'MinimumUnits' => <integer>,
'ScalingPolicies' => [
[
'PolicyName' => '<string>',
'TargetTrackingScalingPolicyConfiguration' => [
'DisableScaleIn' => true || false,
'ScaleInCooldown' => <integer>,
'ScaleOutCooldown' => <integer>,
'TargetValue' => <float>,
],
],
// ...
],
],
'ReplicaProvisionedWriteCapacityAutoScalingSettings' => [
'AutoScalingDisabled' => true || false,
'AutoScalingRoleArn' => '<string>',
'MaximumUnits' => <integer>,
'MinimumUnits' => <integer>,
'ScalingPolicies' => [
[
'PolicyName' => '<string>',
'TargetTrackingScalingPolicyConfiguration' => [
'DisableScaleIn' => true || false,
'ScaleInCooldown' => <integer>,
'ScaleOutCooldown' => <integer>,
'TargetValue' => <float>,
],
],
// ...
],
],
'ReplicaStatus' => 'CREATING|CREATION_FAILED|UPDATING|DELETING|ACTIVE|REGION_DISABLED|INACCESSIBLE_ENCRYPTION_CREDENTIALS|ARCHIVING|ARCHIVED|REPLICATION_NOT_AUTHORIZED',
],
// ...
],
'TableName' => '<string>',
'TableStatus' => 'CREATING|UPDATING|DELETING|ACTIVE|INACCESSIBLE_ENCRYPTION_CREDENTIALS|ARCHIVING|ARCHIVED|REPLICATION_NOT_AUTHORIZED',
],
]Result Details Members
Returns information about the auto scaling settings of a table with replicas.
The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be ACTIVE.
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.
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.
An error occurred on the server side.
$result = $client->updateTimeToLive([/* ... */]); $promise = $client->updateTimeToLiveAsync([/* ... */]);
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.
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.
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 in the Amazon DynamoDB Developer Guide.
Parameter Syntax$result = $client->updateTimeToLive([
'TableName' => '<string>', // REQUIRED
'TimeToLiveSpecification' => [ // REQUIRED
'AttributeName' => '<string>', // REQUIRED
'Enabled' => true || false, // REQUIRED
],
]);
Parameter Details Members
The name of the table to be configured. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.
Represents the settings used to enable or disable Time to Live for the specified table.
[
'TimeToLiveSpecification' => [
'AttributeName' => '<string>',
'Enabled' => true || false,
],
]Result Details Members
Represents the output of an UpdateTimeToLive operation.
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.
The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be ACTIVE.
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.
An error occurred on the server side.
Contains details of a table archival operation.
MembersThe Amazon Resource Name (ARN) of the backup the table was archived to, when applicable in the archival reason. If you wish to restore this backup to the same table name, you will need to delete the original table.
The date and time when table archival was initiated by DynamoDB, in UNIX epoch time format.
The reason DynamoDB archived the table. Currently, the only possible value is:
INACCESSIBLE_ENCRYPTION_CREDENTIALS - The table was archived due to the table's KMS key being inaccessible for more than seven days. An On-Demand backup was created at the archival time.
Represents an attribute for describing the schema for the table and indexes.
MembersA name for the attribute.
The data type for the attribute, where:
S - the attribute is of type String
N - the attribute is of type Number
B - the attribute is of type Binary
Represents the data for an attribute.
Each attribute value is described as a name-value pair. The name is the data type, and the value is the data itself.
For more information, see Data Types in the Amazon DynamoDB Developer Guide.
MembersAn attribute of type Binary. For example:
"B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"
An attribute of type Boolean. For example:
"BOOL": true
An attribute of type Binary Set. For example:
"BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]
An attribute of type List. For example:
"L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N": "3.14159"}]
An attribute of type Map. For example:
"M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}
An attribute of type Number. For example:
"N": "123.45"
Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.
An attribute of type Number Set. For example:
"NS": ["42.2", "-19", "7.5", "3.14"]
Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.
An attribute of type Null. For example:
"NULL": true
An attribute of type String. For example:
"S": "Hello"
An attribute of type String Set. For example:
"SS": ["Giraffe", "Hippo" ,"Zebra"]
For the UpdateItem operation, represents the attributes to be modified, the action to perform on each, and the new value for each.
You cannot use UpdateItem to update any primary key attributes. Instead, you will need to delete the item, and then use PutItem to create a new item with new attributes.
Attribute values cannot be null; string and binary type attributes must have lengths greater than zero; and set type attributes must not be empty. Requests with empty values will be rejected with a ValidationException exception.
Specifies how to perform the update. Valid values are PUT (default), DELETE, and ADD. The behavior depends on whether the specified primary key already exists in the table.
If an item with the specified Key is found in the table:
PUT - Adds the specified attribute to the item. If the attribute already exists, it is replaced by the new value.
DELETE - If no value is specified, the attribute and its value are removed from the item. The data type of the specified value must match the existing value's data type.
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 specified [a,c], then the final attribute value would be [b]. Specifying an empty set is an error.
ADD - If the attribute does not already exist, then the attribute and its values are added to the item. 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 the Value is mathematically added to the existing attribute. If Value is a negative number, then it is subtracted from the existing attribute.
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.
In addition, if you use ADD to update an existing item, and intend to increment or decrement an attribute value which does not yet exist, DynamoDB uses 0 as the initial value. For example, suppose that the item you want to update does not yet have an attribute named itemcount, but you decide to ADD the number 3 to this attribute anyway, even though it currently does not exist. 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 the Value is also a set, then the Value is added to the existing set. (This is a set operation, not mathematical addition.) For example, if the attribute value was the set [1,2], and the ADD action specified [3], then the final attribute value would be [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. The same holds true for number sets and binary sets.
This action is only valid for an existing attribute whose data type is number or is a set. Do not use ADD for any other data types.
If no item with the specified Key is found:
PUT - DynamoDB creates a new item with the specified primary key, and then adds the attribute.
DELETE - Nothing happens; there is no attribute to delete.
ADD - DynamoDB creates a new item with the supplied primary key and number (or set) for the attribute value. The only data types allowed are number, number set, string set or binary set.
Represents the data for an attribute.
Each attribute value is described as a name-value pair. The name is the data type, and the value is the data itself.
For more information, see Data Types in the Amazon DynamoDB Developer Guide.
Represents the properties of the scaling policy.
MembersThe name of the scaling policy.
Represents a target tracking scaling policy configuration.
Represents the auto scaling policy to be modified.
MembersThe name of the scaling policy.
Represents a target tracking scaling policy configuration.
Represents the auto scaling settings for a global table or global secondary index.
MembersDisabled auto scaling for this global table or global secondary index.
Role ARN used for configuring the auto scaling policy.
The maximum capacity units that a global table or global secondary index should be scaled up to.
The minimum capacity units that a global table or global secondary index should be scaled down to.
Information about the scaling policies.
Represents the auto scaling settings to be modified for a global table or global secondary index.
MembersDisabled auto scaling for this global table or global secondary index.
Role ARN used for configuring auto scaling policy.
The maximum capacity units that a global table or global secondary index should be scaled up to.
The minimum capacity units that a global table or global secondary index should be scaled down to.
The scaling policy to apply for scaling target global table or global secondary index capacity units.
Represents the properties of a target tracking scaling policy.
MembersIndicates whether scale in by the target tracking policy is disabled. If the value is true, scale in is disabled and the target tracking policy won't remove capacity from the scalable resource. Otherwise, scale in is enabled and the target tracking policy can remove capacity from the scalable resource. The default value is false.
The amount of time, in seconds, after a scale in activity completes before another scale in activity can start. The cooldown period is used to block subsequent scale in requests until it has expired. You should scale in conservatively to protect your application's availability. However, if another alarm triggers a scale out policy during the cooldown period after a scale-in, application auto scaling scales out your scalable target immediately.
The amount of time, in seconds, after a scale out activity completes before another scale out activity can start. While the cooldown period is in effect, the capacity that has been added by the previous scale out event that initiated the cooldown is calculated as part of the desired capacity for the next scale out. You should continuously (but not excessively) scale out.
The target value for the metric. The range is 8.515920e-109 to 1.174271e+108 (Base 10) or 2e-360 to 2e360 (Base 2).
Represents the settings of a target tracking scaling policy that will be modified.
MembersIndicates whether scale in by the target tracking policy is disabled. If the value is true, scale in is disabled and the target tracking policy won't remove capacity from the scalable resource. Otherwise, scale in is enabled and the target tracking policy can remove capacity from the scalable resource. The default value is false.
The amount of time, in seconds, after a scale in activity completes before another scale in activity can start. The cooldown period is used to block subsequent scale in requests until it has expired. You should scale in conservatively to protect your application's availability. However, if another alarm triggers a scale out policy during the cooldown period after a scale-in, application auto scaling scales out your scalable target immediately.
The amount of time, in seconds, after a scale out activity completes before another scale out activity can start. While the cooldown period is in effect, the capacity that has been added by the previous scale out event that initiated the cooldown is calculated as part of the desired capacity for the next scale out. You should continuously (but not excessively) scale out.
The target value for the metric. The range is 8.515920e-109 to 1.174271e+108 (Base 10) or 2e-360 to 2e360 (Base 2).
Contains the description of the backup created for the table.
MembersContains the details of the backup created for the table.
Contains the details of the table when the backup was created.
Contains the details of the features enabled on the table when the backup was created. For example, LSIs, GSIs, streams, TTL.
Contains the details of the backup created for the table.
MembersARN associated with the backup.
Time at which the backup was created. This is the request time of the backup.
Time at which the automatic on-demand backup created by DynamoDB will expire. This SYSTEM on-demand backup expires automatically 35 days after its creation.
Name of the requested backup.
Size of the backup in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
Backup can be in one of the following states: CREATING, ACTIVE, DELETED.
BackupType:
USER - You create and manage these using the on-demand backup feature.
SYSTEM - If you delete a table with point-in-time recovery enabled, a SYSTEM backup is automatically created and is retained for 35 days (at no additional cost). System backups allow you to restore the deleted table to the state it was in just before the point of deletion.
AWS_BACKUP - On-demand backup created by you from Backup service.
There is another ongoing conflicting backup control plane operation on the table. The backup is either being created, deleted or restored to a table.
MembersBackup not found for the given BackupARN.
MembersContains details for the backup.
MembersARN associated with the backup.
Time at which the backup was created.
Time at which the automatic on-demand backup created by DynamoDB will expire. This SYSTEM on-demand backup expires automatically 35 days after its creation.
Name of the specified backup.
Size of the backup in bytes.
Backup can be in one of the following states: CREATING, ACTIVE, DELETED.
BackupType:
USER - You create and manage these using the on-demand backup feature.
SYSTEM - If you delete a table with point-in-time recovery enabled, a SYSTEM backup is automatically created and is retained for 35 days (at no additional cost). System backups allow you to restore the deleted table to the state it was in just before the point of deletion.
AWS_BACKUP - On-demand backup created by you from Backup service.
ARN associated with the table.
Unique identifier for the table.
Name of the table.
An error associated with a statement in a PartiQL batch that was run.
MembersThe error code associated with the failed PartiQL batch statement.
The item which caused the condition check to fail. This will be set if ReturnValuesOnConditionCheckFailure is specified as ALL_OLD.
The error message associated with the PartiQL batch response.
A PartiQL batch statement request.
MembersThe read consistency of the PartiQL batch request.
The parameters associated with a PartiQL statement in the batch request.
An optional parameter that returns the item attributes for a PartiQL batch request 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.
A valid PartiQL statement.
A PartiQL batch statement response..
MembersThe error associated with a failed PartiQL batch statement.
A DynamoDB item associated with a BatchStatementResponse
The table name associated with a failed PartiQL batch statement.
Contains the details for the read/write capacity mode. This page talks about PROVISIONED and PAY_PER_REQUEST billing modes. For more information about these modes, see Read/write capacity mode.
You may need to switch to on-demand mode at least once in order to return a BillingModeSummary response.
Controls how you are charged for read and write throughput and how you manage capacity. This setting can be changed later.
PROVISIONED - Sets the read/write capacity mode to PROVISIONED. We recommend using PROVISIONED for predictable workloads.
PAY_PER_REQUEST - Sets the read/write capacity mode to PAY_PER_REQUEST. We recommend using PAY_PER_REQUEST for unpredictable workloads.
Represents the time when PAY_PER_REQUEST was last set as the read/write capacity mode.
An ordered list of errors for each item in the request which caused the transaction to get cancelled. The values of the list are ordered according to the ordering of the TransactWriteItems request parameter. If no error occurred for the associated item an error with a Null code and Null message will be present.
Status code for the result of the cancelled transaction.
Item in the request which caused the transaction to get cancelled.
Cancellation reason message description.
Represents the amount of provisioned throughput capacity consumed on a table or an index.
MembersThe total number of capacity units consumed on a table or an index.
The total number of read capacity units consumed on a table or an index.
The total number of write capacity units consumed on a table or an index.
Represents the selection criteria for a Query or Scan operation:
For a Query operation, Condition is used for specifying the KeyConditions to use when querying a table or an index. For KeyConditions, only the following comparison operators are supported:
EQ | LE | LT | GE | GT | BEGINS_WITH | BETWEEN
Condition is also used in a QueryFilter, which evaluates the query results and returns only the desired values.
For a Scan operation, Condition is used in a ScanFilter, which evaluates the scan results and returns only the desired values.
One or more values to evaluate against the supplied attribute. The number of values in the list depends on the ComparisonOperator being used.
For type Number, value comparisons are numeric.
String value comparisons for greater than, equals, or less than are based on ASCII character code values. For example, a is greater than A, and a is greater than B. For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
For Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values.
A comparator for evaluating attributes. For example, equals, greater than, less than, etc.
The following comparison operators are available:
EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN
The following are descriptions of each comparison operator.
EQ : Equal. EQ is supported for all data types, including lists and maps.
AttributeValueList can contain only one AttributeValue element of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does not equal {"NS":["6", "2", "1"]}.
NE : Not equal. NE is supported for all data types, including lists and maps.
AttributeValueList can contain only one AttributeValue of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an AttributeValue of a different type than the one provided in the request, the value does not match. For example, {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does not equal {"NS":["6", "2", "1"]}.
LE : Less than or equal.
AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does not compare to {"NS":["6", "2", "1"]}.
LT : Less than.
AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does not compare to {"NS":["6", "2", "1"]}.
GE : Greater than or equal.
AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does not compare to {"NS":["6", "2", "1"]}.
GT : Greater than.
AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does not compare to {"NS":["6", "2", "1"]}.
NOT_NULL : The attribute exists. NOT_NULL is supported for all data types, including lists and maps.
This operator tests for the existence of an attribute, not its data type. If the data type of attribute "a" is null, and you evaluate it using NOT_NULL, the result is a Boolean true. This result is because the attribute "a" exists; its data type is not relevant to the NOT_NULL comparison operator.
NULL : The attribute does not exist. NULL is supported for all data types, including lists and maps.
This operator tests for the nonexistence of an attribute, not its data type. If the data type of attribute "a" is null, and you evaluate it using NULL, the result is a Boolean false. This is because the attribute "a" exists; its data type is not relevant to the NULL comparison operator.
CONTAINS : Checks for a subsequence, or value in a set.
AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If the target attribute of the comparison is of type String, then the operator checks for a substring match. If the target attribute of the comparison is of type Binary, then the operator looks for a subsequence of the target that matches the input. If the target attribute of the comparison is a set ("SS", "NS", or "BS"), then the operator evaluates to true if it finds an exact match with any member of the set.
CONTAINS is supported for lists: When evaluating "a CONTAINS b", "a" can be a list; however, "b" cannot be a set, a map, or a list.
NOT_CONTAINS : Checks for absence of a subsequence, or absence of a value in a set.
AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If the target attribute of the comparison is a String, then the operator checks for the absence of a substring match. If the target attribute of the comparison is Binary, then the operator checks for the absence of a subsequence of the target that matches the input. If the target attribute of the comparison is a set ("SS", "NS", or "BS"), then the operator evaluates to true if it does not find an exact match with any member of the set.
NOT_CONTAINS is supported for lists: When evaluating "a NOT CONTAINS b", "a" can be a list; however, "b" cannot be a set, a map, or a list.
BEGINS_WITH : Checks for a prefix.
AttributeValueList can contain only one AttributeValue of type String or Binary (not a Number or a set type). The target attribute of the comparison must be of type String or Binary (not a Number or a set type).
IN : Checks for matching elements in a list.
AttributeValueList can contain one or more AttributeValue elements of type String, Number, or Binary. These attributes are compared against an existing attribute of an item. If any elements of the input are equal to the item attribute, the expression evaluates to true.
BETWEEN : Greater than or equal to the first value, and less than or equal to the second value.
AttributeValueList must contain two AttributeValue elements of the same type, either String, Number, or Binary (not a set type). A target attribute matches if the target value is greater than, or equal to, the first element and less than, or equal to, the second element. If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {"S":"6"} does not compare to {"N":"6"}. Also, {"N":"6"} does not compare to {"NS":["6", "2", "1"]}
For usage examples of AttributeValueList and ComparisonOperator, see Legacy Conditional Parameters in the Amazon DynamoDB Developer Guide.
Represents a request to perform a check that an item exists or to check the condition of specific attributes of the item.
MembersA condition that must be satisfied in order for a conditional update to succeed. For more information, see Condition expressions in the Amazon DynamoDB Developer Guide.
One or more substitution tokens for attribute names in an expression. For more information, see Expression attribute names in the Amazon DynamoDB Developer Guide.
One or more values that can be substituted in an expression. For more information, see Condition expressions in the Amazon DynamoDB Developer Guide.
The primary key of the item to be checked. Each element consists of an attribute name and a value for that attribute.
Use ReturnValuesOnConditionCheckFailure to get the item attributes if the ConditionCheck condition fails. For ReturnValuesOnConditionCheckFailure, the valid values are: NONE and ALL_OLD.
Name of the table for the check item request. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.
A condition specified in the operation failed to be evaluated.
MembersItem which caused the ConditionalCheckFailedException.
The conditional request failed.
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 in the Amazon DynamoDB Developer Guide.
The total number of capacity units consumed by the operation.
The amount of throughput consumed on each global index affected by the operation.
The amount of throughput consumed on each local index affected by the operation.
The total number of read capacity units consumed by the operation.
The amount of throughput consumed on the table affected by the operation.
The name of the table that was affected by the operation. If you had specified the Amazon Resource Name (ARN) of a table in the input, you'll see the table ARN in the response.
The total number of write capacity units consumed by the operation.
Represents the continuous backups and point in time recovery settings on the table.
MembersContinuousBackupsStatus can be one of the following states: ENABLED, DISABLED
The description of the point in time recovery settings applied to the table.
Backups have not yet been enabled for this table.
MembersRepresents a Contributor Insights summary entry.
MembersIndicates the current mode of CloudWatch Contributor Insights, specifying whether it tracks all access and throttled events or throttled events only for the DynamoDB table or index.
Describes the current status for contributor insights for the given table and index, if applicable.
Name of the index associated with the summary, if any.
Name of the table associated with the summary.
Represents a new global secondary index to be added to an existing table.
MembersThe name of the global secondary index to be created.
The key schema for the global secondary index.
The maximum number of read and write units for the global secondary index being created. If you use this parameter, you must specify MaxReadRequestUnits, MaxWriteRequestUnits, or both. You must use either OnDemand Throughput or ProvisionedThroughput based on your table's capacity mode.
Represents attributes that are copied (projected) from the table into an index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.
Represents the provisioned throughput settings for the specified global secondary index.
For current minimum and maximum provisioned throughput values, see Service, Account, and Table Quotas in the Amazon DynamoDB Developer Guide.
Represents the warm throughput value (in read units per second and write units per second) when creating a secondary index.
Specifies the action to add a new witness Region to a MRSC global table. A MRSC global table can be configured with either three replicas, or with two replicas and one witness.
MembersThe Amazon Web Services Region name to be added as a witness Region for the MRSC global table. The witness must be in a different Region than the replicas and within the same Region set:
US Region set: US East (N. Virginia), US East (Ohio), US West (Oregon)
EU Region set: Europe (Ireland), Europe (London), Europe (Paris), Europe (Frankfurt)
AP Region set: Asia Pacific (Tokyo), Asia Pacific (Seoul), Asia Pacific (Osaka)
Represents a replica to be added.
MembersThe Region of the replica to be added.
Represents a replica to be created.
MembersReplica-specific global secondary index settings.
The KMS key that should be used for KMS encryption in the new replica. To specify a key, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. Note that you should only provide this parameter if the key is different from the default DynamoDB KMS key alias/aws/dynamodb.
The maximum on-demand throughput settings for the specified replica table being created. You can only modify MaxReadRequestUnits, because you can't modify MaxWriteRequestUnits for individual replica tables.
Replica-specific provisioned throughput. If not specified, uses the source table's provisioned throughput settings.
The Region where the new replica will be created.
Replica-specific table class. If not specified, uses the source table's table class.
Processing options for the CSV file being imported.
MembersThe delimiter used for separating items in the CSV file being imported.
List of the headers used to specify a common header for all source CSV files being imported. If this field is specified then the first line of each CSV file is treated as data instead of the header. If this field is not specified the the first line of each CSV file is treated as the header.
Represents a request to perform a DeleteItem operation.
A condition that must be satisfied in order for a conditional delete to succeed.
One or more substitution tokens for attribute names in an expression.
One or more values that can be substituted in an expression.
The primary key of the item to be deleted. Each element consists of an attribute name and a value for that attribute.
Use ReturnValuesOnConditionCheckFailure to get the item attributes if the Delete condition fails. For ReturnValuesOnConditionCheckFailure, the valid values are: NONE and ALL_OLD.
Name of the table in which the item to be deleted resides. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.
Represents a global secondary index to be deleted from an existing table.
MembersThe name of the global secondary index to be deleted.
Specifies the action to remove a witness Region from a MRSC global table. You cannot delete a single witness from a MRSC global table - you must delete both a replica and the witness together. The deletion of both a witness and replica converts the remaining replica to a single-Region DynamoDB table.
MembersThe witness Region name to be removed from the MRSC global table.
Represents a replica to be removed.
MembersThe Region of the replica to be removed.
Represents a replica to be deleted.
MembersThe Region where the replica exists.
Represents a request to perform a DeleteItem operation on an item.
A map of attribute name to attribute values, representing the primary key of the item to delete. All of the table's primary key attributes must be specified, and their data types must match those of the table's key schema.
There was an attempt to insert an item with the same primary key as an item that already exists in the DynamoDB table.
MembersEnables setting the configuration for Kinesis Streaming.
MembersToggle for the precision of Kinesis data stream timestamp. The values are either MILLISECOND or MICROSECOND.
An endpoint information details.
MembersIP address of the endpoint.
Endpoint cache time to live (TTL) value.
Represents a condition to be compared with an attribute value. This condition can be used with DeleteItem, PutItem, or UpdateItem operations; if the comparison evaluates to true, the operation succeeds; if not, the operation fails. You can use ExpectedAttributeValue in one of two different ways:
Use AttributeValueList to specify one or more values to compare against an attribute. Use ComparisonOperator to specify how you want to perform the comparison. If the comparison evaluates to true, then the conditional operation succeeds.
Use Value to specify a value that DynamoDB will compare against an attribute. If the values match, then ExpectedAttributeValue evaluates to true and the conditional operation succeeds. Optionally, you can also set Exists to false, indicating that you do not expect to find the attribute value in the table. In this case, the conditional operation succeeds only if the comparison evaluates to false.
Value and Exists are incompatible with AttributeValueList and ComparisonOperator. Note that if you use both sets of parameters at once, DynamoDB will return a ValidationException exception.
One or more values to evaluate against the supplied attribute. The number of values in the list depends on the ComparisonOperator being used.
For type Number, value comparisons are numeric.
String value comparisons for greater than, equals, or less than are based on ASCII character code values. For example, a is greater than A, and a is greater than B. For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
For Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values.
For information on specifying data types in JSON, see JSON Data Format in the Amazon DynamoDB Developer Guide.
A comparator for evaluating attributes in the AttributeValueList. For example, equals, greater than, less than, etc.
The following comparison operators are available:
EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN
The following are descriptions of each comparison operator.
EQ : Equal. EQ is supported for all data types, including lists and maps.
AttributeValueList can contain only one AttributeValue element of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does not equal {"NS":["6", "2", "1"]}.
NE : Not equal. NE is supported for all data types, including lists and maps.
AttributeValueList can contain only one AttributeValue of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an AttributeValue of a different type than the one provided in the request, the value does not match. For example, {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does not equal {"NS":["6", "2", "1"]}.
LE : Less than or equal.
AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does not compare to {"NS":["6", "2", "1"]}.
LT : Less than.
AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does not compare to {"NS":["6", "2", "1"]}.
GE : Greater than or equal.
AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does not compare to {"NS":["6", "2", "1"]}.
GT : Greater than.
AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does not compare to {"NS":["6", "2", "1"]}.
NOT_NULL : The attribute exists. NOT_NULL is supported for all data types, including lists and maps.
This operator tests for the existence of an attribute, not its data type. If the data type of attribute "a" is null, and you evaluate it using NOT_NULL, the result is a Boolean true. This result is because the attribute "a" exists; its data type is not relevant to the NOT_NULL comparison operator.
NULL : The attribute does not exist. NULL is supported for all data types, including lists and maps.
This operator tests for the nonexistence of an attribute, not its data type. If the data type of attribute "a" is null, and you evaluate it using NULL, the result is a Boolean false. This is because the attribute "a" exists; its data type is not relevant to the NULL comparison operator.
CONTAINS : Checks for a subsequence, or value in a set.
AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If the target attribute of the comparison is of type String, then the operator checks for a substring match. If the target attribute of the comparison is of type Binary, then the operator looks for a subsequence of the target that matches the input. If the target attribute of the comparison is a set ("SS", "NS", or "BS"), then the operator evaluates to true if it finds an exact match with any member of the set.
CONTAINS is supported for lists: When evaluating "a CONTAINS b", "a" can be a list; however, "b" cannot be a set, a map, or a list.
NOT_CONTAINS : Checks for absence of a subsequence, or absence of a value in a set.
AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If the target attribute of the comparison is a String, then the operator checks for the absence of a substring match. If the target attribute of the comparison is Binary, then the operator checks for the absence of a subsequence of the target that matches the input. If the target attribute of the comparison is a set ("SS", "NS", or "BS"), then the operator evaluates to true if it does not find an exact match with any member of the set.
NOT_CONTAINS is supported for lists: When evaluating "a NOT CONTAINS b", "a" can be a list; however, "b" cannot be a set, a map, or a list.
BEGINS_WITH : Checks for a prefix.
AttributeValueList can contain only one AttributeValue of type String or Binary (not a Number or a set type). The target attribute of the comparison must be of type String or Binary (not a Number or a set type).
IN : Checks for matching elements in a list.
AttributeValueList can contain one or more AttributeValue elements of type String, Number, or Binary. These attributes are compared against an existing attribute of an item. If any elements of the input are equal to the item attribute, the expression evaluates to true.
BETWEEN : Greater than or equal to the first value, and less than or equal to the second value.
AttributeValueList must contain two AttributeValue elements of the same type, either String, Number, or Binary (not a set type). A target attribute matches if the target value is greater than, or equal to, the first element and less than, or equal to, the second element. If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {"S":"6"} does not compare to {"N":"6"}. Also, {"N":"6"} does not compare to {"NS":["6", "2", "1"]}
Causes DynamoDB to evaluate the value before attempting a conditional operation:
If Exists is true, DynamoDB will check to see if that attribute value already exists in the table. If it is found, then the operation succeeds. If it is not found, the operation fails with a ConditionCheckFailedException.
If Exists is false, DynamoDB assumes that the attribute value does not exist in the table. If in fact the value does not exist, then the assumption is valid and the operation succeeds. If the value is found, despite the assumption that it does not exist, the operation fails with a ConditionCheckFailedException.
The default setting for Exists is true. If you supply a Value all by itself, DynamoDB assumes the attribute exists: You don't have to set Exists to true, because it is implied.
DynamoDB returns a ValidationException if:
Exists is true but there is no Value to check. (You expect a value to exist, but don't specify what that value is.)
Exists is false but you also provide a Value. (You cannot expect an attribute to have a value, while also expecting it not to exist.)
Represents the data for the expected attribute.
Each attribute value is described as a name-value pair. The name is the data type, and the value is the data itself.
For more information, see Data Types in the Amazon DynamoDB Developer Guide.
There was a conflict when writing to the specified S3 bucket.
MembersRepresents the properties of the exported table.
MembersThe billable size of the table export.
The client token that was provided for the export task. A client token makes calls to ExportTableToPointInTimeInput idempotent, meaning that multiple identical calls have the same effect as one single call.
The time at which the export task completed.
The Amazon Resource Name (ARN) of the table export.
The format of the exported data. Valid values for ExportFormat are DYNAMODB_JSON or ION.
The name of the manifest file for the export task.
Export can be in one of the following states: IN_PROGRESS, COMPLETED, or FAILED.
Point in time from which table data was exported.
The type of export that was performed. Valid values are FULL_EXPORT or INCREMENTAL_EXPORT.
Status code for the result of the failed export.
Export failure reason description.
Optional object containing the parameters specific to an incremental export.
The number of items exported.
The name of the Amazon S3 bucket containing the export.
The ID of the Amazon Web Services account that owns the bucket containing the export.
The Amazon S3 bucket prefix used as the file name and path of the exported snapshot.
Type of encryption used on the bucket where export data is stored. Valid values for S3SseAlgorithm are:
AES256 - server-side encryption with Amazon S3 managed keys
KMS - server-side encryption with KMS managed keys
The ID of the KMS managed key used to encrypt the S3 bucket where export data is stored (if applicable).
The time at which the export task began.
The Amazon Resource Name (ARN) of the table that was exported.
Unique ID of the table that was exported.
The specified export was not found.
MembersSummary information about an export task.
MembersThe Amazon Resource Name (ARN) of the export.
Export can be in one of the following states: IN_PROGRESS, COMPLETED, or FAILED.
The type of export that was performed. Valid values are FULL_EXPORT or INCREMENTAL_EXPORT.
Represents a failure a contributor insights operation.
MembersDescription of the failure.
Exception name.
Specifies an item and related attribute values to retrieve in a TransactGetItem object.
One or more substitution tokens for attribute names in the ProjectionExpression parameter.
A map of attribute names to AttributeValue objects that specifies the primary key of the item to retrieve.
A string that identifies one or more attributes of the specified item to retrieve from the table. The attributes in the expression must be separated by commas. If no attribute names are specified, then all attributes of the specified item are returned. If any of the requested attributes are not found, they do not appear in the result.
The name of the table from which to retrieve the specified item. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.
Represents the properties of a global secondary index.
MembersThe name of the global secondary index. The name must be unique among all other indexes on this table.
The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types:
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 DynamoDB's 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.
The maximum number of read and write units for the specified global secondary index. If you use this parameter, you must specify MaxReadRequestUnits, MaxWriteRequestUnits, or both. You must use either OnDemandThroughput or ProvisionedThroughput based on your table's capacity mode.
Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.
Represents the provisioned throughput settings for the specified global secondary index. You must use either OnDemandThroughput or ProvisionedThroughput based on your table's capacity mode.
For current minimum and maximum provisioned throughput values, see Service, Account, and Table Quotas in the Amazon DynamoDB Developer Guide.
Represents the warm throughput value (in read units per second and write units per second) for the specified secondary index. If you use this parameter, you must specify ReadUnitsPerSecond, WriteUnitsPerSecond, or both.
Represents the auto scaling settings of a global secondary index for a global table that will be modified.
MembersThe name of the global secondary index.
Represents the auto scaling settings to be modified for a global table or global secondary index.
Represents the properties of a global secondary index.
MembersIndicates whether the index is currently backfilling. Backfilling is the process of reading items from the table and determining whether they can be added to the index. (Not all items will qualify: For example, a partition key cannot have any duplicate values.) If an item can be added to the index, DynamoDB will do so. After all items have been processed, the backfilling operation is complete and Backfilling is false.
You can delete an index that is being created during the Backfilling phase when IndexStatus is set to CREATING and Backfilling is true. You can't delete the index that is being created when IndexStatus is set to CREATING and Backfilling is false.
For indexes that were created during a CreateTable operation, the Backfilling attribute does not appear in the DescribeTable output.
The Amazon Resource Name (ARN) that uniquely identifies the index.
The name of the global secondary index.
The total size of the specified index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
The current state of the global secondary index:
CREATING - The index is being created.
UPDATING - The index is being updated.
DELETING - The index is being deleted.
ACTIVE - The index is ready for use.
The number of items in the specified index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types:
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 DynamoDB's 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.
The maximum number of read and write units for the specified global secondary index. If you use this parameter, you must specify MaxReadRequestUnits, MaxWriteRequestUnits, or both.
Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.
Represents the provisioned throughput settings for the specified global secondary index.
For current minimum and maximum provisioned throughput values, see Service, Account, and Table Quotas in the Amazon DynamoDB Developer Guide.
Represents the warm throughput value (in read units per second and write units per second) for the specified secondary index.
Represents the properties of a global secondary index for the table when the backup was created.
MembersThe name of the global secondary index.
The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types:
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 DynamoDB's 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.
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.
Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.
Represents the provisioned throughput settings for the specified global secondary index.
Represents one of the following:
A new global secondary index to be added to an existing table.
New provisioned throughput parameters for an existing global secondary index.
An existing global secondary index to be removed from an existing table.
The parameters required for creating a global secondary index on an existing table:
IndexName
KeySchema
AttributeDefinitions
Projection
ProvisionedThroughput
The name of an existing global secondary index to be removed.
The name of an existing global secondary index, along with new provisioned throughput settings to be applied to that index.
The description of the warm throughput value on a global secondary index.
MembersRepresents warm throughput read units per second value for a global secondary index.
Represents the warm throughput status being created or updated on a global secondary index. The status can only be UPDATING or ACTIVE.
Represents warm throughput write units per second value for a global secondary index.
Represents the properties of a global table.
MembersThe global table name.
The Regions where the global table has replicas.
The specified global table already exists.
MembersContains details about the global table.
MembersThe creation time of the global table.
The unique identifier of the global table.
The global table name.
The current state of the global table:
CREATING - The global table is being created.
UPDATING - The global table is being updated.
DELETING - The global table is being deleted.
ACTIVE - The global table is ready for use.
The Regions where the global table has replicas.
Represents the settings of a global secondary index for a global table that will be modified.
MembersThe name of the global secondary index. The name must be unique among all other indexes on this table.
Auto scaling settings for managing a global secondary index's write capacity units.
The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException.
The specified global table does not exist.
MembersRepresents the properties of a witness Region in a MRSC global table.
MembersThe name of the Amazon Web Services Region that serves as a witness for the MRSC global table.
The current status of the witness Region in the MRSC global table.
Represents one of the following:
A new witness to be added to a new global table.
An existing witness to be removed from an existing global table.
You can configure one witness per MRSC global table.
MembersSpecifies a witness Region to be added to a new MRSC global table. The witness must be added when creating the MRSC global table.
Specifies a witness Region to be removed from an existing global table. Must be done in conjunction with removing a replica. The deletion of both a witness and replica converts the remaining replica to a single-Region DynamoDB table.
DynamoDB rejected the request because you retried a request with a different payload but with an idempotent token that was already used.
MembersThere 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.
MembersThe specified import was not found.
MembersSummary information about the source file for the import.
MembersThe Amazon Resource Number (ARN) of the Cloudwatch Log Group associated with this import task.
The time at which this import task ended. (Does this include the successful complete creation of the table it was imported to?)
The Amazon Resource Number (ARN) corresponding to the import request.
The status of the import operation.
The format of the source data. Valid values are CSV, DYNAMODB_JSON or ION.
The path and S3 bucket of the source file that is being imported. This includes the S3Bucket (required), S3KeyPrefix (optional) and S3BucketOwner (optional if the bucket is owned by the requester).
The time at which this import task began.
The Amazon Resource Number (ARN) of the table being imported into.
Represents the properties of the table being imported into.
MembersThe client token that was provided for the import task. Reusing the client token on retry makes a call to ImportTable idempotent.
The Amazon Resource Number (ARN) of the Cloudwatch Log Group associated with the target table.
The time at which the creation of the table associated with this import task completed.
The number of errors occurred on importing the source file into the target table.
The error code corresponding to the failure that the import job ran into during execution.
The error message corresponding to the failure that the import job ran into during execution.
The Amazon Resource Number (ARN) corresponding to the import request.
The status of the import.
The number of items successfully imported into the new table.
The compression options for the data that has been imported into the target table. The values are NONE, GZIP, or ZSTD.
The format of the source data going into the target table.
The format options for the data that was imported into the target table. There is one value, CsvOption.
The total number of items processed from the source file.
The total size of data processed from the source file, in Bytes.
Values for the S3 bucket the source file is imported from. Includes bucket name (required), key prefix (optional) and bucket account owner ID (optional).
The time when this import task started.
The Amazon Resource Number (ARN) of the table being imported into.
The parameters for the new table that is being imported into.
The table id corresponding to the table created by import table process.
Optional object containing the parameters specific to an incremental export.
MembersTime in the past which provides the inclusive start range for the export table's data, counted in seconds from the start of the Unix epoch. The incremental export will reflect the table's state including and after this point in time.
Time in the past which provides the exclusive end range for the export table's data, counted in seconds from the start of the Unix epoch. The incremental export will reflect the table's state just prior to this point in time. If this is not provided, the latest time with data available will be used.
The view type that was chosen for the export. Valid values are NEW_AND_OLD_IMAGES and NEW_IMAGES. The default value is NEW_AND_OLD_IMAGES.
The operation tried to access a nonexistent index.
MembersThe format options for the data that was imported into the target table. There is one value, CsvOption.
MembersThe options for imported source files in CSV format. The values are Delimiter and HeaderList.
An error occurred on the server side.
MembersThe server encountered an internal error trying to fulfill the request.
The specified ExportTime is outside of the point in time recovery window.
An invalid restore time was specified. RestoreDateTime must be between EarliestRestorableDateTime and LatestRestorableDateTime.
MembersInformation about item collections, if any, that were affected by the operation. ItemCollectionMetrics is only returned if the request asked for it. If the table does not have any local secondary indexes, this information is not returned in the response.
The partition key value of the item collection. This value is the same as the partition key value of the item.
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.
An item collection is too large. This exception is only returned for tables that have one or more local secondary indexes.
MembersThe total size of an item collection has exceeded the maximum limit of 10 gigabytes.
Details for the requested item.
MembersMap of attribute data consisting of the data type and attribute value.
Represents a single element of a key schema. A key schema specifies the attributes that make up the primary key of a table, or the key attributes of an index.
A KeySchemaElement represents exactly one attribute of the primary key. For example, a simple primary key would be represented by one KeySchemaElement (for the partition key). A composite primary key would require one KeySchemaElement for the partition key, and another KeySchemaElement for the sort key.
A KeySchemaElement must be a scalar, top-level attribute (not a nested attribute). The data type must be one of String, Number, or Binary. The attribute cannot be nested within a List or a Map.
The name of a key attribute.
The role that this 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 DynamoDB's 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.
Represents a set of primary keys and, for each key, the attributes to retrieve from 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. For a composite primary key, you must provide both the partition key and the sort key.
MembersThis is a legacy parameter. Use ProjectionExpression instead. For more information, see Legacy Conditional Parameters in the Amazon DynamoDB Developer Guide.
The consistency of a read operation. If set to true, then a strongly consistent read is used; otherwise, an eventually consistent read is used.
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 # 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 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 Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
The primary key attribute values that define the items and the attributes associated with the items.
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 ProjectionExpression must be separated by commas.
If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.
For more information, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
Describes a Kinesis data stream destination.
MembersThe precision of the Kinesis data stream timestamp. The values are either MILLISECOND or MICROSECOND.
The current status of replication.
The human-readable string that corresponds to the replica status.
The ARN for a specific Kinesis data stream.
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.
MembersToo many operations for a given subscriber.
Represents the properties of a local secondary index.
MembersThe name of the local secondary index. The name must be unique among all other indexes on this table.
The complete key schema for the local secondary index, consisting of one or more pairs of attribute names and key types:
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 DynamoDB's 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.
Represents attributes that are copied (projected) from the table into the local secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.
Represents the properties of a local secondary index.
MembersThe Amazon Resource Name (ARN) that uniquely identifies the index.
Represents the name of the local secondary index.
The total size of the specified index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
The number of items in the specified index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
The complete key schema for the local secondary index, consisting of one or more pairs of attribute names and key types:
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 DynamoDB's 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.
Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.
Represents the properties of a local secondary index for the table when the backup was created.
MembersRepresents the name of the local secondary index.
The complete key schema for a local secondary index, which consists of one or more pairs of attribute names and key types:
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 DynamoDB's 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.
Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.
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.
Maximum number of read request units for the specified table.
To specify a maximum OnDemandThroughput on your table, set the value of MaxReadRequestUnits as greater than or equal to 1. To remove the maximum OnDemandThroughput that is currently set on your table, set the value of MaxReadRequestUnits to -1.
Maximum number of write request units for the specified table.
To specify a maximum OnDemandThroughput on your table, set the value of MaxWriteRequestUnits as greater than or equal to 1. To remove the maximum OnDemandThroughput that is currently set on your table, set the value of MaxWriteRequestUnits to -1.
Overrides the on-demand throughput settings for this replica table. If you don't specify a value for this parameter, it uses the source table's on-demand throughput settings.
MembersMaximum number of read request units for the specified replica table.
Represents a PartiQL statement that uses parameters.
MembersThe parameter values.
An optional parameter that returns the item attributes for a PartiQL ParameterizedStatement 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.
A PartiQL statement that uses parameters.
The description of the point in time settings applied to the table.
MembersSpecifies the earliest point in time you can restore your table to. You can restore your table to any point in time during the last 35 days.
LatestRestorableDateTime is typically 5 minutes before the current time.
The current state of point in time recovery:
ENABLED - Point in time recovery is enabled.
DISABLED - Point in time recovery is disabled.
The number of preceding days for which continuous backups are taken and maintained. Your table data is only recoverable to any point-in-time from within the configured recovery period. This parameter is optional.
Represents the settings used to enable point in time recovery.
MembersIndicates whether point in time recovery is enabled (true) or disabled (false) on the table.
The number of preceding days for which continuous backups are taken and maintained. Your table data is only recoverable to any point-in-time from within the configured recovery period. This parameter is optional. If no value is provided, the value will default to 35.
Point in time recovery has not yet been enabled for this source table.
MembersThe 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.
Represents attributes that are copied (projected) from the table into an index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.
MembersRepresents the non-key attribute names which will be projected into the index.
For global and local secondary indexes, the total count of 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.
The set of attributes that are projected into the index:
KEYS_ONLY - Only the index and primary keys are projected into the index.
INCLUDE - In addition to the attributes described in KEYS_ONLY, the secondary index will include other non-key attributes that you specify.
ALL - All of the table attributes are projected into the index.
When using the DynamoDB console, ALL is selected by default.
Represents the provisioned throughput settings for the specified global secondary index. You must use ProvisionedThroughput or OnDemandThroughput based on your tableâs capacity mode.
For current minimum and maximum provisioned throughput values, see Service, Account, and Table Quotas in the Amazon DynamoDB Developer Guide.
MembersThe maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide.
If read/write capacity mode is PAY_PER_REQUEST the value is set to 0.
The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide.
If read/write capacity mode is PAY_PER_REQUEST the value is set to 0.
Represents the provisioned throughput settings for the table, consisting of read and write capacity units, along with data about increases and decreases.
MembersThe date and time of the last provisioned throughput decrease for this table.
The date and time of the last provisioned throughput increase for this table.
The number of provisioned throughput decreases for this table during this UTC calendar day. For current maximums on provisioned throughput decreases, see Service, Account, and Table Quotas in the Amazon DynamoDB Developer Guide.
The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException. Eventually consistent reads require less effort than strongly consistent reads, so a setting of 50 ReadCapacityUnits per second provides 100 eventually consistent ReadCapacityUnits per second.
The maximum number of writes consumed per second before DynamoDB returns a 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 field in the returned exception. The Amazon Web Services 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 in the Amazon DynamoDB Developer Guide.
MembersA list of ThrottlingReason that provide detailed diagnostic information about why the request was throttled.
You exceeded your maximum allowed provisioned throughput.
Replica-specific provisioned throughput settings. If not specified, uses the source table's provisioned throughput settings.
MembersReplica-specific read capacity units. If not specified, uses the source table's read capacity settings.
Represents a request to perform a PutItem operation.
A condition that must be satisfied in order for a conditional update to succeed.
One or more substitution tokens for attribute names in an expression.
One or more values that can be substituted in an expression.
A map of attribute name to attribute values, representing the primary key of the item to be written by PutItem. All of the table's primary key attributes must be specified, and their data types must match those of the table's key schema. If any attributes are present in the item that are part of an index key schema for the table, their types must match the index key schema.
Use ReturnValuesOnConditionCheckFailure to get the item attributes if the Put condition fails. For ReturnValuesOnConditionCheckFailure, the valid values are: NONE and ALL_OLD.
Name of the table in which to write the item. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.
Represents a request to perform a PutItem operation on an item.
A map of attribute name to attribute values, representing the primary key of an item to be processed by PutItem. All of the table's primary key attributes must be specified, and their data types must match those of the table's key schema. If any attributes are present in the item that are part of an index key schema for the table, their types must match the index key schema.
Represents the properties of a replica.
MembersThe Region where the replica needs to be created.
The specified replica is already part of the global table.
MembersRepresents the auto scaling settings of the replica.
MembersReplica-specific global secondary index auto scaling settings.
The Region where the replica exists.
Represents the auto scaling settings for a global table or global secondary index.
Represents the auto scaling settings for a global table or global secondary index.
The current state of the replica:
CREATING - The replica is being created.
UPDATING - The replica is being updated.
DELETING - The replica is being deleted.
ACTIVE - The replica is ready for use.
Represents the auto scaling settings of a replica that will be modified.
MembersThe Region where the replica exists.
Represents the auto scaling settings of global secondary indexes that will be modified.
Represents the auto scaling settings to be modified for a global table or global secondary index.
Contains the details of the replica.
MembersReplica-specific global secondary index settings.
The KMS key of the replica that will be used for KMS encryption.
Overrides the maximum on-demand throughput settings for the specified replica table.
Replica-specific provisioned throughput. If not described, uses the source table's provisioned throughput settings.
The name of the Region.
The time at which the replica was first detected as inaccessible. To determine cause of inaccessibility check the ReplicaStatus property.
The current state of the replica:
CREATING - The replica is being created.
UPDATING - The replica is being updated.
DELETING - The replica is being deleted.
ACTIVE - The replica is ready for use.
REGION_DISABLED - The replica is inaccessible because the Amazon Web Services Region has been disabled.
If the Amazon Web Services Region remains inaccessible for more than 20 hours, DynamoDB will remove this replica from the replication group. The replica will not be deleted and replication will stop from and to this region.
INACCESSIBLE_ENCRYPTION_CREDENTIALS - The KMS key used to encrypt the table is inaccessible.
If the KMS key remains inaccessible for more than 20 hours, DynamoDB will remove this replica from the replication group. The replica will not be deleted and replication will stop from and to this region.
Detailed information about the replica status.
Specifies the progress of a Create, Update, or Delete action on the replica as a percentage.
Contains details of the table class.
Represents the warm throughput value for this replica.
Represents the properties of a replica global secondary index.
MembersThe name of the global secondary index.
Overrides the maximum on-demand throughput settings for the specified global secondary index in the specified replica table.
Replica table GSI-specific provisioned throughput. If not specified, uses the source table GSI's read capacity settings.
Represents the auto scaling configuration for a replica global secondary index.
MembersThe name of the global secondary index.
The current state of the replica global secondary index:
CREATING - The index is being created.
UPDATING - The table/index configuration is being updated. The table/index remains available for data operations when UPDATING
DELETING - The index is being deleted.
ACTIVE - The index is ready for use.
Represents the auto scaling settings for a global table or global secondary index.
Represents the auto scaling settings for a global table or global secondary index.
Represents the auto scaling settings of a global secondary index for a replica that will be modified.
MembersThe name of the global secondary index.
Represents the auto scaling settings to be modified for a global table or global secondary index.
Represents the properties of a replica global secondary index.
MembersThe name of the global secondary index.
Overrides the maximum on-demand throughput for the specified global secondary index in the specified replica table.
If not described, uses the source table GSI's read capacity settings.
Represents the warm throughput of the global secondary index for this replica.
Represents the properties of a global secondary index.
MembersThe name of the global secondary index. The name must be unique among all other indexes on this table.
The current status of the global secondary index:
CREATING - The global secondary index is being created.
UPDATING - The global secondary index is being updated.
DELETING - The global secondary index is being deleted.
ACTIVE - The global secondary index is ready for use.
Auto scaling settings for a global secondary index replica's read capacity units.
The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException.
Auto scaling settings for a global secondary index replica's write capacity units.
The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException.
Represents the settings of a global secondary index for a global table that will be modified.
MembersThe name of the global secondary index. The name must be unique among all other indexes on this table.
Auto scaling settings for managing a global secondary index replica's read capacity units.
The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException.
The specified replica is no longer part of the global table.
MembersRepresents the properties of a replica.
MembersThe Region name of the replica.
The read/write capacity mode of the replica.
Replica global secondary index settings for the global table.
Auto scaling settings for a global table replica's read capacity units.
The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide.
Auto scaling settings for a global table replica's write capacity units.
The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide.
The current state of the Region:
CREATING - The Region is being created.
UPDATING - The Region is being updated.
DELETING - The Region is being deleted.
ACTIVE - The Region is ready for use.
Contains details of the table class.
Represents the settings for a global table in a Region that will be modified.
MembersThe Region of the replica to be added.
Represents the settings of a global secondary index for a global table that will be modified.
Auto scaling settings for managing a global table replica's read capacity units.
The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide.
Replica-specific table class. If not specified, uses the source table's table class.
Represents one of the following:
A new replica to be added to an existing global table.
New parameters for an existing replica.
An existing replica to be removed from an existing global table.
The parameters required for creating a replica on an existing global table.
The name of the existing replica to be removed.
The request was rejected because one or more items in the request are being modified by a request in another Region.
MembersRepresents one of the following:
A new replica to be added to an existing regional table or global table. This request invokes the CreateTableReplica action in the destination Region.
New parameters for an existing replica. This request invokes the UpdateTable action in the destination Region.
An existing replica to be deleted. The request invokes the DeleteTableReplica action in the destination Region, deleting the replica and all if its items in the destination Region.
When you manually remove a table or global table replica, you do not automatically remove any associated scalable targets, scaling policies, or CloudWatch alarms.
MembersThe parameters required for creating a replica for the table.
The parameters required for deleting a replica for the table.
The parameters required for updating a replica for the table.
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 field in the returned exception. Contact Amazon Web ServicesSupport to request a quota increase.
MembersA list of ThrottlingReason that provide detailed diagnostic information about why the request was throttled.
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.
MembersThe resource which is being attempted to be changed is in use.
The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be ACTIVE.
The resource which is being requested does not exist.
Contains details for the restore.
MembersPoint in time or source backup time.
Indicates if a restore is in progress or not.
The Amazon Resource Name (ARN) of the backup from which the table was restored.
The ARN of the source table of the backup that is being restored.
The S3 bucket that is being imported from.
MembersThe S3 bucket that is being imported from.
The account number of the S3 bucket that is being imported from. If the bucket is owned by the requester this is optional.
The key prefix shared by all S3 Objects that are being imported.
The description of the server-side encryption status on the specified table.
MembersIndicates the time, in UNIX epoch date format, when DynamoDB detected that the table's KMS key was inaccessible. This attribute will automatically be cleared when DynamoDB detects that the table's KMS key is accessible again. DynamoDB will initiate the table archival process when table's KMS key remains inaccessible for more than seven days from this date.
The KMS key ARN used for the KMS encryption.
Server-side encryption type. The only supported value is:
KMS - Server-side encryption that uses Key Management Service. The key is stored in your account and is managed by KMS (KMS charges apply).
Represents the current state of server-side encryption. The only supported values are:
ENABLED - Server-side encryption is enabled.
UPDATING - Server-side encryption is being updated.
Represents the settings used to enable server-side encryption.
MembersIndicates whether server-side encryption is done using an Amazon Web Services managed key or an Amazon Web Services owned key. If enabled (true), server-side encryption type is set to KMS and an Amazon Web Services managed key is used (KMS charges apply). If disabled (false) or not specified, server-side encryption is set to Amazon Web Services owned key.
The KMS key that should be used for the KMS encryption. To specify a key, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. Note that you should only provide this parameter if the key is different from the default DynamoDB key alias/aws/dynamodb.
Server-side encryption type. The only supported value is:
KMS - Server-side encryption that uses Key Management Service. The key is stored in your account and is managed by KMS (KMS charges apply).
Contains the details of the table when the backup was created.
MembersControls how you are charged for read and write throughput and how you manage capacity. This setting can be changed later.
PROVISIONED - Sets the read/write capacity mode to PROVISIONED. We recommend using PROVISIONED for predictable workloads.
PAY_PER_REQUEST - Sets the read/write capacity mode to PAY_PER_REQUEST. We recommend using PAY_PER_REQUEST for unpredictable workloads.
Number of items in the table. Note that this is an approximate value.
Schema of the table.
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.
Read IOPs and Write IOPS on the table when the backup was created.
ARN of the table for which backup was created.
Time when the source table was created.
Unique identifier for the table for which the backup was created.
The name of the table for which the backup was created.
Size of the table in bytes. Note that this is an approximate value.
Contains the details of the features enabled on the table when the backup was created. For example, LSIs, GSIs, streams, TTL.
MembersRepresents the GSI properties for the table when the backup was created. It includes the IndexName, KeySchema, Projection, and ProvisionedThroughput for the GSIs on the table at the time of backup.
Represents the LSI properties for the table when the backup was created. It includes the IndexName, KeySchema and Projection for the LSIs on the table at the time of backup.
The description of the server-side encryption status on the table when the backup was created.
Stream settings on the table when the backup was created.
Time to Live settings on the table when the backup was created.
Represents the DynamoDB Streams configuration for a table in DynamoDB.
MembersIndicates whether DynamoDB Streams is enabled (true) or disabled (false) on the table.
When an item in the table is modified, StreamViewType determines what information is written to the stream for this table. 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.
A target table with the specified name already exists.
MembersRepresents the auto scaling configuration for a global table.
MembersRepresents replicas of the global table.
The name of the table.
The current state of the table:
CREATING - The table is being created.
UPDATING - The table is being updated.
DELETING - The table is being deleted.
ACTIVE - The table is ready for use.
Contains details of the table class.
MembersThe date and time at which the table class was last updated.
The table class of the specified table. Valid values are STANDARD and STANDARD_INFREQUENT_ACCESS.
The parameters for the table created as part of the import operation.
MembersThe attributes of the table created as part of the import operation.
The billing mode for provisioning the table created as part of the import operation.
The Global Secondary Indexes (GSI) of the table to be created as part of the import operation.
The primary key and option sort key of the table created as part of the import operation.
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.
Represents the provisioned throughput settings for the specified global secondary index. You must use ProvisionedThroughput or OnDemandThroughput based on your tableâs capacity mode.
For current minimum and maximum provisioned throughput values, see Service, Account, and Table Quotas in the Amazon DynamoDB Developer Guide.
Represents the settings used to enable server-side encryption.
The name of the table created as part of the import operation.
Represents the properties of a table.
MembersContains information about the table archive.
An array of AttributeDefinition objects. Each of these objects describes one attribute in the table and index key schema.
Each AttributeDefinition object in this array is composed of:
AttributeName - The name of the attribute.
AttributeType - The data type for the attribute.
Contains the details for the read/write capacity mode.
The date and time when the table was created, in UNIX epoch time format.
Indicates whether deletion protection is enabled (true) or disabled (false) on the table.
The global secondary indexes, if any, on the table. Each index is scoped to a given partition key value. Each element is composed of:
Backfilling - If true, then the index is currently in the backfilling phase. Backfilling occurs only when a new global secondary index is added to the table. It is the process by which DynamoDB populates the new index with data from the table. (This attribute does not appear for indexes that were created during a CreateTable operation.)
You can delete an index that is being created during the Backfilling phase when IndexStatus is set to CREATING and Backfilling is true. You can't delete the index that is being created when IndexStatus is set to CREATING and Backfilling is false. (This attribute does not appear for indexes that were created during a CreateTable operation.)
IndexName - The name of the global secondary index.
IndexSizeBytes - The total size of the global secondary index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
IndexStatus - The current status of the global secondary index:
CREATING - The index is being created.
UPDATING - The index is being updated.
DELETING - The index is being deleted.
ACTIVE - The index is ready for use.
ItemCount - The number of items in the global secondary index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
KeySchema - Specifies the complete index key schema. The attribute names in the key schema must be between 1 and 255 characters (inclusive). 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 - In addition to the attributes described in KEYS_ONLY, the secondary index will include other non-key attributes that you specify.
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, along with data about increases and decreases.
If the table is in the DELETING state, no information about indexes will be returned.
Represents the version of global tables in use, if the table is replicated across Amazon Web Services Regions.
The witness Region and its current status in the MRSC global table. Only one witness Region can be configured per MRSC global table.
The number of items in the specified table. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
The primary key structure for the table. Each KeySchemaElement consists of:
AttributeName - The name of the attribute.
KeyType - The role of the attribute:
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 DynamoDB's 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 more information about primary keys, see Primary Key in the Amazon DynamoDB Developer Guide.
The Amazon Resource Name (ARN) that uniquely identifies the latest stream for this table.
A timestamp, in ISO 8601 format, for this stream.
Note that LatestStreamLabel is not a unique identifier for the stream, because it is possible that a stream from another table might have the same timestamp. However, the combination of the following three elements is guaranteed to be unique:
Amazon Web Services customer ID
Table name
StreamLabel
Represents one or more local secondary indexes on the table. Each index is scoped to a given partition key value. Tables with one or more local secondary indexes are subject to an item collection size limit, where the amount of data within a given item collection cannot exceed 10 GB. Each element is composed of:
IndexName - The name of the local secondary index.
KeySchema - Specifies the complete index key schema. The attribute names in the key schema must be between 1 and 255 characters (inclusive). 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.
IndexSizeBytes - Represents the total size of the index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
ItemCount - Represents the number of items in the index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
If the table is in the DELETING state, no information about indexes will be returned.
Indicates one of the following consistency modes for a global table:
EVENTUAL: Indicates that the global table is configured for multi-Region eventual consistency (MREC).
STRONG: Indicates that the global table is configured 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 in DynamoDB developer guide.
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.
The provisioned throughput settings for the table, consisting of read and write capacity units, along with data about increases and decreases.
Represents replicas of the table.
Contains details for the restore.
The description of the server-side encryption status on the specified table.
The current DynamoDB Streams configuration for the table.
The Amazon Resource Name (ARN) that uniquely identifies the table.
Contains details of the table class.
Unique identifier for the table for which the backup was created.
The name of the table.
The total size of the specified table, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
The current state of the table:
CREATING - The table is being created.
UPDATING - The table/index configuration is being updated. The table/index remains available for data operations when UPDATING.
DELETING - The table is being deleted.
ACTIVE - The table is ready for use.
INACCESSIBLE_ENCRYPTION_CREDENTIALS - The KMS key used to encrypt the table in inaccessible. Table operations may fail due to failure to use the KMS key. DynamoDB will initiate the table archival process when a table's KMS key remains inaccessible for more than seven days.
ARCHIVING - The table is being archived. Operations are not allowed until archival is complete.
ARCHIVED - The table has been archived. See the ArchivalReason for more information.
Describes the warm throughput value of the base table.
A target table with the specified name is either being created or deleted.
MembersA source table with the name TableName does not currently exist within the subscriber's account or the subscriber is operating in the wrong Amazon Web Services Region.
Represents the warm throughput value (in read units per second and write units per second) of the table. Warm throughput is applicable for DynamoDB Standard-IA tables and specifies the minimum provisioned capacity maintained for immediate data access.
MembersRepresents the base table's warm throughput value in read units per second.
Represents warm throughput value of the base table.
Represents the base table's warm throughput value in write units per second.
Describes a tag. A tag is a key-value pair. You can add up to 50 tags to a single DynamoDB table.
Amazon Web Services-assigned tag names and values are automatically assigned the aws: prefix, which the user cannot assign. Amazon Web Services-assigned tag names do not count towards the tag limit of 50. User-assigned tag names have the prefix user: in the Cost Allocation Report. You cannot backdate the application of a tag.
For an overview on tagging DynamoDB resources, see Tagging for DynamoDB in the Amazon DynamoDB Developer Guide.
MembersThe key of the tag. Tag keys are case sensitive. Each DynamoDB table can only have up to one tag with the same key. If you try to add an existing tag (same key), the existing tag value will be updated to the new value.
The value of the tag. Tag values are case-sensitive and can be null.
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 field in the returned exception.
MembersA list of ThrottlingReason that provide detailed diagnostic information about why the request was throttled.
Represents the specific reason why a DynamoDB request was throttled and the ARN of the impacted resource. This helps identify exactly what resource is being throttled, what type of operation caused it, and why the throttling occurred.
MembersThe reason for throttling. The throttling reason follows a specific format: ResourceType+OperationType+LimitType:
Resource Type (What is being throttled): Table or Index
Operation Type (What kind of operation): Read or Write
Limit Type (Why the throttling occurred):
ProvisionedThroughputExceeded: The request rate is exceeding the provisioned throughput capacity (read or write capacity units) configured for a table or a global secondary index (GSI) in provisioned capacity mode.
AccountLimitExceeded: The request rate has caused a table or global secondary index (GSI) in on-demand mode to exceed the per-table account-level service quotas for read/write throughput in the current Amazon Web Services Region.
KeyRangeThroughputExceeded: The request rate directed at a specific partition key value has exceeded the internal partition-level throughput limits, indicating uneven access patterns across the table's or GSI's key space.
MaxOnDemandThroughputExceeded: The request rate has exceeded the configured maximum throughput limits set for a table or index in on-demand capacity mode.
Examples of complete throttling reasons:
TableReadProvisionedThroughputExceeded
IndexWriteAccountLimitExceeded
This helps identify exactly what resource is being throttled, what type of operation caused it, and why the throttling occurred.
The Amazon Resource Name (ARN) of the DynamoDB table or index that experienced the throttling event.
The description of the Time to Live (TTL) status on the specified table.
MembersThe name of the TTL attribute for items in the table.
The TTL status for the table.
Represents the settings used to enable or disable Time to Live (TTL) for the specified table.
MembersThe name of the TTL attribute used to store the expiration time for items in the table.
Indicates whether TTL is to be enabled (true) or disabled (false) on the table.
Specifies an item to be retrieved as part of the transaction.
MembersContains the primary key that identifies the item to get, together with the name of the table that contains the item, and optionally the specific attributes of the item to retrieve.
A list of requests that can perform update, put, delete, or check operations on multiple items in one or more tables atomically.
MembersA request to perform a check item operation.
A request to perform a DeleteItem operation.
A request to perform a PutItem operation.
A request to perform an UpdateItem operation.
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.
If using Java, DynamoDB lists the cancellation reasons on the CancellationReasons property. This property is not set for other languages. 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.
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.
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.
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.
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.
A list of cancellation reasons.
Operation was rejected because there is an ongoing transaction for the item.
MembersThe 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, 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 * 2, exponential backoff)
3500-4500 third attempt
4500-6500 third sleep/delay (500 * 2^2)
6500-7500 fourth attempt (this can trigger inline recovery since 5 seconds have elapsed since the first attempt reached TC)
Represents a request to perform an UpdateItem operation.
A condition that must be satisfied in order for a conditional update to succeed.
One or more substitution tokens for attribute names in an expression.
One or more values that can be substituted in an expression.
The primary key of the item to be updated. Each element consists of an attribute name and a value for that attribute.
Use ReturnValuesOnConditionCheckFailure to get the item attributes if the Update condition fails. For ReturnValuesOnConditionCheckFailure, the valid values are: NONE and ALL_OLD.
Name of the table for the UpdateItem request. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.
An expression that defines one or more attributes to be updated, the action to be performed on them, and new value(s) for them.
Represents the new provisioned throughput settings to be applied to a global secondary index.
MembersThe name of the global secondary index to be updated.
Updates the maximum number of read and write units for the specified global secondary index. If you use this parameter, you must specify MaxReadRequestUnits, MaxWriteRequestUnits, or both.
Represents the provisioned throughput settings for the specified global secondary index.
For current minimum and maximum provisioned throughput values, see Service, Account, and Table Quotas in the Amazon DynamoDB Developer Guide.
Represents the warm throughput value of the new provisioned throughput settings to be applied to a global secondary index.
Enables updating the configuration for Kinesis Streaming.
MembersEnables updating the precision of Kinesis data stream timestamp.
Represents a replica to be modified.
MembersReplica-specific global secondary index settings.
The KMS key of the replica that should be used for KMS encryption. To specify a key, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. Note that you should only provide this parameter if the key is different from the default DynamoDB KMS key alias/aws/dynamodb.
Overrides the maximum on-demand throughput for the replica table.
Replica-specific provisioned throughput. If not specified, uses the source table's provisioned throughput settings.
The Region where the replica exists.
Replica-specific table class. If not specified, uses the source table's table class.
Provides visibility into the number of read and write operations your table or secondary index can instantaneously support. The settings can be modified using the UpdateTable operation to meet the throughput requirements of an upcoming peak event.
Represents the number of read operations your base table can instantaneously support.
Represents the number of write operations your base table can instantaneously support.
Represents an operation to perform - either DeleteItem or PutItem. You can only request one of these operations, not both, in a single WriteRequest. If you do need to perform both of these operations, you need to provide two separate WriteRequest objects.
A request to perform a DeleteItem operation.
A request to perform a PutItem operation.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4