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

    Class GetObjectLegalHoldCommand

    This operation is not supported for directory buckets.

    Gets an object's current legal hold status. For more information, see Locking Objects.

    This functionality is not supported for Amazon S3 on Outposts.

    The following action is related to GetObjectLegalHold:

    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, GetObjectLegalHoldCommand } from "ibm-cos-sdk-v2"; // ES Modules import
    // const { S3Client, GetObjectLegalHoldCommand } = 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 = { // GetObjectLegalHoldRequest
    Bucket: "STRING_VALUE", // required
    Key: "STRING_VALUE", // required
    VersionId: "STRING_VALUE",
    RequestPayer: "requester",
    ExpectedBucketOwner: "STRING_VALUE",
    };
    const command = new GetObjectLegalHoldCommand(input);
    const response = await client.send(command);
    // { // GetObjectLegalHoldOutput
    // LegalHold: { // ObjectLockLegalHold
    // Status: "ON" || "OFF",
    // },
    // };

    GetObjectLegalHoldCommandInput

    S3ServiceException

    Base exception class for all service exceptions from S3 service.

    Hierarchy

    Index

    Constructors

    Constructors

    • Returns GetObjectLegalHoldCommand

    • Parameters

      Returns GetObjectLegalHoldCommand