paws.security.identity (version 0.1.9)

waf_delete_rate_based_rule: This is AWS WAF CLASSIC documentation

Description

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

Usage

waf_delete_rate_based_rule(RuleId, ChangeToken)

Arguments

RuleId

[required] The RuleId of the RateBasedRule that you want to delete. RuleId is returned by CreateRateBasedRule and by ListRateBasedRules.

ChangeToken

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

Request syntax

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

Details

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 RateBasedRule. 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 UpdateWebACL.

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

1. Update the RateBasedRule to remove predicates, if any. For more information, see UpdateRateBasedRule.

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

3. Submit a DeleteRateBasedRule request.