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.

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 RuleGroup. You can't delete a RuleGroup if it's still used in any WebACL objects or if it still includes any rules.

If you just want to remove a RuleGroup from a WebACL, use UpdateWebACL.

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

  1. Update the RuleGroup to remove rules, if any. For more information, see UpdateRuleGroup.

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

  3. Submit a DeleteRuleGroup request.

Note:

For .NET Core this operation is only available in asynchronous form. Please refer to DeleteRuleGroupAsync.

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

Syntax

C#
public virtual DeleteRuleGroupResponse DeleteRuleGroup(
         DeleteRuleGroupRequest request
)

Parameters

request
Type: Amazon.WAFRegional.Model.DeleteRuleGroupRequest

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

Return Value


The response from the DeleteRuleGroup service method, as returned by WAFRegional.

Exceptions

ExceptionCondition
WAFInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request.
WAFInvalidOperationException The operation failed because there was nothing to do. For example: You tried to remove a Rule from a WebACL, but the Rule isn't in the specified WebACL. You tried to remove an IP address from an IPSet, but the IP address isn't in the specified IPSet. You tried to remove a ByteMatchTuple from a ByteMatchSet, but the ByteMatchTuple isn't in the specified WebACL. You tried to add a Rule to a WebACL, but the Rule already exists in the specified WebACL. You tried to add a ByteMatchTuple to a ByteMatchSet, but the ByteMatchTuple already exists in the specified WebACL.
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

Version Information

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

See Also