Skip to content

S3  >  Operations  >  create_bucket_metadata_table_configuration

create_bucket_metadata_table_configuration

Operation

create_bucket_metadata_table_configuration async

create_bucket_metadata_table_configuration(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[CreateBucketMetadataTableConfigurationInputDict]) -> CreateBucketMetadataTableConfigurationOutput
Warning

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:

Warning

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:

Name Type Description Default
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None

Returns:

Type Description
CreateBucketMetadataTableConfigurationOutput

An instance of CreateBucketMetadataTableConfigurationOutput.

Input

Pass the input fields as keyword arguments, or pass a model or dictionary as the first positional argument. Pass plugins separately as a keyword argument.

Model

CreateBucketMetadataTableConfigurationInput dataclass

Bases: _SerdeShape

Dataclass for CreateBucketMetadataTableConfigurationInput structure.

Attributes
bucket class-attribute instance-attribute
bucket: str | None = ...

The general purpose bucket that you want to create the metadata table configuration for.

checksum_algorithm class-attribute instance-attribute
checksum_algorithm: str | None = ...

The checksum algorithm to use with your metadata table configuration.

content_md5 class-attribute instance-attribute
content_md5: str | None = ...

The Content-MD5 header for the metadata table configuration.

expected_bucket_owner class-attribute instance-attribute
expected_bucket_owner: str | None = ...

The expected owner of the general purpose bucket that corresponds to your metadata table configuration.

metadata_table_configuration class-attribute instance-attribute
metadata_table_configuration: MetadataTableConfiguration | None = ...

The contents of your metadata table configuration.

Dictionaries

CreateBucketMetadataTableConfigurationInputDict

Bases: TypedDict

Dictionary form of CreateBucketMetadataTableConfigurationInput.

Attributes
bucket instance-attribute
bucket: Required[str]

The general purpose bucket that you want to create the metadata table configuration for.

checksum_algorithm instance-attribute
checksum_algorithm: str | None

The checksum algorithm to use with your metadata table configuration.

content_md5 instance-attribute
content_md5: str | None

The Content-MD5 header for the metadata table configuration.

expected_bucket_owner instance-attribute
expected_bucket_owner: str | None

The expected owner of the general purpose bucket that corresponds to your metadata table configuration.

metadata_table_configuration instance-attribute

The contents of your metadata table configuration.

Output

CreateBucketMetadataTableConfigurationOutput dataclass

Bases: _SerdeShape

Dataclass for CreateBucketMetadataTableConfigurationOutput structure.

Attributes

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.