Copyright | (c) 2013-2017 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
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.
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.
- startConfigRulesEvaluation :: StartConfigRulesEvaluation
- data StartConfigRulesEvaluation
- screConfigRuleNames :: Lens' StartConfigRulesEvaluation (Maybe (NonEmpty Text))
- startConfigRulesEvaluationResponse :: Int -> StartConfigRulesEvaluationResponse
- data StartConfigRulesEvaluationResponse
- scrersResponseStatus :: Lens' StartConfigRulesEvaluationResponse Int
Creating a Request
startConfigRulesEvaluation :: StartConfigRulesEvaluation Source #
Creates a value of StartConfigRulesEvaluation
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
screConfigRuleNames
- The list of names of Config rules that you want to run evaluations for.
data StartConfigRulesEvaluation Source #
See: startConfigRulesEvaluation
smart constructor.
Request Lenses
screConfigRuleNames :: Lens' StartConfigRulesEvaluation (Maybe (NonEmpty Text)) Source #
The list of names of Config rules that you want to run evaluations for.
Destructuring the Response
startConfigRulesEvaluationResponse Source #
Creates a value of StartConfigRulesEvaluationResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
scrersResponseStatus
- -- | The response status code.
data StartConfigRulesEvaluationResponse Source #
The output when you start the evaluation for the specified Config rule.
See: startConfigRulesEvaluationResponse
smart constructor.
Response Lenses
scrersResponseStatus :: Lens' StartConfigRulesEvaluationResponse Int Source #
- - | The response status code.