create_bucket_metadata_configuration¶
Operation¶
create_bucket_metadata_configuration
async
¶
create_bucket_metadata_configuration(request: CreateBucketMetadataConfigurationInput | CreateBucketMetadataConfigurationInputDict, /, *, plugins: list[Plugin] | None = None) -> CreateBucketMetadataConfigurationOutput
create_bucket_metadata_configuration(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[CreateBucketMetadataConfigurationInputDict]) -> CreateBucketMetadataConfigurationOutput
Creates an S3 Metadata V2 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 in your KMS key policy. 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.
To query your metadata tables, you need additional permissions. For more information, see Permissions for querying metadata tables in the Amazon S3 User Guide.
s3:CreateBucketMetadataTableConfiguration
Note: The IAM policy action name is the same for the V1 and V2 API operations.
-
s3tables:CreateTableBucket -
s3tables:CreateNamespace -
s3tables:GetTable -
s3tables:CreateTable -
s3tables:PutTablePolicy -
s3tables:PutTableBucketPolicy -
s3tables:PutTableEncryption -
kms:DescribeKey -
iam:PassRole- required if you include anAnnotationTableConfigurationwith an IAM role.
The following operations are related to
CreateBucketMetadataConfiguration:
If you include an AnnotationTableConfiguration with an IAM role, the
role must have a trust policy that allows the Amazon S3 metadata service
to assume it, and a permissions policy that grants the actions needed to
read annotations from your bucket. The following examples show a trust
policy and a permissions policy that you can adapt for your bucket and
account.
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 |
|---|---|
CreateBucketMetadataConfigurationOutput
|
An instance of |
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¶
CreateBucketMetadataConfigurationInput
dataclass
¶
Bases: _SerdeShape
Dataclass for CreateBucketMetadataConfigurationInput structure.
Attributes¶
bucket
class-attribute
instance-attribute
¶
bucket: str | None = ...
The general purpose bucket that you want to create the metadata configuration for.
checksum_algorithm
class-attribute
instance-attribute
¶
checksum_algorithm: str | None = ...
The checksum algorithm to use with your metadata configuration.
content_md5
class-attribute
instance-attribute
¶
content_md5: str | None = ...
The Content-MD5 header for the metadata 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 configuration.
metadata_configuration
class-attribute
instance-attribute
¶
metadata_configuration: MetadataConfiguration | None = ...
The contents of your metadata configuration.
Dictionaries¶
CreateBucketMetadataConfigurationInputDict
¶
Bases: TypedDict
Dictionary form of CreateBucketMetadataConfigurationInput.
Attributes¶
bucket
instance-attribute
¶
The general purpose bucket that you want to create the metadata configuration for.
checksum_algorithm
instance-attribute
¶
checksum_algorithm: str | None
The checksum algorithm to use with your metadata configuration.
content_md5
instance-attribute
¶
content_md5: str | None
The Content-MD5 header for the metadata configuration.
expected_bucket_owner
instance-attribute
¶
expected_bucket_owner: str | None
The expected owner of the general purpose bucket that corresponds to your metadata configuration.
metadata_configuration
instance-attribute
¶
metadata_configuration: Required[MetadataConfiguration | MetadataConfigurationDict]
The contents of your metadata configuration.
Output¶
CreateBucketMetadataConfigurationOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for CreateBucketMetadataConfigurationOutput structure.