Class GetObjectTaggingCommandProtected

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 GetObjectTagging:

• DeleteObjectTagging

• GetObjectAttributes

• PutObjectTagging

Example

Use a bare-bones client and the command you need to make an API call.

import { S3Client, GetObjectTaggingCommand } from "@aws-sdk/client-s3"; // ES Modules import
// const { S3Client, GetObjectTaggingCommand } = require("@aws-sdk/client-s3"); // CommonJS import
const client = new S3Client(config);
const input = { // GetObjectTaggingRequest
  Bucket: "STRING_VALUE", // required
  Key: "STRING_VALUE", // required
  VersionId: "STRING_VALUE",
  ExpectedBucketOwner: "STRING_VALUE",
  RequestPayer: "requester",
};
const command = new GetObjectTaggingCommand(input);
const response = await client.send(command);
// { // GetObjectTaggingOutput
//   VersionId: "STRING_VALUE",
//   TagSet: [ // TagSet // required
//     { // Tag
//       Key: "STRING_VALUE", // required
//       Value: "STRING_VALUE", // required
//     },
//   ],
// };

Param

GetObjectTaggingCommandInput

Returns

GetObjectTaggingCommandOutput

See

• GetObjectTaggingCommandInput for command's input shape.
• GetObjectTaggingCommandOutput for command's response shape.
• config for S3Client's config shape.

Throws

S3ServiceException

Base exception class for all service exceptions from S3 service.

Example

To retrieve tag set of an object

// The following example retrieves tag set of an object.
const input = {
  "Bucket": "examplebucket",
  "Key": "HappyFace.jpg"
};
const command = new GetObjectTaggingCommand(input);
const response = await client.send(command);
/* response ==
{
  "TagSet": [
    {
      "Key": "Key4",
      "Value": "Value4"
    },
    {
      "Key": "Key3",
      "Value": "Value3"
    }
  ],
  "VersionId": "null"
}
*/
// example id: to-retrieve-tag-set-of-an-object-1481833847896

Example

To retrieve tag set of a specific object version

// The following example retrieves tag set of an object. The request specifies object version.
const input = {
  "Bucket": "examplebucket",
  "Key": "exampleobject",
  "VersionId": "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI"
};
const command = new GetObjectTaggingCommand(input);
const response = await client.send(command);
/* response ==
{
  "TagSet": [
    {
      "Key": "Key1",
      "Value": "Value1"
    }
  ],
  "VersionId": "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI"
}
*/
// example id: to-retrieve-tag-set-of-a-specific-object-version-1483400283663