table_maintenance_configurations
Creates, updates, deletes, gets or lists a table_maintenance_configurations resource.
Overview
| Name | table_maintenance_configurations |
| Type | Resource |
| Id | aws.s3tables.table_maintenance_configurations |
Fields
The following fields are returned by SELECT queries:
- get_table_maintenance_configuration
| Name | Datatype | Description |
|---|---|---|
configuration | object | Details about the maintenance configuration for the table bucket. |
table_arn | string | The Amazon Resource Name (ARN) of the table. (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_maintenance_configuration | select | table_bucket_arn, namespace, name, region | Gets details about the maintenance configuration of a table. For more information, see S3 Tables maintenance in the Amazon Simple Storage Service User Guide. Permissions You must have the s3tables:GetTableMaintenanceConfiguration permission to use this operation. You must have the s3tables:GetTableData permission to use set the compaction strategy to sort or zorder. | |
put_table_maintenance_configuration | replace | table_bucket_arn, namespace, name, type, region, value | Creates a new maintenance configuration or replaces an existing maintenance configuration for a table. For more information, see S3 Tables maintenance in the Amazon Simple Storage Service User Guide. Permissions You must have the s3tables:PutTableMaintenanceConfiguration 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 |
|---|---|---|
name | string | The name of the table. |
namespace | string | The namespace of the table. |
region | string | AWS region (default: us-east-1) |
table_bucket_arn | string | The Amazon Resource Name (ARN) of the table associated with the maintenance configuration. |
type | string | The type of the maintenance configuration. |
SELECT examples
- get_table_maintenance_configuration
Gets details about the maintenance configuration of a table. For more information, see S3 Tables maintenance in the Amazon Simple Storage Service User Guide. Permissions You must have the s3tables:GetTableMaintenanceConfiguration permission to use this operation. You must have the s3tables:GetTableData permission to use set the compaction strategy to sort or zorder.
SELECT
configuration,
table_arn
FROM aws.s3tables.table_maintenance_configurations
WHERE table_bucket_arn = '{{ table_bucket_arn }}' -- required
AND namespace = '{{ namespace }}' -- required
AND name = '{{ name }}' -- required
AND region = '{{ region }}' -- required
;
REPLACE examples
- put_table_maintenance_configuration
Creates a new maintenance configuration or replaces an existing maintenance configuration for a table. For more information, see S3 Tables maintenance in the Amazon Simple Storage Service User Guide. Permissions You must have the s3tables:PutTableMaintenanceConfiguration permission to use this operation.
REPLACE aws.s3tables.table_maintenance_configurations
SET
value = '{{ value }}'
WHERE
table_bucket_arn = '{{ table_bucket_arn }}' --required
AND namespace = '{{ namespace }}' --required
AND name = '{{ name }}' --required
AND type = '{{ type }}' --required
AND region = '{{ region }}' --required
AND value = '{{ value }}' --required;