AWS SDK Version 3 for .NET
API Reference

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 a rule that 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 must complete for the specified rules 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.

You don't need to call the StartConfigRulesEvaluation API to run an evaluation for a new rule. When you create a new rule, AWS Config automatically evaluates your resources against the rule.

The StartConfigRulesEvaluation API is useful if you want to run on-demand evaluations, such as the following example:

  1. You have a custom rule that evaluates your IAM resources every 24 hours.

  2. You update your Lambda function to add additional conditions to your rule.

  3. Instead of waiting for the next periodic evaluation, you call the StartConfigRulesEvaluation API.

  4. AWS Config invokes your Lambda function and evaluates your IAM resources.

  5. Your custom rule will still run periodic evaluations every 24 hours.

Note:

For PCL this operation is only available in asynchronous form. Please refer to StartConfigRulesEvaluationAsync.

Namespace: Amazon.ConfigService
Assembly: AWSSDK.ConfigService.dll
Version: 3.x.y.z

Syntax

C#
public abstract StartConfigRulesEvaluationResponse StartConfigRulesEvaluation(
         StartConfigRulesEvaluationRequest request
)
Parameters
request
Type: Amazon.ConfigService.Model.StartConfigRulesEvaluationRequest

Container for the necessary parameters to execute the StartConfigRulesEvaluation service method.

Return Value
The response from the StartConfigRulesEvaluation service method, as returned by ConfigService.

Exceptions

ExceptionCondition
InvalidParameterValueException One or more of the specified parameters are invalid. Verify that your parameters are valid and try again.
LimitExceededException This exception is thrown if an evaluation is in progress or if you call the StartConfigRulesEvaluation API more than once per minute.
NoSuchConfigRuleException One or more AWS Config rules in the request are invalid. Verify that the rule names are correct and try again.
ResourceInUseException The rule is currently being deleted or the rule is deleting your evaluation results. Try your request again later.

Version Information

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms

See Also