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

    Class CreateBucketMetadataConfigurationCommand

    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

      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:

    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, CreateBucketMetadataConfigurationCommand } from "ibm-cos-sdk-v2"; // ES Modules import
    // const { S3Client, CreateBucketMetadataConfigurationCommand } = 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 = { // CreateBucketMetadataConfigurationRequest
    Bucket: "STRING_VALUE", // required
    ContentMD5: "STRING_VALUE",
    ChecksumAlgorithm: "CRC32" || "CRC32C" || "SHA1" || "SHA256" || "CRC64NVME",
    MetadataConfiguration: { // MetadataConfiguration
    JournalTableConfiguration: { // JournalTableConfiguration
    RecordExpiration: { // RecordExpiration
    Expiration: "ENABLED" || "DISABLED", // required
    Days: Number("int"),
    },
    EncryptionConfiguration: { // MetadataTableEncryptionConfiguration
    SseAlgorithm: "aws:kms" || "AES256", // required
    KmsKeyArn: "STRING_VALUE",
    },
    },
    InventoryTableConfiguration: { // InventoryTableConfiguration
    ConfigurationState: "ENABLED" || "DISABLED", // required
    EncryptionConfiguration: {
    SseAlgorithm: "aws:kms" || "AES256", // required
    KmsKeyArn: "STRING_VALUE",
    },
    },
    },
    ExpectedBucketOwner: "STRING_VALUE",
    };
    const command = new CreateBucketMetadataConfigurationCommand(input);
    const response = await client.send(command);
    // {};

    CreateBucketMetadataConfigurationCommandInput

    S3ServiceException

    Base exception class for all service exceptions from S3 service.

    Hierarchy

    Index

    Constructors

    Constructors

    • Returns CreateBucketMetadataConfigurationCommand

    • Parameters

      Returns CreateBucketMetadataConfigurationCommand