DeleteTagsCommand

Suggest an Edit

Deletes tags from a resource. You must provide the ARN of the resource from which you want to delete the tag or tags.

Example Syntax

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

import { RedshiftClient, DeleteTagsCommand } from "@aws-sdk/client-redshift"; // ES Modules import
// const { RedshiftClient, DeleteTagsCommand } = require("@aws-sdk/client-redshift"); // CommonJS import
const client = new RedshiftClient(config);
const input = { // DeleteTagsMessage
  ResourceName: "STRING_VALUE", // required
  TagKeys: [ // TagKeyList // required
    "STRING_VALUE",
  ],
};
const command = new DeleteTagsCommand(input);
const response = await client.send(command);
// {};

DeleteTagsCommand Input

See DeleteTagsCommandInput for more details

Parameter
Type
Description
ResourceName
Required
string | undefined

The Amazon Resource Name (ARN) from which you want to remove the tag or tags. For example, arn:aws:redshift:us-east-2:123456789:cluster:t1.

TagKeys
Required
string[] | undefined

The tag key that you want to delete.

DeleteTagsCommand Output

See DeleteTagsCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.

Throws

Name
Fault
Details
InvalidTagFault
client

The tag is invalid.

ResourceNotFoundFault
client

The resource could not be found.

RedshiftServiceException
Base exception class for all service exceptions from Redshift service.