:doc:`DynamoDB <../../dynamodb>` / Client / describe_time_to_live

*********************
describe_time_to_live
*********************



.. py:method:: 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 <https://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/DescribeTimeToLive>`_  


  **Request Syntax**
  ::

    response = client.describe_time_to_live(
        TableName='string'
    )
    
  :type TableName: string
  :param TableName: **[REQUIRED]** 

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

    

  
  
  :rtype: 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**
  
  *   :py:class:`DynamoDB.Client.exceptions.ResourceNotFoundException`

  
  *   :py:class:`DynamoDB.Client.exceptions.InternalServerError`

  