ConfigService / Client / delete_config_rule

delete_config_rule#

ConfigService.Client.delete_config_rule(**kwargs)#

Deletes the specified Config rule and all of its evaluation results.

Config sets the state of a rule to DELETING until the deletion is complete. You cannot update a rule while it is in this state. If you make a PutConfigRule or DeleteConfigRule request for the rule, you will receive a ResourceInUseException.

You can check the state of a rule by using the DescribeConfigRules request.

Note

Recommendation: Stop recording resource compliance before deleting rules

It is highly recommended that you stop recording for the AWS::Config::ResourceCompliance resource type before you delete rules in your account. Deleting rules creates CIs for AWS::Config::ResourceCompliance and can affect your Config configuration recorder costs. If you are deleting rules which evaluate a large number of resource types, this can lead to a spike in the number of CIs recorded.

Best practice:

  • Stop recording AWS::Config::ResourceCompliance

  • Delete rule(s)

  • Turn on recording for AWS::Config::ResourceCompliance

See also: AWS API Documentation

Request Syntax

response = client.delete_config_rule(
    ConfigRuleName='string'
)
Parameters:

ConfigRuleName (string) –

[REQUIRED]

The name of the Config rule that you want to delete.

Returns:

None

Exceptions

  • ConfigService.Client.exceptions.NoSuchConfigRuleException

  • ConfigService.Client.exceptions.ResourceInUseException