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

    Class GetObjectRetentionCommand

    This operation is not supported for directory buckets.

    Retrieves an object's retention settings. For more information, see Locking Objects.

    This functionality is not supported for Amazon S3 on Outposts.

    The following action is related to GetObjectRetention:

    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, GetObjectRetentionCommand } from "ibm-cos-sdk-v2"; // ES Modules import
    // const { S3Client, GetObjectRetentionCommand } = 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 = { // GetObjectRetentionRequest
    Bucket: "STRING_VALUE", // required
    Key: "STRING_VALUE", // required
    VersionId: "STRING_VALUE",
    RequestPayer: "requester",
    ExpectedBucketOwner: "STRING_VALUE",
    };
    const command = new GetObjectRetentionCommand(input);
    const response = await client.send(command);
    // { // GetObjectRetentionOutput
    // Retention: { // ObjectLockRetention
    // Mode: "GOVERNANCE" || "COMPLIANCE",
    // RetainUntilDate: new Date("TIMESTAMP"),
    // },
    // };

    GetObjectRetentionCommandInput

    S3ServiceException

    Base exception class for all service exceptions from S3 service.

    Hierarchy

    Index

    Constructors

    Constructors

    • Returns GetObjectRetentionCommand

    • Parameters

      Returns GetObjectRetentionCommand