AWS SDK Version 3 for .NET
API Reference

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.

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:

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

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

  3. Submit a DeleteRule request.

Note:

For PCL this operation is only available in asynchronous form. Please refer to DeleteRuleAsync.

Namespace: Amazon.WAF
Assembly: AWSSDK.WAF.dll
Version: 3.x.y.z

Syntax

C#
public virtual DeleteRuleResponse DeleteRule(
         DeleteRuleRequest request
)
Parameters
request
Type: Amazon.WAF.Model.DeleteRuleRequest

Container for the necessary parameters to execute the DeleteRule service method.

Return Value
The response from the DeleteRule service method, as returned by WAF.

Exceptions

ExceptionCondition
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.

Examples

The following example deletes a rule with the ID WAFRule-1-Example.

To delete a rule


var response = client.DeleteRule(new DeleteRuleRequest 
{
    ChangeToken = "abcd12f2-46da-4fdb-b8d5-fbd4c466928f",
    RuleId = "WAFRule-1-Example"
});

string changeToken = response.ChangeToken;

            

Version Information

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms

See Also