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 .

Example Syntax

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

import { S3Client, PutObjectLockConfigurationCommand } from "@aws-sdk/client-s3"; // ES Modules import
// const { S3Client, PutObjectLockConfigurationCommand } = require("@aws-sdk/client-s3"); // CommonJS import
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",
// };

PutObjectLockConfigurationCommand Input

Parameter
Type
Description
Bucket
Required
string | undefined

The bucket whose Object Lock configuration you want to create or replace.

Note: To supply the Multi-region Access Point (MRAP) to Bucket, you need to install the "aws-sdk/signature-v4-crt" package to your project dependencies. For more information, please go to https://github.com/aws/aws-sdk-js-v3#known-issues

ChecksumAlgorithm
ChecksumAlgorithm | undefined

Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity  in the Amazon S3 User Guide.

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

ContentMD5
string | undefined

The MD5 hash for the request body.

For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

ExpectedBucketOwner
string | undefined

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

ObjectLockConfiguration
ObjectLockConfiguration | undefined

The Object Lock configuration that you want to apply to the specified bucket.

RequestPayer
RequestPayer | undefined

Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. If either the source or destination S3 bucket has Requester Pays enabled, the requester will pay for corresponding charges to copy the object. For information about downloading objects from Requester Pays buckets, see Downloading Objects in Requester Pays Buckets  in the Amazon S3 User Guide.

This functionality is not supported for directory buckets.

Token
string | undefined

A token to allow Object Lock to be enabled for an existing bucket.

PutObjectLockConfigurationCommand Output

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
RequestCharged
RequestCharged | undefined

If present, indicates that the requester was successfully charged for the request.

This functionality is not supported for directory buckets.

Throws

Name
Fault
Details
S3ServiceException
Base exception class for all service exceptions from S3 service.