[ aws . dynamodb ]

update-time-to-live

Description

The UpdateTimeToLive method enables or disables Time to Live (TTL) for the specified table. A successful UpdateTimeToLive call returns the current TimeToLiveSpecification . It can take up to one hour for the change to fully process. Any additional UpdateTimeToLive calls for the same table during this one hour duration result in a ValidationException .

TTL compares the current time in epoch time format to the time stored in the TTL attribute of an item. If the epoch time value stored in the attribute is less than the current time, the item is marked as expired and subsequently deleted.

Note

The epoch time format is the number of seconds elapsed since 12:00:00 AM January 1, 1970 UTC.

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

Warning

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.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  update-time-to-live
--table-name <value>
--time-to-live-specification <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--table-name (string)

The name of the table to be configured.

--time-to-live-specification (structure)

Represents the settings used to enable or disable Time to Live for the specified table.

Enabled -> (boolean)

Indicates whether TTL is to be enabled (true) or disabled (false) on the table.

AttributeName -> (string)

The name of the TTL attribute used to store the expiration time for items in the table.

Shorthand Syntax:

Enabled=boolean,AttributeName=string

JSON Syntax:

{
  "Enabled": true|false,
  "AttributeName": "string"
}

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Examples

To update Time to Live settings on a table

The following update-time-to-live example enables Time to Live on the specified table.

aws dynamodb update-time-to-live \
    --table-name MusicCollection \
    --time-to-live-specification Enabled=true,AttributeName=ttl

Output:

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

For more information, see Time to Live in the Amazon DynamoDB Developer Guide.

Output

TimeToLiveSpecification -> (structure)

Represents the output of an UpdateTimeToLive operation.

Enabled -> (boolean)

Indicates whether TTL is to be enabled (true) or disabled (false) on the table.

AttributeName -> (string)

The name of the TTL attribute used to store the expiration time for items in the table.