UntagResourceCommand

Disassociates tags from an Amazon Web Services resource. Tags are key:value pairs that you can associate with Amazon Web Services resources. For example, the tag key might be "customer" and the tag value might be "companyA." You can specify one or more tags to add to each container. You can add up to 50 tags to each Amazon Web Services resource.

Example Syntax

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

import { WAFV2Client, UntagResourceCommand } from "@aws-sdk/client-wafv2"; // ES Modules import
// const { WAFV2Client, UntagResourceCommand } = require("@aws-sdk/client-wafv2"); // CommonJS import
const client = new WAFV2Client(config);
const input = { // UntagResourceRequest
  ResourceARN: "STRING_VALUE", // required
  TagKeys: [ // TagKeyList // required
    "STRING_VALUE",
  ],
};
const command = new UntagResourceCommand(input);
const response = await client.send(command);
// {};

UntagResourceCommand Input

See UntagResourceCommandInput for more details

Parameter
Type
Description
ResourceARN
Required
string | undefined

The Amazon Resource Name (ARN) of the resource.

TagKeys
Required
string[] | undefined

An array of keys identifying the tags to disassociate from the resource.

UntagResourceCommand Output

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

Throws

Name
Fault
Details
WAFInternalErrorException
server

Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.

WAFInvalidOperationException
client

The operation isn't valid.

WAFInvalidParameterException
client

The operation failed because WAF didn't recognize a parameter in the request. For example:

  • You specified a parameter name or value that isn't valid.

  • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.

  • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction.

  • Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL can't be associated.

WAFNonexistentItemException
client

WAF couldn’t perform the operation because your resource doesn't exist. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate.

WAFTagOperationException
client

An error occurred during the tagging operation. Retry your request.

WAFTagOperationInternalErrorException
server

WAF couldn’t perform your tagging operation because of an internal error. Retry your request.

WAFV2ServiceException
Base exception class for all service exceptions from WAFV2 service.