table_record_expiration_configurations

Creates, updates, deletes, gets or lists a table_record_expiration_configurations resource.

Overview

Name	table_record_expiration_configurations
Type	Resource
Id	aws.s3tables.table_record_expiration_configurations

Fields

The following fields are returned by SELECT queries:

get_table_record_expiration_configuration

Name	Datatype	Description
settings	object	The expiration settings for records in the table.
status	string	The status of the expiration settings for records in the table. (enabled, disabled)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_table_record_expiration_configuration	select	tableArn, region		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.
put_table_record_expiration_configuration	replace	tableArn, region, value		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.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)
tableArn	string	The Amazon Resource Name (ARN) of the table.

SELECT examples

get_table_record_expiration_configuration

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.

SELECT
settings,
status
FROM aws.s3tables.table_record_expiration_configurations
WHERE tableArn = '{{ tableArn }}' -- required
AND region = '{{ region }}' -- required
;

REPLACE examples

put_table_record_expiration_configuration

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.

REPLACE aws.s3tables.table_record_expiration_configurations
SET 
value = '{{ value }}'
WHERE 
tableArn = '{{ tableArn }}' --required
AND region = '{{ region }}' --required
AND value = '{{ value }}' --required;