AWS CLI Command Reference

[ aws . s3api ]

create-bucket-metadata-configuration

Description

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:PutTableEncryption
  • kms:DescribeKey

The following operations are related to CreateBucketMetadataConfiguration :

See also: AWS API Documentation

Synopsis

  create-bucket-metadata-configuration
--bucket <value>
[--content-md5 <value>]
[--checksum-algorithm <value>]
--metadata-configuration <value>
[--expected-bucket-owner <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Options

--bucket (string)

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

--content-md5 (string)

The Content-MD5 header for the metadata configuration.

--checksum-algorithm (string)

The checksum algorithm to use with your metadata configuration.

Possible values:

  • CRC32
  • CRC32C
  • SHA1
  • SHA256
  • CRC64NVME

--metadata-configuration (structure)

The contents of your metadata configuration.

JournalTableConfiguration -> (structure)

The journal table configuration for a metadata configuration.

RecordExpiration -> (structure)

The journal table record expiration settings for the journal table.

Expiration -> (string)

Specifies whether journal table record expiration is enabled or disabled.

Days -> (integer)

If you enable journal table record expiration, you can set the number of days to retain your journal table records. Journal table records must be retained for a minimum of 7 days. To set this value, specify any whole number from 7 to 2147483647 . For example, to retain your journal table records for one year, set this value to 365 .

EncryptionConfiguration -> (structure)

The encryption configuration for the journal table.

SseAlgorithm -> (string)

The encryption type specified for a metadata table. To specify server-side encryption with Key Management Service (KMS) keys (SSE-KMS), use the aws:kms value. To specify server-side encryption with Amazon S3 managed keys (SSE-S3), use the AES256 value.

KmsKeyArn -> (string)

If server-side encryption with Key Management Service (KMS) keys (SSE-KMS) is specified, you must also specify the KMS key Amazon Resource Name (ARN). You must specify a customer-managed KMS key that’s located in the same Region as the general purpose bucket that corresponds to the metadata table configuration.

InventoryTableConfiguration -> (structure)

The inventory table configuration for a metadata configuration.

ConfigurationState -> (string)

The configuration state of the inventory table, indicating whether the inventory table is enabled or disabled.

EncryptionConfiguration -> (structure)

The encryption configuration for the inventory table.

SseAlgorithm -> (string)

The encryption type specified for a metadata table. To specify server-side encryption with Key Management Service (KMS) keys (SSE-KMS), use the aws:kms value. To specify server-side encryption with Amazon S3 managed keys (SSE-S3), use the AES256 value.

KmsKeyArn -> (string)

If server-side encryption with Key Management Service (KMS) keys (SSE-KMS) is specified, you must also specify the KMS key Amazon Resource Name (ARN). You must specify a customer-managed KMS key that’s located in the same Region as the general purpose bucket that corresponds to the metadata table configuration.

Shorthand Syntax:

JournalTableConfiguration={RecordExpiration={Expiration=string,Days=integer},EncryptionConfiguration={SseAlgorithm=string,KmsKeyArn=string}},InventoryTableConfiguration={ConfigurationState=string,EncryptionConfiguration={SseAlgorithm=string,KmsKeyArn=string}}

JSON Syntax:

{
  "JournalTableConfiguration": {
    "RecordExpiration": {
      "Expiration": "ENABLED"|"DISABLED",
      "Days": integer
    },
    "EncryptionConfiguration": {
      "SseAlgorithm": "aws:kms"|"AES256",
      "KmsKeyArn": "string"
    }
  },
  "InventoryTableConfiguration": {
    "ConfigurationState": "ENABLED"|"DISABLED",
    "EncryptionConfiguration": {
      "SseAlgorithm": "aws:kms"|"AES256",
      "KmsKeyArn": "string"
    }
  }
}

--expected-bucket-owner (string)

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

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table
  • yaml
  • yaml-stream

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Output

None

© Copyright 2025, Amazon Web Services. Created using Sphinx.