WAFRegional / Client / delete_rate_based_rule
delete_rate_based_rule#
- WAFRegional.Client.delete_rate_based_rule(**kwargs)#
Note
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 RateBasedRule. You can’t delete a rule if it’s still used in any
WebACL
objects or if it still includes any predicates, such asByteMatchSet
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:Update the
RateBasedRule
to remove predicates, if any. For more information, see UpdateRateBasedRule.Use GetChangeToken to get the change token that you provide in the
ChangeToken
parameter of aDeleteRateBasedRule
request.Submit a
DeleteRateBasedRule
request.
See also: AWS API Documentation
Request Syntax
response = client.delete_rate_based_rule( RuleId='string', ChangeToken='string' )
- Parameters:
RuleId (string) –
[REQUIRED]
The
RuleId
of the RateBasedRule that you want to delete.RuleId
is returned by CreateRateBasedRule and by ListRateBasedRules.ChangeToken (string) –
[REQUIRED]
The value returned by the most recent call to GetChangeToken.
- Return type:
dict
- Returns:
Response Syntax
{ 'ChangeToken': 'string' }
Response Structure
(dict) –
ChangeToken (string) –
The
ChangeToken
that you used to submit theDeleteRateBasedRule
request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.
Exceptions
WAFRegional.Client.exceptions.WAFStaleDataException
WAFRegional.Client.exceptions.WAFInternalErrorException
WAFRegional.Client.exceptions.WAFInvalidAccountException
WAFRegional.Client.exceptions.WAFNonexistentItemException
WAFRegional.Client.exceptions.WAFReferencedItemException
WAFRegional.Client.exceptions.WAFNonEmptyEntityException
WAFRegional.Client.exceptions.WAFTagOperationException
WAFRegional.Client.exceptions.WAFTagOperationInternalErrorException