table_record_expiration_job_status
Creates, updates, deletes, gets or lists a table_record_expiration_job_status resource.
Overview
| Name | table_record_expiration_job_status |
| Type | Resource |
| Id | aws.s3tables.table_record_expiration_job_status |
Fields
The following fields are returned by SELECT queries:
- get_table_record_expiration_job_status
| Name | Datatype | Description |
|---|---|---|
failure_message | string | If the job failed, this field contains an error message describing the failure reason. |
last_run_timestamp | string (date-time) | The timestamp when the expiration job was last executed. |
metrics | object | Metrics about the most recent expiration job execution, including the number of records and files deleted. |
status | string | The current status of the most recent expiration job. (NotYetRun, Successful, Failed, Disabled) |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get_table_record_expiration_job_status | select | tableArn, region | Retrieves the status, metrics, and details of the latest record expiration job for a table. This includes when the job ran, and whether it succeeded or failed. If the job ran successfully, this also includes statistics about the records that were removed. Permissions You must have the s3tables:GetTableRecordExpirationJobStatus 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_job_status
Retrieves the status, metrics, and details of the latest record expiration job for a table. This includes when the job ran, and whether it succeeded or failed. If the job ran successfully, this also includes statistics about the records that were removed. Permissions You must have the s3tables:GetTableRecordExpirationJobStatus permission to use this operation.
SELECT
failure_message,
last_run_timestamp,
metrics,
status
FROM aws.s3tables.table_record_expiration_job_status
WHERE tableArn = '{{ tableArn }}' -- required
AND region = '{{ region }}' -- required
;