table_bucket_metrics_configurations

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

Overview

Name	table_bucket_metrics_configurations
Type	Resource
Id	aws.s3tables.table_bucket_metrics_configurations

Fields

The following fields are returned by SELECT queries:

get_table_bucket_metrics_configuration

Name	Datatype	Description
id	string	The unique identifier of the metrics configuration.
table_bucket_arn	string	The Amazon Resource Name (ARN) of the table bucket. (pattern: <code>(arn:aws[-a-z0-9]:[a-z0-9]+:[-a-z0-9]:[0-9]{12}:bucket/[a-z0-9_-]{3,63})</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_table_bucket_metrics_configuration	select	table_bucket_arn, region		Gets the metrics configuration for a table bucket. Permissions You must have the s3tables:GetTableBucketMetricsConfiguration permission to use this operation.
put_table_bucket_metrics_configuration	replace	table_bucket_arn, region		Sets the metrics configuration for a table bucket. Permissions You must have the s3tables:PutTableBucketMetricsConfiguration permission to use this operation.
delete_table_bucket_metrics_configuration	delete	table_bucket_arn, region		Deletes the metrics configuration for a table bucket. Permissions You must have the s3tables:DeleteTableBucketMetricsConfiguration 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)
table_bucket_arn	string	The Amazon Resource Name (ARN) of the table bucket.

SELECT examples

get_table_bucket_metrics_configuration

Gets the metrics configuration for a table bucket. Permissions You must have the s3tables:GetTableBucketMetricsConfiguration permission to use this operation.

SELECT
id,
table_bucket_arn
FROM aws.s3tables.table_bucket_metrics_configurations
WHERE table_bucket_arn = '{{ table_bucket_arn }}' -- required
AND region = '{{ region }}' -- required
;

REPLACE examples

put_table_bucket_metrics_configuration

Sets the metrics configuration for a table bucket. Permissions You must have the s3tables:PutTableBucketMetricsConfiguration permission to use this operation.

REPLACE aws.s3tables.table_bucket_metrics_configurations
SET 
-- No updatable properties
WHERE 
table_bucket_arn = '{{ table_bucket_arn }}' --required
AND region = '{{ region }}' --required;

DELETE examples

delete_table_bucket_metrics_configuration

Deletes the metrics configuration for a table bucket. Permissions You must have the s3tables:DeleteTableBucketMetricsConfiguration permission to use this operation.

DELETE FROM aws.s3tables.table_bucket_metrics_configurations
WHERE table_bucket_arn = '{{ table_bucket_arn }}' --required
AND region = '{{ region }}' --required
;