Skip to content

DynamoDB  >  Operations  >  describe_time_to_live

describe_time_to_live

Operation

describe_time_to_live async 

describe_time_to_live(input: DescribeTimeToLiveInput, plugins: list[Plugin] | None = None) -> DescribeTimeToLiveOutput

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

Parameters:

Name Type Description Default
input DescribeTimeToLiveInput

An instance of DescribeTimeToLiveInput.

 required
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

 None

Returns:

Type Description
DescribeTimeToLiveOutput

An instance of DescribeTimeToLiveOutput.

Input

DescribeTimeToLiveInput dataclass

Dataclass for DescribeTimeToLiveInput structure.

Attributes

table_name class-attribute instance-attribute 
table_name: str | None = None

The name of the table to be described. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.

Output

DescribeTimeToLiveOutput dataclass

Dataclass for DescribeTimeToLiveOutput structure.

Attributes

time_to_live_description class-attribute instance-attribute 
time_to_live_description: TimeToLiveDescription | None = None