IBM COS SDK for JavaScript V2 - v1.0.0
    Preparing search index...

    Class DeleteObjectTaggingCommand

    This operation is not supported for directory buckets.

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

    You must URL encode any signed header values that contain spaces. For example, if your header value is my file.txt, containing two spaces after my, you must URL encode this value to my%20%20file.txt.

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

    import { S3Client, DeleteObjectTaggingCommand } from "ibm-cos-sdk-v2"; // ES Modules import
    // const { S3Client, DeleteObjectTaggingCommand } = 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 = { // DeleteObjectTaggingRequest
    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);
    // { // DeleteObjectTaggingOutput
    // VersionId: "STRING_VALUE",
    // };

    DeleteObjectTaggingCommandInput

    S3ServiceException

    Base exception class for all service exceptions from S3 service.

    // 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 is
    {
    VersionId: "null"
    }
    */
    // 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 is
    {
    VersionId: "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI"
    }
    */

    Hierarchy

    Index

    Constructors

    Constructors

    • Returns DeleteObjectTaggingCommand

    • Parameters

      Returns DeleteObjectTaggingCommand