s3_get_object_retention: Retrieves an object's retention settings

In paws.storage: 'Amazon Web Services' Storage Services

Retrieves an object's retention settings

Description

Retrieves an object's retention settings. For more information, see Locking Objects.

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

Usage

s3_get_object_retention(
  Bucket,
  Key,
  VersionId = NULL,
  RequestPayer = NULL,
  ExpectedBucketOwner = NULL
)

Arguments

Bucket	[required] The bucket name containing the object whose retention settings you want to retrieve. 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 whose retention settings you want to retrieve.
VersionId	The version ID for the object whose retention settings you want to retrieve.
RequestPayer
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).

paws.storage documentation built on Sept. 12, 2023, 1:23 a.m.