Learn R Programming

paws.storage (version 0.1.12)

s3_put_object_retention: Places an Object Retention configuration on an object

Description

Places an Object Retention configuration on an object.

This action is not supported by Amazon S3 on Outposts.

Related Resources

Usage

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

Value

A list with the following syntax:

list(
  RequestCharged = "requester"
)

Arguments

Bucket

[required] The bucket name that contains the object you want to apply this Object Retention configuration to.

When using this API 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 operation with an access point through the AWS 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 Simple Storage Service Developer 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 operation should bypass Governance-mode restrictions.

ContentMD5

The MD5 hash for the request body.

For requests made using the AWS Command Line Interface (CLI) or AWS SDKs, this field is calculated automatically.

ExpectedBucketOwner

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.

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",
  ExpectedBucketOwner = "string"
)