TransactWriteItemsCommand

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.

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.

An error occurred on the server side.

Your request rate is too high. 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. Please contact Amazon Web ServicesSupport  to request a quota increase.

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.

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

• 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)