Skip to content

Get Bucket Tagging

s3_get_bucket_tagging R Documentation

This operation is not supported by directory buckets

Description

This operation is not supported by directory buckets.

Returns the tag set associated with the bucket.

To use this operation, you must have permission to perform the s3:GetBucketTagging action. By default, the bucket owner has this permission and can grant this permission to others.

get_bucket_tagging has the following special error:

  • Error code: NoSuchTagSet

    • Description: There is no tag set associated with the bucket.

The following operations are related to get_bucket_tagging:

  • put_bucket_tagging

  • delete_bucket_tagging

Usage

s3_get_bucket_tagging(Bucket, ExpectedBucketOwner)

Arguments

Bucket

[required] The name of the bucket for which to get the tagging 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(
  TagSet = list(
    list(
      Key = "string",
      Value = "string"
    )
  )
)

Request syntax

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

Examples

## Not run: 
# The following example returns tag set associated with a bucket
svc$get_bucket_tagging(
  Bucket = "examplebucket"
)

## End(Not run)