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 aPutConfigRule
orDeleteConfigRule
request for the rule, you will receive aResourceInUseException
.You can check the state of a rule by using the
DescribeConfigRules
request.Note
Recommendation: Consider excluding the
AWS::Config::ResourceCompliance
resource type from recording before deleting rulesDeleting rules creates configuration items (CIs) for
AWS::Config::ResourceCompliance
that can affect your costs for the configuration recorder. 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.To avoid the associated costs, you can opt to disable recording for the
AWS::Config::ResourceCompliance
resource type before deleting rules, and re-enable recording after the rules have been deleted.However, since deleting rules is an asynchronous process, it might take an hour or more to complete. During the time when recording is disabled for
AWS::Config::ResourceCompliance
, rule evaluations will not be recorded in the associated resource’s history.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