Skip to content

Get Bucket Versioning

s3_get_bucket_versioning R Documentation

This operation is not supported by directory buckets

Description

This operation is not supported by directory buckets.

Returns the versioning state of a bucket.

To retrieve the versioning state of a bucket, you must be the bucket owner.

This implementation also returns the MFA Delete status of the versioning state. If the MFA Delete status is enabled, the bucket owner must use an authentication device to change the versioning state of the bucket.

The following operations are related to get_bucket_versioning:

  • get_object

  • put_object

  • delete_object

Usage

s3_get_bucket_versioning(Bucket, ExpectedBucketOwner)

Arguments

Bucket

[required] The name of the bucket for which to get the versioning information.

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(
  Status = "Enabled"|"Suspended",
  MFADelete = "Enabled"|"Disabled"
)

Request syntax

svc$get_bucket_versioning(
  Bucket = "string",
  ExpectedBucketOwner = "string"
)

Examples

## Not run: 
# The following example retrieves bucket versioning configuration.
svc$get_bucket_versioning(
  Bucket = "examplebucket"
)

## End(Not run)