IBM COS SDK for JavaScript V2 - v1.0.0
    Preparing search index...

    Class CreateBucketMetadataTableConfigurationCommand

    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:

    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.

    Use a bare-bones client and the command you need to make an API call.

    import { S3Client, CreateBucketMetadataTableConfigurationCommand } from "ibm-cos-sdk-v2"; // ES Modules import
    // const { S3Client, CreateBucketMetadataTableConfigurationCommand } = require("ibm-cos-sdk-v2"); // CommonJS import
    // import type { S3ClientConfig } from "ibm-cos-sdk-v2";
    const config = {}; // type is S3ClientConfig
    const client = new S3Client(config);
    const input = { // CreateBucketMetadataTableConfigurationRequest
    Bucket: "STRING_VALUE", // required
    ContentMD5: "STRING_VALUE",
    ChecksumAlgorithm: "CRC32" || "CRC32C" || "SHA1" || "SHA256" || "CRC64NVME",
    MetadataTableConfiguration: { // MetadataTableConfiguration
    S3TablesDestination: { // S3TablesDestination
    TableBucketArn: "STRING_VALUE", // required
    TableName: "STRING_VALUE", // required
    },
    },
    ExpectedBucketOwner: "STRING_VALUE",
    };
    const command = new CreateBucketMetadataTableConfigurationCommand(input);
    const response = await client.send(command);
    // {};

    CreateBucketMetadataTableConfigurationCommandInput

    S3ServiceException

    Base exception class for all service exceptions from S3 service.

    Hierarchy

    Index

    Constructors

    Constructors

    • Returns CreateBucketMetadataTableConfigurationCommand

    • Parameters

      Returns CreateBucketMetadataTableConfigurationCommand