table_replication_status
Creates, updates, deletes, gets or lists a table_replication_status resource.
Overview
| Name | table_replication_status |
| Type | Resource |
| Id | aws.s3tables.table_replication_status |
Fields
The following fields are returned by SELECT queries:
- get_table_replication_status
| Name | Datatype | Description |
|---|---|---|
destinations | array | An array of status information for each replication destination, including the current state, last successful update, and any error messages. |
source_table_arn | string | The Amazon Resource Name (ARN) of the source table being replicated. (pattern: <code>(arn:aws[-a-z0-9]:[a-z0-9]+:[-a-z0-9]:[0-9]{12}:bucket/[a-z0-9_-]{3,63}/table/[a-zA-Z0-9-_]{1,255})</code>) |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get_table_replication_status | select | tableArn, region | Retrieves the replication status for a table, including the status of replication to each destination. This operation provides visibility into replication health and progress. Permissions You must have the s3tables:GetTableReplicationStatus 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_replication_status
Retrieves the replication status for a table, including the status of replication to each destination. This operation provides visibility into replication health and progress. Permissions You must have the s3tables:GetTableReplicationStatus permission to use this operation.
SELECT
destinations,
source_table_arn
FROM aws.s3tables.table_replication_status
WHERE tableArn = '{{ tableArn }}' -- required
AND region = '{{ region }}' -- required
;