Class PutObjectRetentionCommand

Example

Use a bare-bones client and the command you need to make an API call.

import { S3Client, PutObjectRetentionCommand } from "ibm-cos-sdk-v2"; // ES Modules import
// const { S3Client, PutObjectRetentionCommand } = 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 = { // PutObjectRetentionRequest
  RetentionLegalHoldId: "STRING_VALUE",
  Bucket: "STRING_VALUE", // required
  Key: "STRING_VALUE", // required
  Retention: { // ObjectLockRetention
    Mode: "GOVERNANCE" || "COMPLIANCE",
    RetainUntilDate: new Date("TIMESTAMP"),
  },
  RequestPayer: "requester",
  VersionId: "STRING_VALUE",
  BypassGovernanceRetention: true || false,
  ContentMD5: "STRING_VALUE",
  ChecksumAlgorithm: "CRC32" || "CRC32C" || "SHA1" || "SHA256" || "CRC64NVME",
  ExpectedBucketOwner: "STRING_VALUE",
};
const command = new PutObjectRetentionCommand(input);
const response = await client.send(command);
// { // PutObjectRetentionOutput
//   RequestCharged: "requester",
// };

Copy