DynamoDB / Client / describe_time_to_live

describe_time_to_live

DynamoDB.Client.describe_time_to_live(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.describe_time_to_live(
    TableName='string'
)

Parameters:

TableName (string) –

[REQUIRED]

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

Return type:

dict

Returns:

Response Syntax

{
    'TimeToLiveDescription': {
        'TimeToLiveStatus': 'ENABLING'|'DISABLING'|'ENABLED'|'DISABLED',
        'AttributeName': 'string'
    }
}

Response Structure

• (dict) –

  • TimeToLiveDescription (dict) –

    • TimeToLiveStatus (string) –

      The TTL status for the table.

    • AttributeName (string) –

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

Exceptions

• DynamoDB.Client.exceptions.ResourceNotFoundException

• DynamoDB.Client.exceptions.InternalServerError