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.
This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginDeleteRule and EndDeleteRule.
Namespace: Amazon.WAFRegional
Assembly: AWSSDK.WAFRegional.dll
Version: 3.x.y.z
public abstract Task<DeleteRuleResponse> DeleteRuleAsync( String ruleId, String changeToken, CancellationToken cancellationToken )
The RuleId of the Rule that you want to delete. RuleId is returned by CreateRule and by ListRules.
The value returned by the most recent call to GetChangeToken.
A cancellation token that can be used by other objects or threads to receive notice of cancellation.
| 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 |
.NET Core App:
Supported in: 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5