/

POST

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.

DynamoDB deletes expired items on a best-effort basis to ensure availability of throughput for other data operations.

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.

Request

Header Params

Body Params application/json

Examples

Responses

🟢200Success

application/json

Body

🟠480ResourceInUseException

🟠481ResourceNotFoundException

🟠482LimitExceededException

🟠483InternalServerError

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/' \
--header 'X-Amz-Target;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "TableName": "string",
    "TimeToLiveSpecification": {
        "Enabled": true,
        "AttributeName": "string"
    }
}'

Response Example

200 - Example 1

{
    "TimeToLiveSpecification": {
        "Enabled": true,
        "AttributeName": "string"
    }
}

Modified at 2023-08-22 09:04:07

BatchExecuteStatementOutput