WAFRegional / Client / delete_rule_group

delete_rule_group#

WAFRegional.Client.delete_rule_group(**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 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:

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

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

  • Submit a DeleteRuleGroup request.

See also: AWS API Documentation

Request Syntax

response = client.delete_rule_group(
    RuleGroupId='string',
    ChangeToken='string'
)
Parameters:

  • RuleGroupId (string) –

    [REQUIRED]

    The RuleGroupId of the RuleGroup that you want to delete. RuleGroupId is returned by CreateRuleGroup and by ListRuleGroups.

  • 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 the DeleteRuleGroup 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.WAFNonexistentItemException

  • WAFRegional.Client.exceptions.WAFReferencedItemException

  • WAFRegional.Client.exceptions.WAFNonEmptyEntityException

  • WAFRegional.Client.exceptions.WAFInvalidOperationException

  • WAFRegional.Client.exceptions.WAFTagOperationException

  • WAFRegional.Client.exceptions.WAFTagOperationInternalErrorException