s3_put_object_retention: Places an Object Retention configuration on an object
In paws.storage: 'Amazon Web Services' Storage Services

s3_put_object_retention

R Documentation

Places an Object Retention configuration on an object

Description

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.

See https://www.paws-r-sdk.com/docs/s3_put_object_retention/ for full documentation.

Usage

s3_put_object_retention(
  Bucket,
  Key,
  Retention = NULL,
  RequestPayer = NULL,
  VersionId = NULL,
  BypassGovernanceRetention = NULL,
  ContentMD5 = NULL,
  ChecksumAlgorithm = NULL,
  ExpectedBucketOwner = NULL
)

Arguments

`Bucket`	[required] 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 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`
`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 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.
`ExpectedBucketOwner`	The 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).