StartConfigRulesEvaluation
Runs an on-demand evaluation for the specified AWS Config rules
against the last known configuration state of the resources. Use
StartConfigRulesEvaluation
when you want to test
that a rule you updated is working as expected.
StartConfigRulesEvaluation
does not re-record the
latest configuration state for your resources. It re-runs an
evaluation against the last known state of your resources.
You can specify up to 25 AWS Config rules per request.
An existing StartConfigRulesEvaluation
call for
the specified rules must complete before you can call the API again.
If you chose to have AWS Config stream to an Amazon SNS topic, you
will receive a ConfigRuleEvaluationStarted
notification
when the evaluation starts.
Note
You don't need to call the
StartConfigRulesEvaluation
API to run an
evaluation for a new rule. When you create a rule, AWS Config
evaluates your resources against the rule automatically.
The StartConfigRulesEvaluation
API is useful if
you want to run on-demand evaluations, such as the following
example:
-
You have a custom rule that evaluates your IAM resources every 24 hours.
-
You update your Lambda function to add additional conditions to your rule.
-
Instead of waiting for the next periodic evaluation, you call the
StartConfigRulesEvaluation
API. -
AWS Config invokes your Lambda function and evaluates your IAM resources.
-
Your custom rule will still run periodic evaluations every 24 hours.
Request Syntax
{ "ConfigRuleNames": [ "
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.
- ConfigRuleNames
-
The list of names of AWS Config rules that you want to run evaluations for.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 25 items.
Length Constraints: Minimum length of 1. Maximum length of 64.
Required: No
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.
- InvalidParameterValueException
-
One or more of the specified parameters are invalid. Verify that your parameters are valid and try again.
HTTP Status Code: 400
- LimitExceededException
-
For
StartConfigRulesEvaluation
API, this exception is thrown if an evaluation is in progress or if you call the StartConfigRulesEvaluation API more than once per minute.For
PutConfigurationAggregator
API, this exception is thrown if the number of accounts and aggregators exceeds the limit.HTTP Status Code: 400
- NoSuchConfigRuleException
-
One or more AWS Config rules in the request are invalid. Verify that the rule names are correct and try again.
HTTP Status Code: 400
- ResourceInUseException
-
The rule is currently being deleted or the rule is deleting your evaluation results. 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: