bucket_metadata_table_configurations

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

Overview

Name	`bucket_metadata_table_configurations`
Type	Resource
Id	`aws.s3.bucket_metadata_table_configurations`

Fields

The following fields are returned by SELECT queries:

get_bucket_metadata_table_configuration

Name	Datatype	Description
`error`	`string`	If the CreateBucketMetadataTableConfiguration request succeeds, but S3 Metadata was unable to create the table, this structure contains the error code and error message.
`metadata_table_configuration_result`	`string`	The V1 S3 Metadata configuration for a general purpose bucket.
`status`	`string`	The status of the metadata table. The status values are: CREATING - The metadata table is in the process of being created in the specified table bucket. ACTIVE - The metadata table has been created successfully, and records are being delivered to the table. FAILED - Amazon S3 is unable to create the metadata table, or Amazon S3 is unable to deliver records. See ErrorDetails for details.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
`get_bucket_metadata_table_configuration`	`select`	`bucket`, `region`	`x-amz-expected-bucket-owner`	We recommend that you retrieve your S3 Metadata configurations by using the V2 GetBucketMetadataTableConfiguration API operation. We no longer recommend using the V1 GetBucketMetadataTableConfiguration API operation. If you created your S3 Metadata configuration before July 15, 2025, we recommend that you delete and re-create your configuration by using CreateBucketMetadataConfiguration so that you can expire journal table records and create a live inventory table. Retrieves the V1 S3 Metadata configuration for a general purpose bucket. For more information, see Accelerating data discovery with S3 Metadata in the Amazon S3 User Guide. You can use the V2 GetBucketMetadataConfiguration API operation with V1 or V2 metadata table configurations. However, if you try to use the V1 GetBucketMetadataTableConfiguration API operation with V2 configurations, you will receive an HTTP 405 Method Not Allowed error. Make sure that you update your processes to use the new V2 API operations (CreateBucketMetadataConfiguration, GetBucketMetadataConfiguration, and DeleteBucketMetadataConfiguration) instead of the V1 API operations. Permissions To use this operation, you must have the s3:GetBucketMetadataTableConfiguration permission. For more information, see Setting up permissions for configuring metadata tables in the Amazon S3 User Guide. The following operations are related to GetBucketMetadataTableConfiguration: CreateBucketMetadataTableConfiguration DeleteBucketMetadataTableConfiguration You must URL encode any signed header values that contain spaces. For example, if your header value is my file.txt, containing two spaces after my, you must URL encode this value to my%20%20file.txt.
`create_bucket_metadata_table_configuration`	`insert`	`bucket`, `region`, `MetadataTableConfiguration`	`Content-MD5`, `x-amz-sdk-checksum-algorithm`, `x-amz-expected-bucket-owner`	We recommend that you create your S3 Metadata configurations by using the V2 CreateBucketMetadataConfiguration API operation. We no longer recommend using the V1 CreateBucketMetadataTableConfiguration API operation. If you created your S3 Metadata configuration before July 15, 2025, we recommend that you delete and re-create your configuration by using CreateBucketMetadataConfiguration so that you can expire journal table records and create a live inventory table. Creates a V1 S3 Metadata configuration for a general purpose bucket. For more information, see Accelerating data discovery with S3 Metadata in the Amazon S3 User Guide. Permissions To use this operation, you must have the following permissions. For more information, see Setting up permissions for configuring metadata tables in the Amazon S3 User Guide. If you want to encrypt your metadata tables with server-side encryption with Key Management Service (KMS) keys (SSE-KMS), you need additional permissions. For more information, see Setting up permissions for configuring metadata tables in the Amazon S3 User Guide. If you also want to integrate your table bucket with Amazon Web Services analytics services so that you can query your metadata table, you need additional permissions. For more information, see Integrating Amazon S3 Tables with Amazon Web Services analytics services in the Amazon S3 User Guide. s3:CreateBucketMetadataTableConfiguration s3tables:CreateNamespace s3tables:GetTable s3tables:CreateTable s3tables:PutTablePolicy The following operations are related to CreateBucketMetadataTableConfiguration: DeleteBucketMetadataTableConfiguration GetBucketMetadataTableConfiguration You must URL encode any signed header values that contain spaces. For example, if your header value is my file.txt, containing two spaces after my, you must URL encode this value to my%20%20file.txt.
`delete_bucket_metadata_table_configuration`	`delete`	`bucket`, `region`	`x-amz-expected-bucket-owner`	We recommend that you delete your S3 Metadata configurations by using the V2 DeleteBucketMetadataTableConfiguration API operation. We no longer recommend using the V1 DeleteBucketMetadataTableConfiguration API operation. If you created your S3 Metadata configuration before July 15, 2025, we recommend that you delete and re-create your configuration by using CreateBucketMetadataConfiguration so that you can expire journal table records and create a live inventory table. Deletes a V1 S3 Metadata configuration from a general purpose bucket. For more information, see Accelerating data discovery with S3 Metadata in the Amazon S3 User Guide. You can use the V2 DeleteBucketMetadataConfiguration API operation with V1 or V2 metadata table configurations. However, if you try to use the V1 DeleteBucketMetadataTableConfiguration API operation with V2 configurations, you will receive an HTTP 405 Method Not Allowed error. Make sure that you update your processes to use the new V2 API operations (CreateBucketMetadataConfiguration, GetBucketMetadataConfiguration, and DeleteBucketMetadataConfiguration) instead of the V1 API operations. Permissions To use this operation, you must have the s3:DeleteBucketMetadataTableConfiguration permission. For more information, see Setting up permissions for configuring metadata tables in the Amazon S3 User Guide. The following operations are related to DeleteBucketMetadataTableConfiguration: CreateBucketMetadataTableConfiguration GetBucketMetadataTableConfiguration You must URL encode any signed header values that contain spaces. For example, if your header value is my file.txt, containing two spaces after my, you must URL encode this value to my%20%20file.txt.

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
`bucket`	`string`	The general purpose bucket that you want to remove the metadata table configuration from.
`region`	`string`	AWS region (default: us-east-1)
`Content-MD5`	`string`	The Content-MD5 header for the metadata table configuration.
`x-amz-expected-bucket-owner`	`string`	The expected bucket owner of the general purpose bucket that you want to remove the metadata table configuration from.
`x-amz-sdk-checksum-algorithm`	`string`	The checksum algorithm to use with your metadata table configuration.

`SELECT` examples

get_bucket_metadata_table_configuration

We recommend that you retrieve your S3 Metadata configurations by using the V2 GetBucketMetadataTableConfiguration API operation. We no longer recommend using the V1 GetBucketMetadataTableConfiguration API operation. If you created your S3 Metadata configuration before July 15, 2025, we recommend that you delete and re-create your configuration by using CreateBucketMetadataConfiguration so that you can expire journal table records and create a live inventory table. Retrieves the V1 S3 Metadata configuration for a general purpose bucket. For more information, see Accelerating data discovery with S3 Metadata in the Amazon S3 User Guide. You can use the V2 GetBucketMetadataConfiguration API operation with V1 or V2 metadata table configurations. However, if you try to use the V1 GetBucketMetadataTableConfiguration API operation with V2 configurations, you will receive an HTTP 405 Method Not Allowed error. Make sure that you update your processes to use the new V2 API operations (CreateBucketMetadataConfiguration, GetBucketMetadataConfiguration, and DeleteBucketMetadataConfiguration) instead of the V1 API operations. Permissions To use this operation, you must have the s3:GetBucketMetadataTableConfiguration permission. For more information, see Setting up permissions for configuring metadata tables in the Amazon S3 User Guide. The following operations are related to GetBucketMetadataTableConfiguration: CreateBucketMetadataTableConfiguration DeleteBucketMetadataTableConfiguration You must URL encode any signed header values that contain spaces. For example, if your header value is my file.txt, containing two spaces after my, you must URL encode this value to my%20%20file.txt.

SELECT
error,
metadata_table_configuration_result,
status
FROM aws.s3.bucket_metadata_table_configurations
WHERE bucket = '{{ bucket }}' -- required
AND region = '{{ region }}' -- required
AND `x-amz-expected-bucket-owner` = '{{ x-amz-expected-bucket-owner }}'
;

`INSERT` examples

create_bucket_metadata_table_configuration
Manifest

We recommend that you create your S3 Metadata configurations by using the V2 CreateBucketMetadataConfiguration API operation. We no longer recommend using the V1 CreateBucketMetadataTableConfiguration API operation. If you created your S3 Metadata configuration before July 15, 2025, we recommend that you delete and re-create your configuration by using CreateBucketMetadataConfiguration so that you can expire journal table records and create a live inventory table. Creates a V1 S3 Metadata configuration for a general purpose bucket. For more information, see Accelerating data discovery with S3 Metadata in the Amazon S3 User Guide. Permissions To use this operation, you must have the following permissions. For more information, see Setting up permissions for configuring metadata tables in the Amazon S3 User Guide. If you want to encrypt your metadata tables with server-side encryption with Key Management Service (KMS) keys (SSE-KMS), you need additional permissions. For more information, see Setting up permissions for configuring metadata tables in the Amazon S3 User Guide. If you also want to integrate your table bucket with Amazon Web Services analytics services so that you can query your metadata table, you need additional permissions. For more information, see Integrating Amazon S3 Tables with Amazon Web Services analytics services in the Amazon S3 User Guide. s3:CreateBucketMetadataTableConfiguration s3tables:CreateNamespace s3tables:GetTable s3tables:CreateTable s3tables:PutTablePolicy The following operations are related to CreateBucketMetadataTableConfiguration: DeleteBucketMetadataTableConfiguration GetBucketMetadataTableConfiguration You must URL encode any signed header values that contain spaces. For example, if your header value is my file.txt, containing two spaces after my, you must URL encode this value to my%20%20file.txt.

INSERT INTO aws.s3.bucket_metadata_table_configurations (
MetadataTableConfiguration,
bucket,
region,
`Content-MD5`,
`x-amz-sdk-checksum-algorithm`,
`x-amz-expected-bucket-owner`
)
SELECT 
'{{ MetadataTableConfiguration }}' /* required */,
'{{ bucket }}',
'{{ region }}',
'{{ Content-MD5 }}',
'{{ x-amz-sdk-checksum-algorithm }}',
'{{ x-amz-expected-bucket-owner }}'
;

# Description fields are for documentation purposes
- name: bucket_metadata_table_configurations
props:
  - name: bucket
    value: "{{ bucket }}"
    description: Required parameter for the bucket_metadata_table_configurations resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the bucket_metadata_table_configurations resource.
  - name: MetadataTableConfiguration
    description: |
      The V1 S3 Metadata configuration for a general purpose bucket. If you created your S3 Metadata configuration before July 15, 2025, we recommend that you delete and re-create your configuration by using CreateBucketMetadataConfiguration so that you can expire journal table records and create a live inventory table.
    value:
      S3TablesDestination:
        TableBucketArn: "{{ TableBucketArn }}"
        TableName: "{{ TableName }}"
  - name: Content-MD5
    value: "{{ Content-MD5 }}"
    description: The Content-MD5 header for the metadata table configuration.
    description: The Content-MD5 header for the metadata table configuration.
  - name: x-amz-sdk-checksum-algorithm
    value: "{{ x-amz-sdk-checksum-algorithm }}"
    description: The checksum algorithm to use with your metadata table configuration.
    description: The checksum algorithm to use with your metadata table configuration.
  - name: x-amz-expected-bucket-owner
    value: "{{ x-amz-expected-bucket-owner }}"
    description: The expected owner of the general purpose bucket that corresponds to your metadata table configuration.
    description: The expected owner of the general purpose bucket that corresponds to your metadata table configuration.

`DELETE` examples

delete_bucket_metadata_table_configuration

We recommend that you delete your S3 Metadata configurations by using the V2 DeleteBucketMetadataTableConfiguration API operation. We no longer recommend using the V1 DeleteBucketMetadataTableConfiguration API operation. If you created your S3 Metadata configuration before July 15, 2025, we recommend that you delete and re-create your configuration by using CreateBucketMetadataConfiguration so that you can expire journal table records and create a live inventory table. Deletes a V1 S3 Metadata configuration from a general purpose bucket. For more information, see Accelerating data discovery with S3 Metadata in the Amazon S3 User Guide. You can use the V2 DeleteBucketMetadataConfiguration API operation with V1 or V2 metadata table configurations. However, if you try to use the V1 DeleteBucketMetadataTableConfiguration API operation with V2 configurations, you will receive an HTTP 405 Method Not Allowed error. Make sure that you update your processes to use the new V2 API operations (CreateBucketMetadataConfiguration, GetBucketMetadataConfiguration, and DeleteBucketMetadataConfiguration) instead of the V1 API operations. Permissions To use this operation, you must have the s3:DeleteBucketMetadataTableConfiguration permission. For more information, see Setting up permissions for configuring metadata tables in the Amazon S3 User Guide. The following operations are related to DeleteBucketMetadataTableConfiguration: CreateBucketMetadataTableConfiguration GetBucketMetadataTableConfiguration You must URL encode any signed header values that contain spaces. For example, if your header value is my file.txt, containing two spaces after my, you must URL encode this value to my%20%20file.txt.

DELETE FROM aws.s3.bucket_metadata_table_configurations
WHERE bucket = '{{ bucket }}' --required
AND region = '{{ region }}' --required
AND `x-amz-expected-bucket-owner` = '{{ x-amz-expected-bucket-owner }}'
;

Overview​

Fields​

Methods​

Parameters​

SELECT examples​

INSERT examples​

DELETE examples​