We are excited to announce our new API Documentation.
Protected
The bucket name containing the object that you want to place a legal hold on.
When using this action with an access point, 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
Optional
ChecksumIndicates the algorithm used to create the checksum for the object when using the SDK. This header will not provide any
additional functionality if not using the SDK. When sending 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.
Optional
ContentMD5The 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.
Optional
ExpectedThe account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden
(access denied).
The key name for the object that you want to place a legal hold on.
Optional
LegalContainer element for the legal hold configuration you want to apply to the specified object.
Optional
RequestConfirms 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 Amazon 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.
Optional
VersionThe version ID of the object that you want to place a legal hold on.
The input for PutObjectLegalHoldCommand.