class Aws::S3::Types::PutObjectLegalHoldRequest
@note When making an API call, you may pass PutObjectLegalHoldRequest
data as a hash: { bucket: "BucketName", # required key: "ObjectKey", # required legal_hold: { status: "ON", # accepts ON, OFF }, request_payer: "requester", # accepts requester version_id: "ObjectVersionId", content_md5: "ContentMD5", expected_bucket_owner: "AccountId", }
@!attribute [rw] bucket
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][1] in the *Amazon S3 User Guide*. [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html @return [String]
@!attribute [rw] key
The key name for the object that you want to place a Legal Hold on. @return [String]
@!attribute [rw] legal_hold
Container element for the Legal Hold configuration you want to apply to the specified object. @return [Types::ObjectLockLegalHold]
@!attribute [rw] request_payer
Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. For information about downloading objects from requester pays buckets, see [Downloading Objects in Requestor Pays Buckets][1] in the *Amazon S3 User Guide*. [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html @return [String]
@!attribute [rw] version_id
The version ID of the object that you want to place a Legal Hold on. @return [String]
@!attribute [rw] content_md5
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. @return [String]
@!attribute [rw] expected_bucket_owner
The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP `403 (Access Denied)` error. @return [String]
@see docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutObjectLegalHoldRequest AWS API Documentation
Constants
- SENSITIVE