Skip to content

describe_time_to_live

Operation

describe_time_to_live

describe_time_to_live(request: DescribeTimeToLiveInput | DescribeTimeToLiveInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeTimeToLiveInputDict]) -> DescribeTimeToLiveOutput

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

Parameters:

Name Type Description Default
request DescribeTimeToLiveInput | DescribeTimeToLiveInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[DescribeTimeToLiveInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DescribeTimeToLiveOutput

An instance of DescribeTimeToLiveOutput.

describe_time_to_live async

describe_time_to_live(request: DescribeTimeToLiveInput | DescribeTimeToLiveInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeTimeToLiveInputDict]) -> DescribeTimeToLiveOutput

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

Parameters:

Name Type Description Default
request DescribeTimeToLiveInput | DescribeTimeToLiveInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[DescribeTimeToLiveInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DescribeTimeToLiveOutput

An instance of DescribeTimeToLiveOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

DescribeTimeToLiveInputDict

Bases: TypedDict

Dictionary form of DescribeTimeToLiveInput.

Attributes

table_name instance-attribute
table_name: Required[str]

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

DescribeTimeToLiveInput dataclass

Bases: _SerdeShape

Dataclass for DescribeTimeToLiveInput structure.

Attributes

table_name class-attribute instance-attribute
table_name: str | 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

Bases: _SerdeShape

Dataclass for DescribeTimeToLiveOutput structure.

Attributes

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.

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