Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . dynamodb ]

describe-time-to-live

Description

Gives a description of the Time to Live (TTL) status on the specified table.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  describe-time-to-live
--table-name <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--table-name (string)

The name of the table to be described.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. 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 view Time to Live settings for a table

The following describe-time-to-live example displays Time to Live settings for the MusicCollection table.

aws dynamodb describe-time-to-live \
    --table-name MusicCollection

Output:

{
    "TimeToLiveDescription": {
        "TimeToLiveStatus": "ENABLED",
        "AttributeName": "ttl"
    }
}

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

Output

TimeToLiveDescription -> (structure)

TimeToLiveStatus -> (string)

The TTL status for the table.

AttributeName -> (string)

The name of the TTL attribute for items in the table.