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

    Class UpdateBucketMetadataInventoryTableConfigurationCommand

    Enables or disables a live inventory table for an S3 Metadata configuration on 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 inventory table 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.

    • s3:UpdateBucketMetadataInventoryTableConfiguration

    • s3tables:CreateTableBucket

    • s3tables:CreateNamespace

    • s3tables:GetTable

    • s3tables:CreateTable

    • s3tables:PutTablePolicy

    • s3tables:PutTableEncryption

    • kms:DescribeKey

    The following operations are related to UpdateBucketMetadataInventoryTableConfiguration:

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

    UpdateBucketMetadataInventoryTableConfigurationCommandInput

    S3ServiceException

    Base exception class for all service exceptions from S3 service.

    Hierarchy

    Index

    Constructors

    Constructors

    • Returns UpdateBucketMetadataInventoryTableConfigurationCommand

    • Returns UpdateBucketMetadataInventoryTableConfigurationCommand