S3Tables / Client / put_table_record_expiration_configuration

put_table_record_expiration_configuration

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

Request Syntax

response = client.put_table_record_expiration_configuration(
    tableArn='string',
    value={
        'status': 'enabled'|'disabled',
        'settings': {
            'days': 123
        }
    }
)

Parameters:

• tableArn (string) –

  [REQUIRED]

  The Amazon Resource Name (ARN) of the table.

• value (dict) –

  [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

• S3Tables.Client.exceptions.InternalServerErrorException

• S3Tables.Client.exceptions.MethodNotAllowedException

• S3Tables.Client.exceptions.ForbiddenException

• S3Tables.Client.exceptions.NotFoundException

• S3Tables.Client.exceptions.TooManyRequestsException

• S3Tables.Client.exceptions.BadRequestException