Class GetObjectTaggingCommand

Example

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

import { S3Client, GetObjectTaggingCommand } from "ibm-cos-sdk-v2"; // ES Modules import
// const { S3Client, GetObjectTaggingCommand } = require("ibm-cos-sdk-v2"); // CommonJS import
// import type { S3ClientConfig } from "ibm-cos-sdk-v2";
const config = {}; // type is S3ClientConfig
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
//     },
//   ],
// };

Copy

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 is
{
  TagSet: [
    {
      Key: "Key1",
      Value: "Value1"
    }
  ],
  VersionId: "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI"
}
*/
Copy

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 is
{
  TagSet: [
    {
      Key: "Key4",
      Value: "Value4"
    },
    {
      Key: "Key3",
      Value: "Value3"
    }
  ],
  VersionId: "null"
}
*/
Copy