PutObjectLegalHoldCommand

Suggest an Edit

This operation is not supported for directory buckets.

Applies a legal hold configuration to the specified object. For more information, see Locking Objects .

This functionality is not supported for Amazon S3 on Outposts.

Example Syntax

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

import { S3Client, PutObjectLegalHoldCommand } from "@aws-sdk/client-s3"; // ES Modules import
// const { S3Client, PutObjectLegalHoldCommand } = require("@aws-sdk/client-s3"); // CommonJS import
const client = new S3Client(config);
const input = { // PutObjectLegalHoldRequest
  Bucket: "STRING_VALUE", // required
  Key: "STRING_VALUE", // required
  LegalHold: { // ObjectLockLegalHold
    Status: "ON" || "OFF",
  },
  RequestPayer: "requester",
  VersionId: "STRING_VALUE",
  ContentMD5: "STRING_VALUE",
  ChecksumAlgorithm: "CRC32" || "CRC32C" || "SHA1" || "SHA256" || "CRC64NVME",
  ExpectedBucketOwner: "STRING_VALUE",
};
const command = new PutObjectLegalHoldCommand(input);
const response = await client.send(command);
// { // PutObjectLegalHoldOutput
//   RequestCharged: "requester",
// };

PutObjectLegalHoldCommand Input

See PutObjectLegalHoldCommandInput for more details

Parameter
Type
Description
Bucket
Required
string | undefined

The bucket name containing the object that you want to place a legal hold on.

Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points  in the Amazon S3 User Guide.

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

Key
Required
string | undefined

The key name for the object that you want to place a legal hold on.

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).

LegalHold
ObjectLockLegalHold | undefined

Container element for the legal hold configuration you want to apply to the specified object.

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.

VersionId
string | undefined

The version ID of the object that you want to place a legal hold on.

PutObjectLegalHoldCommand Output

See PutObjectLegalHoldCommandOutput for details

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.