Put Object Retention
| s3_put_object_retention | R Documentation |
This operation is not supported for directory buckets¶
Description¶
This operation is not supported for directory buckets.
Places an Object Retention configuration on an object. For more
information, see Locking
Objects.
Users or accounts require the s3:PutObjectRetention permission in
order to place an Object Retention configuration on objects. Bypassing a
Governance Retention configuration requires the
s3:BypassGovernanceRetention permission.
This functionality is not supported for Amazon S3 on Outposts.
You must URL encode any signed header values that contain spaces. For
example, if your header value is my file.txt, containing two spaces
after my, you must URL encode this value to my%20%20file.txt.
Usage¶
s3_put_object_retention(Bucket, Key, Retention, RequestPayer, VersionId,
BypassGovernanceRetention, ContentMD5, ChecksumAlgorithm,
ExpectedBucketOwner)
Arguments¶
Bucket |
[required] The bucket name that contains the object you want to apply this Object Retention configuration to. Access points - When you use this action with an access point for general purpose buckets, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When you use this action with an access point for directory buckets, you must provide the access point name in place of the bucket name. 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. |
Key |
[required] The key name for the object that you want to apply this Object Retention configuration to. |
Retention |
The container element for the Object Retention configuration. |
RequestPayer |
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 the corresponding charges. 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 |
The version ID for the object that you want to apply this Object Retention configuration to. |
BypassGovernanceRetention |
Indicates whether this action should bypass Governance-mode restrictions. |
ContentMD5 |
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. |
ChecksumAlgorithm |
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 If you provide an individual checksum, Amazon S3 ignores any provided
|
ExpectedBucketOwner |
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 |
Value¶
A list with the following syntax:
list(
RequestCharged = "requester"
)
Request syntax¶
svc$put_object_retention(
Bucket = "string",
Key = "string",
Retention = list(
Mode = "GOVERNANCE"|"COMPLIANCE",
RetainUntilDate = as.POSIXct(
"2015-01-01"
)
),
RequestPayer = "requester",
VersionId = "string",
BypassGovernanceRetention = TRUE|FALSE,
ContentMD5 = "string",
ChecksumAlgorithm = "CRC32"|"CRC32C"|"SHA1"|"SHA256"|"CRC64NVME"|"SHA512"|"MD5"|"XXHASH64"|"XXHASH3"|"XXHASH128",
ExpectedBucketOwner = "string"
)