DeleteConfigRule
Deletes the specified AWS Config rule and all of its evaluation results.
AWS 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: Consider excluding the AWS::Config::ResourceCompliance
resource type from recording before deleting rules
Deleting 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.
Request Syntax
{
"ConfigRuleName": "string
"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- ConfigRuleName
-
The name of the AWS Config rule that you want to delete.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
.*\S.*
Required: Yes
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
Errors
For information about the errors that are common to all actions, see Common Errors.
- NoSuchConfigRuleException
-
The AWS Config rule in the request is not valid. Verify that the rule is an AWS Config Process Check rule, that the rule name is correct, and that valid Amazon Resouce Names (ARNs) are used before trying again.
HTTP Status Code: 400
- ResourceInUseException
-
You see this exception in the following cases:
-
For DeleteConfigRule, AWS Config is deleting this rule. Try your request again later.
-
For DeleteConfigRule, the rule is deleting your evaluation results. Try your request again later.
-
For DeleteConfigRule, a remediation action is associated with the rule and AWS Config cannot delete this rule. Delete the remediation action associated with the rule before deleting the rule and try your request again later.
-
For PutConfigOrganizationRule, organization AWS Config rule deletion is in progress. Try your request again later.
-
For DeleteOrganizationConfigRule, organization AWS Config rule creation is in progress. Try your request again later.
-
For PutConformancePack and PutOrganizationConformancePack, a conformance pack creation, update, and deletion is in progress. Try your request again later.
-
For DeleteConformancePack, a conformance pack creation, update, and deletion is in progress. Try your request again later.
HTTP Status Code: 400
-
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: