CreateBucketMetadataConfiguration - Amazon Simple Storage Service

CreateBucketMetadataConfiguration

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 AWS Key Management Service (AWS 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 AWS analytics services so that you can query your metadata table, you need additional permissions. For more information, see Integrating Amazon S3 Tables with AWS 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:PutTableEncryption

  • kms:DescribeKey

The following operations are related to CreateBucketMetadataConfiguration:

Request Syntax

POST /?metadataConfiguration HTTP/1.1 Host: Bucket.s3.amazonaws.com Content-MD5: ContentMD5 x-amz-sdk-checksum-algorithm: ChecksumAlgorithm x-amz-expected-bucket-owner: ExpectedBucketOwner <?xml version="1.0" encoding="UTF-8"?> <MetadataConfiguration xmlns="http://s3.amazonaws.com/doc/2006-03-01/"> <JournalTableConfiguration> <EncryptionConfiguration> <KmsKeyArn>string</KmsKeyArn> <SseAlgorithm>string</SseAlgorithm> </EncryptionConfiguration> <RecordExpiration> <Days>integer</Days> <Expiration>string</Expiration> </RecordExpiration> </JournalTableConfiguration> <InventoryTableConfiguration> <ConfigurationState>string</ConfigurationState> <EncryptionConfiguration> <KmsKeyArn>string</KmsKeyArn> <SseAlgorithm>string</SseAlgorithm> </EncryptionConfiguration> </InventoryTableConfiguration> </MetadataConfiguration>

URI Request Parameters

The request uses the following URI parameters.

Bucket

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

Required: Yes

Content-MD5

The Content-MD5 header for the metadata configuration.

x-amz-expected-bucket-owner

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

x-amz-sdk-checksum-algorithm

The checksum algorithm to use with your metadata configuration.

Valid Values: CRC32 | CRC32C | SHA1 | SHA256 | CRC64NVME

Request Body

The request accepts the following data in XML format.

MetadataConfiguration

Root level tag for the MetadataConfiguration parameters.

Required: Yes

InventoryTableConfiguration

The inventory table configuration for a metadata configuration.

Type: InventoryTableConfiguration data type

Required: No

JournalTableConfiguration

The journal table configuration for a metadata configuration.

Type: JournalTableConfiguration data type

Required: Yes

Response Syntax

HTTP/1.1 200

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: