AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
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 UpdateWebACL.
To permanently delete a Rule
from AWS WAF, perform the following steps:
Update the Rule
to remove predicates, if any. For more information, see UpdateRule.
Use GetChangeToken to get the change token that you provide in the ChangeToken
parameter of a DeleteRule
request.
Submit a DeleteRule
request.
For .NET Core this operation is only available in asynchronous form. Please refer to DeleteRuleAsync.
Namespace: Amazon.WAF
Assembly: AWSSDK.WAF.dll
Version: 3.x.y.z
public abstract DeleteRuleResponse DeleteRule( DeleteRuleRequest request )
Container for the necessary parameters to execute the DeleteRule service method.
Exception | Condition |
---|---|
WAFInternalErrorException | The operation failed because of a system problem, even though the request was valid. Retry your request. |
WAFInvalidAccountException | The operation failed because you tried to create, update, or delete an object by using an invalid account identifier. |
WAFNonEmptyEntityException | The operation failed because you tried to delete an object that isn't empty. For example: You tried to delete a WebACL that still contains one or more Rule objects. You tried to delete a Rule that still contains one or more ByteMatchSet objects or other predicates. You tried to delete a ByteMatchSet that contains one or more ByteMatchTuple objects. You tried to delete an IPSet that references one or more IP addresses. |
WAFNonexistentItemException | The operation failed because the referenced object doesn't exist. |
WAFReferencedItemException | The operation failed because you tried to delete an object that is still in use. For example: You tried to delete a ByteMatchSet that is still referenced by a Rule. You tried to delete a Rule that is still referenced by a WebACL. |
WAFStaleDataException | The operation failed because you tried to create, update, or delete an object by using a change token that has already been used. |
WAFTagOperationException | |
WAFTagOperationInternalErrorException |
The following example deletes a rule with the ID WAFRule-1-Example.
var client = new AmazonWAFClient(); var response = client.DeleteRule(new DeleteRuleRequest { ChangeToken = "abcd12f2-46da-4fdb-b8d5-fbd4c466928f", RuleId = "WAFRule-1-Example" }); string changeToken = response.ChangeToken;
.NET Framework:
Supported in: 4.5, 4.0, 3.5