Class DeleteObjectTaggingCommandProtected

Removes the entire tag set from the specified object. For more information about managing object tags, see Object Tagging.

To use this operation, you must have permission to perform the s3:DeleteObjectTagging action.

To delete tags of a specific object version, add the versionId query parameter in the request. You will need permission for the s3:DeleteObjectVersionTagging action.

The following operations are related to DeleteBucketMetricsConfiguration:

• PutObjectTagging

• GetObjectTagging

Example

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

import { S3Client, DeleteObjectTaggingCommand } from "@aws-sdk/client-s3"; // ES Modules import
// const { S3Client, DeleteObjectTaggingCommand } = require("@aws-sdk/client-s3"); // CommonJS import
const client = new S3Client(config);
const input = {
  Bucket: "STRING_VALUE", // required
  Key: "STRING_VALUE", // required
  VersionId: "STRING_VALUE",
  ExpectedBucketOwner: "STRING_VALUE",
};
const command = new DeleteObjectTaggingCommand(input);
const response = await client.send(command);

Param

DeleteObjectTaggingCommandInput

Returns

DeleteObjectTaggingCommandOutput

See

• DeleteObjectTaggingCommandInput for command's input shape.
• DeleteObjectTaggingCommandOutput for command's response shape.
• config for S3Client's config shape.

Example

To remove tag set from an object

// The following example removes tag set associated with the specified object. If the bucket is versioning enabled, the operation removes tag set from the latest object version.
const input = {
  "Bucket": "examplebucket",
  "Key": "HappyFace.jpg"
};
const command = new DeleteObjectTaggingCommand(input);
const response = await client.send(command);
/* response ==
{
  "VersionId": "null"
}
*/
// example id: to-remove-tag-set-from-an-object-1483145342862

Example

To remove tag set from an object version

// The following example removes tag set associated with the specified object version. The request specifies both the object key and object version.
const input = {
  "Bucket": "examplebucket",
  "Key": "HappyFace.jpg",
  "VersionId": "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI"
};
const command = new DeleteObjectTaggingCommand(input);
const response = await client.send(command);
/* response ==
{
  "VersionId": "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI"
}
*/
// example id: to-remove-tag-set-from-an-object-version-1483145285913