Copyright | (c) 2013-2021 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 |
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.
Synopsis
- data StartConfigRulesEvaluation = StartConfigRulesEvaluation' {
- configRuleNames :: Maybe (NonEmpty Text)
- newStartConfigRulesEvaluation :: StartConfigRulesEvaluation
- startConfigRulesEvaluation_configRuleNames :: Lens' StartConfigRulesEvaluation (Maybe (NonEmpty Text))
- data StartConfigRulesEvaluationResponse = StartConfigRulesEvaluationResponse' {
- httpStatus :: Int
- newStartConfigRulesEvaluationResponse :: Int -> StartConfigRulesEvaluationResponse
- startConfigRulesEvaluationResponse_httpStatus :: Lens' StartConfigRulesEvaluationResponse Int
Creating a Request
data StartConfigRulesEvaluation Source #
See: newStartConfigRulesEvaluation
smart constructor.
StartConfigRulesEvaluation' | |
|
Instances
newStartConfigRulesEvaluation :: StartConfigRulesEvaluation Source #
Create a value of StartConfigRulesEvaluation
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:configRuleNames:StartConfigRulesEvaluation'
, startConfigRulesEvaluation_configRuleNames
- The list of names of Config rules that you want to run evaluations for.
Request Lenses
startConfigRulesEvaluation_configRuleNames :: Lens' StartConfigRulesEvaluation (Maybe (NonEmpty Text)) Source #
The list of names of Config rules that you want to run evaluations for.
Destructuring the Response
data StartConfigRulesEvaluationResponse Source #
The output when you start the evaluation for the specified Config rule.
See: newStartConfigRulesEvaluationResponse
smart constructor.
StartConfigRulesEvaluationResponse' | |
|
Instances
Eq StartConfigRulesEvaluationResponse Source # | |
Read StartConfigRulesEvaluationResponse Source # | |
Show StartConfigRulesEvaluationResponse Source # | |
Generic StartConfigRulesEvaluationResponse Source # | |
NFData StartConfigRulesEvaluationResponse Source # | |
Defined in Amazonka.Config.StartConfigRulesEvaluation rnf :: StartConfigRulesEvaluationResponse -> () # | |
type Rep StartConfigRulesEvaluationResponse Source # | |
Defined in Amazonka.Config.StartConfigRulesEvaluation type Rep StartConfigRulesEvaluationResponse = D1 ('MetaData "StartConfigRulesEvaluationResponse" "Amazonka.Config.StartConfigRulesEvaluation" "libZSservicesZSamazonka-configZSamazonka-config" 'False) (C1 ('MetaCons "StartConfigRulesEvaluationResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) |
newStartConfigRulesEvaluationResponse Source #
Create a value of StartConfigRulesEvaluationResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:StartConfigRulesEvaluationResponse'
, startConfigRulesEvaluationResponse_httpStatus
- The response's http status code.
Response Lenses
startConfigRulesEvaluationResponse_httpStatus :: Lens' StartConfigRulesEvaluationResponse Int Source #
The response's http status code.