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

    Class PutObjectLockConfigurationCommand

    This operation is not supported for directory buckets.

    Places an Object Lock configuration on the specified bucket. The rule specified in the Object Lock configuration will be applied by default to every new object placed in the specified bucket. For more information, see Locking Objects.

    • The DefaultRetention settings require both a mode and a period.

    • The DefaultRetention period can be either Days or Years but you must select one. You cannot specify Days and Years at the same time.

    • You can enable Object Lock for new or existing buckets. For more information, see Configuring Object Lock.

    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, PutObjectLockConfigurationCommand } from "ibm-cos-sdk-v2"; // ES Modules import
    // const { S3Client, PutObjectLockConfigurationCommand } = 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 = { // PutObjectLockConfigurationRequest
    Bucket: "STRING_VALUE", // required
    ObjectLockConfiguration: { // ObjectLockConfiguration
    ObjectLockEnabled: "Enabled",
    Rule: { // ObjectLockRule
    DefaultRetention: { // DefaultRetention
    Mode: "GOVERNANCE" || "COMPLIANCE",
    Days: Number("int"),
    Years: Number("int"),
    },
    },
    },
    RequestPayer: "requester",
    Token: "STRING_VALUE",
    ContentMD5: "STRING_VALUE",
    ChecksumAlgorithm: "CRC32" || "CRC32C" || "SHA1" || "SHA256" || "CRC64NVME",
    ExpectedBucketOwner: "STRING_VALUE",
    };
    const command = new PutObjectLockConfigurationCommand(input);
    const response = await client.send(command);
    // { // PutObjectLockConfigurationOutput
    // RequestCharged: "requester",
    // };

    PutObjectLockConfigurationCommandInput

    S3ServiceException

    Base exception class for all service exceptions from S3 service.

    Hierarchy

    Index

    Constructors

    Constructors

    • Returns PutObjectLockConfigurationCommand

    • Parameters

      Returns PutObjectLockConfigurationCommand