AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
Runs an on-demand evaluation for the specified 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 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 Config stream to an Amazon
SNS topic, you will receive a ConfigRuleEvaluationStarted notification when
the evaluation starts.
You don't need to call the StartConfigRulesEvaluation API to run an evaluation
for a new rule. When you create a rule, 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.
Config invokes your Lambda function and evaluates your IAM resources.
Your custom rule will still run periodic evaluations every 24 hours.
For .NET Core this operation is only available in asynchronous form. Please refer to StartConfigRulesEvaluationAsync.
Namespace: Amazon.ConfigService
Assembly: AWSSDK.ConfigService.dll
Version: 3.x.y.z
public virtual StartConfigRulesEvaluationResponse StartConfigRulesEvaluation( StartConfigRulesEvaluationRequest request )
Container for the necessary parameters to execute the StartConfigRulesEvaluation service method.
| Exception | Condition |
|---|---|
| InvalidParameterValueException | One or more of the specified parameters are not valid. Verify that your parameters are valid and try again. |
| 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. |
| NoSuchConfigRuleException | The Config rule in the request is not valid. Verify that the rule is an Config Process Check rule, that the rule name is correct, and that valid Amazon Resouce Names (ARNs) are used before trying again. |
| ResourceInUseException | You see this exception in the following cases: For DeleteConfigRule, 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 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 Config rule deletion is in progress. Try your request again later. For DeleteOrganizationConfigRule, organization 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. |
.NET Framework:
Supported in: 4.5, 4.0, 3.5