WAFRegional / Client / delete_rule

delete_rule#

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

See also: AWS API Documentation

Request Syntax

response = client.delete_rule(
    RuleId='string',
    ChangeToken='string'
)
Parameters:

  • RuleId (string) –

    [REQUIRED]

    The RuleId of the Rule that you want to delete. RuleId is returned by CreateRule and by ListRules.

  • 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 DeleteRule 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.WAFInvalidAccountException

  • WAFRegional.Client.exceptions.WAFNonexistentItemException

  • WAFRegional.Client.exceptions.WAFReferencedItemException

  • WAFRegional.Client.exceptions.WAFNonEmptyEntityException

  • WAFRegional.Client.exceptions.WAFTagOperationException

  • WAFRegional.Client.exceptions.WAFTagOperationInternalErrorException

Examples

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

response = client.delete_rule(
    ChangeToken='abcd12f2-46da-4fdb-b8d5-fbd4c466928f',
    RuleId='WAFRule-1-Example',
)

print(response)

Expected Output:

{
    'ChangeToken': 'abcd12f2-46da-4fdb-b8d5-fbd4c466928f',
    'ResponseMetadata': {
        '...': '...',
    },
}