Learn R Programming
paws.storage (version 0.1.7)

s3_put_object_legal_hold: Applies a Legal Hold configuration to the specified object

Description

Applies a Legal Hold configuration to the specified object.

Usage

s3_put_object_legal_hold(Bucket, Key, LegalHold, RequestPayer,
  VersionId, ContentMD5)

Arguments

Bucket

[required] The bucket name containing the object that you want to place a Legal Hold on.

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 using 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 place a Legal Hold on.

LegalHold

Container element for the Legal Hold configuration you want to apply to the specified object.

RequestPayer
VersionId

The version ID of the object that you want to place a Legal Hold on.

ContentMD5

The MD5 hash for the request body.

Request syntax

svc$put_object_legal_hold(
  Bucket = "string",
  Key = "string",
  LegalHold = list(
    Status = "ON"|"OFF"
  ),
  RequestPayer = "requester",
  VersionId = "string",
  ContentMD5 = "string"
)

Details

Related Resources