Delete Rule

wafregional_delete_rule

R Documentation

This is AWS WAF Classic documentation

Description

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Permanently deletes a Rule. You can't delete a Rule if it's still used in any WebACL objects or if it still includes any predicates, such as ByteMatchSet objects.

If you just want to remove a Rule from a WebACL, use update_web_acl.

To permanently delete a Rule from AWS WAF, perform the following steps:

1. Update the Rule to remove predicates, if any. For more information, see update_rule.

2. Use get_change_token to get the change token that you provide in the ChangeToken parameter of a delete_rule request.

3. Submit a delete_rule request.

Usage

wafregional_delete_rule(RuleId, ChangeToken)

Arguments

RuleId

[required] The RuleId of the Rule that you want to delete. RuleId is returned by create_rule and by list_rules.

ChangeToken

[required] The value returned by the most recent call to get_change_token.

Value

A list with the following syntax:

list(
  ChangeToken = "string"
)

Request syntax

svc$delete_rule(
  RuleId = "string",
  ChangeToken = "string"
)

Examples

## Not run: 
# The following example deletes a rule with the ID WAFRule-1-Example.
svc$delete_rule(
  ChangeToken = "abcd12f2-46da-4fdb-b8d5-fbd4c466928f",
  RuleId = "WAFRule-1-Example"
)

## End(Not run)