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

*****************************************
put_table_record_expiration_configuration
*****************************************



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

  

  Creates or updates the expiration configuration settings for records in a table, including the status of the configuration. If you enable record expiration for a table, records expire and are automatically removed from the table after the number of days that you specify.

    Permissions  

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

  

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


  **Request Syntax**
  ::

    response = client.put_table_record_expiration_configuration(
        tableArn='string',
        value={
            'status': 'enabled'|'disabled',
            'settings': {
                'days': 123
            }
        }
    )
    
  :type tableArn: string
  :param tableArn: **[REQUIRED]** 

    The Amazon Resource Name (ARN) of the table.

    

  
  :type value: dict
  :param value: **[REQUIRED]** 

    The record expiration configuration to apply to the table, including the status ( ``enabled`` or ``disabled``) and retention period in days.

    

  
    - **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``.

        

      
    
  
  
  :returns: None
  **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`

  