paws.storage (version 0.1.9)

s3_get_object_tagging: Returns the tag-set of an object

Description

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

Usage

s3_get_object_tagging(Bucket, Key, VersionId)

Arguments

Bucket

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

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] Object key for which to get the tagging information.

VersionId

The versionId of the object for which to get the tagging information.

Request syntax

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

Details

To use this operation, you must have permission to perform the s3:GetObjectTagging action. By default, the GET operation 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 operation is related to GetObjectTagging:

• PutObjectTagging

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"
)
# }
# NOT RUN {
# }