:doc:`S3Tables <../../s3tables>` / Client / get_table_record_expiration_configuration

*****************************************
get_table_record_expiration_configuration
*****************************************



.. py:method:: S3Tables.Client.get_table_record_expiration_configuration(**kwargs)

  

  Retrieves the expiration configuration settings for records in a table, and the status of the configuration. If the status of the configuration is ``enabled``, records expire and are automatically removed from the table after the specified number of days.

    Permissions  

  You must have the ``s3tables:GetTableRecordExpirationConfiguration`` permission to use this operation.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/s3tables-2018-05-10/GetTableRecordExpirationConfiguration>`_  


  **Request Syntax**
  ::

    response = client.get_table_record_expiration_configuration(
        tableArn='string'
    )
    
  :type tableArn: string
  :param tableArn: **[REQUIRED]** 

    The Amazon Resource Name (ARN) of the table.

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'configuration': {
              'status': 'enabled'|'disabled',
              'settings': {
                  'days': 123
              }
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **configuration** *(dict) --* 

        The record expiration configuration for the table, including the status and retention settings.

        
        

        - **status** *(string) --* 

          The status of the expiration settings for records in the table.

          
        

        - **settings** *(dict) --* 

          The expiration settings for records in the table.

          
          

          - **days** *(integer) --* 

            If you enable record expiration for a table, you can specify the number of days to retain your table records. For example, to retain your table records for one year, set this value to ``365``.

            
      
    
  
  **Exceptions**
  
  *   :py:class:`S3Tables.Client.exceptions.InternalServerErrorException`

  
  *   :py:class:`S3Tables.Client.exceptions.MethodNotAllowedException`

  
  *   :py:class:`S3Tables.Client.exceptions.ForbiddenException`

  
  *   :py:class:`S3Tables.Client.exceptions.NotFoundException`

  
  *   :py:class:`S3Tables.Client.exceptions.TooManyRequestsException`

  
  *   :py:class:`S3Tables.Client.exceptions.BadRequestException`

  