amazonka-config-2.0: Amazon Config SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.Config.StartConfigRulesEvaluation

Description

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:

  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. Config invokes your Lambda function and evaluates your IAM resources.
  5. Your custom rule will still run periodic evaluations every 24 hours.
Synopsis

Creating a Request

data StartConfigRulesEvaluation Source #

See: newStartConfigRulesEvaluation smart constructor.

Constructors

StartConfigRulesEvaluation' 

Fields

Instances

Instances details
ToJSON StartConfigRulesEvaluation Source # 
Instance details

Defined in Amazonka.Config.StartConfigRulesEvaluation

ToHeaders StartConfigRulesEvaluation Source # 
Instance details

Defined in Amazonka.Config.StartConfigRulesEvaluation

ToPath StartConfigRulesEvaluation Source # 
Instance details

Defined in Amazonka.Config.StartConfigRulesEvaluation

ToQuery StartConfigRulesEvaluation Source # 
Instance details

Defined in Amazonka.Config.StartConfigRulesEvaluation

AWSRequest StartConfigRulesEvaluation Source # 
Instance details

Defined in Amazonka.Config.StartConfigRulesEvaluation

Generic StartConfigRulesEvaluation Source # 
Instance details

Defined in Amazonka.Config.StartConfigRulesEvaluation

Associated Types

type Rep StartConfigRulesEvaluation :: Type -> Type #

Read StartConfigRulesEvaluation Source # 
Instance details

Defined in Amazonka.Config.StartConfigRulesEvaluation

Show StartConfigRulesEvaluation Source # 
Instance details

Defined in Amazonka.Config.StartConfigRulesEvaluation

NFData StartConfigRulesEvaluation Source # 
Instance details

Defined in Amazonka.Config.StartConfigRulesEvaluation

Eq StartConfigRulesEvaluation Source # 
Instance details

Defined in Amazonka.Config.StartConfigRulesEvaluation

Hashable StartConfigRulesEvaluation Source # 
Instance details

Defined in Amazonka.Config.StartConfigRulesEvaluation

type AWSResponse StartConfigRulesEvaluation Source # 
Instance details

Defined in Amazonka.Config.StartConfigRulesEvaluation

type Rep StartConfigRulesEvaluation Source # 
Instance details

Defined in Amazonka.Config.StartConfigRulesEvaluation

type Rep StartConfigRulesEvaluation = D1 ('MetaData "StartConfigRulesEvaluation" "Amazonka.Config.StartConfigRulesEvaluation" "amazonka-config-2.0-7GF0fBbVw65uROwJwpcE3" 'False) (C1 ('MetaCons "StartConfigRulesEvaluation'" 'PrefixI 'True) (S1 ('MetaSel ('Just "configRuleNames") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Text)))))

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:

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.

Constructors

StartConfigRulesEvaluationResponse' 

Fields

Instances

Instances details
Generic StartConfigRulesEvaluationResponse Source # 
Instance details

Defined in Amazonka.Config.StartConfigRulesEvaluation

Associated Types

type Rep StartConfigRulesEvaluationResponse :: Type -> Type #

Read StartConfigRulesEvaluationResponse Source # 
Instance details

Defined in Amazonka.Config.StartConfigRulesEvaluation

Show StartConfigRulesEvaluationResponse Source # 
Instance details

Defined in Amazonka.Config.StartConfigRulesEvaluation

NFData StartConfigRulesEvaluationResponse Source # 
Instance details

Defined in Amazonka.Config.StartConfigRulesEvaluation

Eq StartConfigRulesEvaluationResponse Source # 
Instance details

Defined in Amazonka.Config.StartConfigRulesEvaluation

type Rep StartConfigRulesEvaluationResponse Source # 
Instance details

Defined in Amazonka.Config.StartConfigRulesEvaluation

type Rep StartConfigRulesEvaluationResponse = D1 ('MetaData "StartConfigRulesEvaluationResponse" "Amazonka.Config.StartConfigRulesEvaluation" "amazonka-config-2.0-7GF0fBbVw65uROwJwpcE3" '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