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

    Class GetObjectLockConfigurationCommand

    This operation is not supported for directory buckets.

    Gets the Object Lock configuration for a 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 following action is related to GetObjectLockConfiguration:

    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, GetObjectLockConfigurationCommand } from "ibm-cos-sdk-v2"; // ES Modules import
    // const { S3Client, GetObjectLockConfigurationCommand } = 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 = { // GetObjectLockConfigurationRequest
    Bucket: "STRING_VALUE", // required
    ExpectedBucketOwner: "STRING_VALUE",
    };
    const command = new GetObjectLockConfigurationCommand(input);
    const response = await client.send(command);
    // { // GetObjectLockConfigurationOutput
    // IbmProtectionManagementState: "STRING_VALUE",
    // ObjectLockConfiguration: { // ObjectLockConfiguration
    // ObjectLockEnabled: "Enabled",
    // Rule: { // ObjectLockRule
    // DefaultRetention: { // DefaultRetention
    // Mode: "GOVERNANCE" || "COMPLIANCE",
    // Days: Number("int"),
    // Years: Number("int"),
    // },
    // },
    // },
    // };

    GetObjectLockConfigurationCommandInput

    S3ServiceException

    Base exception class for all service exceptions from S3 service.

    Hierarchy

    Index

    Constructors

    Constructors

    • Returns GetObjectLockConfigurationCommand

    • Parameters

      Returns GetObjectLockConfigurationCommand