50% off: Unlimited data and AI learning.
State of Data and AI Literacy Report 2025

paws.storage (version 0.1.4)

s3_put_object_retention: Places an Object Retention configuration on an object

Description

Places an Object Retention configuration on an object.

Usage

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

Arguments

Bucket

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

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.j

ContentMD5

The MD5 hash for the request body.

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"
)