class Aws::S3::Types::PutObjectRetentionRequest
@note When making an API call, you may pass PutObjectRetentionRequest
data as a hash: { bucket: "BucketName", # required key: "ObjectKey", # required retention: { mode: "GOVERNANCE", # accepts GOVERNANCE, COMPLIANCE retain_until_date: Time.now, }, request_payer: "requester", # accepts requester version_id: "ObjectVersionId", bypass_governance_retention: false, content_md5: "ContentMD5", expected_bucket_owner: "AccountId", }
@!attribute [rw] bucket
The bucket name that contains the object you want to apply this Object Retention configuration to. 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 apply this Object Retention configuration to. @return [String]
@!attribute [rw] retention
The container element for the Object Retention configuration. @return [Types::ObjectLockRetention]
@!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 for the object that you want to apply this Object Retention configuration to. @return [String]
@!attribute [rw] bypass_governance_retention
Indicates whether this action should bypass Governance-mode restrictions. @return [Boolean]
@!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/PutObjectRetentionRequest AWS API Documentation
Constants
- SENSITIVE