Get Object Legal Hold

s3_get_object_legal_hold

R Documentation

This operation is not supported by directory buckets¶

Description¶

This operation is not supported by directory buckets.

Gets an object's current legal hold status. For more information, see Locking Objects.

This functionality is not supported for Amazon S3 on Outposts.

The following action is related to get_object_legal_hold:

get_object_attributes

Usage¶

s3_get_object_legal_hold(Bucket, Key, VersionId, RequestPayer,
  ExpectedBucketOwner)

Arguments¶

Bucket

[required] The bucket name containing the object whose legal hold status you want to retrieve.

Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, 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 legal hold status you want to retrieve.

VersionId

The version ID of the object whose legal hold status you want to retrieve.

RequestPayer

ExpectedBucketOwner

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code ⁠403 Forbidden⁠ (access denied).

Value¶

A list with the following syntax:

list(
  LegalHold = list(
    Status = "ON"|"OFF"
  )
)

Request syntax¶

svc$get_object_legal_hold(
  Bucket = "string",
  Key = "string",
  VersionId = "string",
  RequestPayer = "requester",
  ExpectedBucketOwner = "string"
)