Skip to content

Get Object Tagging

s3_get_object_tagging R Documentation

This operation is not supported by directory buckets

Description

This operation is not supported by directory buckets.

Returns the tag-set of an object. You send the GET request against the tagging subresource associated with the object.

To use this operation, you must have permission to perform the s3:GetObjectTagging action. By default, the GET action returns information about current version of an object. For a versioned bucket, you can have multiple versions of an object in your bucket. To retrieve tags of any other version, use the versionId query parameter. You also need permission for the s3:GetObjectVersionTagging action.

By default, the bucket owner has this permission and can grant this permission to others.

For information about the Amazon S3 object tagging feature, see Object Tagging.

The following actions are related to get_object_tagging:

  • delete_object_tagging

  • get_object_attributes

  • put_object_tagging

Usage

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

Arguments

Bucket

[required] The bucket name containing the object for which to get the tagging information.

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.

S3 on Outposts - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

Key

[required] Object key for which to get the tagging information.

VersionId

The versionId of the object 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).

RequestPayer

Value

A list with the following syntax: 

list(
  VersionId = "string",
  TagSet = list(
    list(
      Key = "string",
      Value = "string"
    )
  )
)

Request syntax

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

Examples

## Not run: 
# The following example retrieves tag set of an object.
svc$get_object_tagging(
  Bucket = "examplebucket",
  Key = "HappyFace.jpg"
)

# The following example retrieves tag set of an object. The request
# specifies object version.
svc$get_object_tagging(
  Bucket = "examplebucket",
  Key = "exampleobject",
  VersionId = "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI"
)

## End(Not run)