Amazonka.Config.StartConfigRulesEvaluation

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.

Creating a Request

data StartConfigRulesEvaluation

See: newStartConfigRulesEvaluation smart constructor.

Constructors

StartConfigRulesEvaluation'

Fields

• configRuleNames :: Maybe (NonEmpty Text)

  The list of names of Config rules that you want to run evaluations for.

Instances

ToJSON StartConfigRulesEvaluation

Defined in Amazonka.Config.StartConfigRulesEvaluation

Methods

toJSON :: StartConfigRulesEvaluation -> Value

toEncoding :: StartConfigRulesEvaluation -> Encoding

toJSONList :: [StartConfigRulesEvaluation] -> Value

toEncodingList :: [StartConfigRulesEvaluation] -> Encoding

ToHeaders StartConfigRulesEvaluation

Defined in Amazonka.Config.StartConfigRulesEvaluation

Methods

toHeaders :: StartConfigRulesEvaluation -> [Header]

ToPath StartConfigRulesEvaluation

Defined in Amazonka.Config.StartConfigRulesEvaluation

Methods

toPath :: StartConfigRulesEvaluation -> ByteString

ToQuery StartConfigRulesEvaluation

Defined in Amazonka.Config.StartConfigRulesEvaluation

Methods

toQuery :: StartConfigRulesEvaluation -> QueryString

AWSRequest StartConfigRulesEvaluation

Defined in Amazonka.Config.StartConfigRulesEvaluation

Associated Types

type AWSResponse StartConfigRulesEvaluation

Methods

request :: (Service -> Service) -> StartConfigRulesEvaluation -> Request StartConfigRulesEvaluation

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy StartConfigRulesEvaluation -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse StartConfigRulesEvaluation)))

Generic StartConfigRulesEvaluation

Defined in Amazonka.Config.StartConfigRulesEvaluation

Associated Types

type Rep StartConfigRulesEvaluation :: Type -> Type

Methods

from :: StartConfigRulesEvaluation -> Rep StartConfigRulesEvaluation x

to :: Rep StartConfigRulesEvaluation x -> StartConfigRulesEvaluation

Read StartConfigRulesEvaluation

Defined in Amazonka.Config.StartConfigRulesEvaluation

Methods

readsPrec :: Int -> ReadS StartConfigRulesEvaluation

readList :: ReadS [StartConfigRulesEvaluation]

readPrec :: ReadPrec StartConfigRulesEvaluation

readListPrec :: ReadPrec [StartConfigRulesEvaluation]

Show StartConfigRulesEvaluation

Defined in Amazonka.Config.StartConfigRulesEvaluation

Methods

showsPrec :: Int -> StartConfigRulesEvaluation -> ShowS

show :: StartConfigRulesEvaluation -> String

showList :: [StartConfigRulesEvaluation] -> ShowS

NFData StartConfigRulesEvaluation

Defined in Amazonka.Config.StartConfigRulesEvaluation

Methods

rnf :: StartConfigRulesEvaluation -> ()

Eq StartConfigRulesEvaluation

Defined in Amazonka.Config.StartConfigRulesEvaluation

Methods

(==) :: StartConfigRulesEvaluation -> StartConfigRulesEvaluation -> Bool

(/=) :: StartConfigRulesEvaluation -> StartConfigRulesEvaluation -> Bool

Hashable StartConfigRulesEvaluation

Defined in Amazonka.Config.StartConfigRulesEvaluation

Methods

hashWithSalt :: Int -> StartConfigRulesEvaluation -> Int

hash :: StartConfigRulesEvaluation -> Int

type AWSResponse StartConfigRulesEvaluation

Defined in Amazonka.Config.StartConfigRulesEvaluation

type AWSResponse StartConfigRulesEvaluation = StartConfigRulesEvaluationResponse

type Rep StartConfigRulesEvaluation

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

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))

The list of names of Config rules that you want to run evaluations for.

Destructuring the Response

data StartConfigRulesEvaluationResponse

The output when you start the evaluation for the specified Config rule.

See: newStartConfigRulesEvaluationResponse smart constructor.

Constructors

StartConfigRulesEvaluationResponse'

Fields

• httpStatus :: Int

  The response's http status code.

Instances

Generic StartConfigRulesEvaluationResponse

Defined in Amazonka.Config.StartConfigRulesEvaluation

Associated Types

type Rep StartConfigRulesEvaluationResponse :: Type -> Type

Methods

from :: StartConfigRulesEvaluationResponse -> Rep StartConfigRulesEvaluationResponse x

to :: Rep StartConfigRulesEvaluationResponse x -> StartConfigRulesEvaluationResponse

Read StartConfigRulesEvaluationResponse

Defined in Amazonka.Config.StartConfigRulesEvaluation

Methods

readsPrec :: Int -> ReadS StartConfigRulesEvaluationResponse

readList :: ReadS [StartConfigRulesEvaluationResponse]

readPrec :: ReadPrec StartConfigRulesEvaluationResponse

readListPrec :: ReadPrec [StartConfigRulesEvaluationResponse]

Show StartConfigRulesEvaluationResponse

Defined in Amazonka.Config.StartConfigRulesEvaluation

Methods

showsPrec :: Int -> StartConfigRulesEvaluationResponse -> ShowS

show :: StartConfigRulesEvaluationResponse -> String

showList :: [StartConfigRulesEvaluationResponse] -> ShowS

NFData StartConfigRulesEvaluationResponse

Defined in Amazonka.Config.StartConfigRulesEvaluation

Methods

rnf :: StartConfigRulesEvaluationResponse -> ()

Eq StartConfigRulesEvaluationResponse

Defined in Amazonka.Config.StartConfigRulesEvaluation

Methods

(==) :: StartConfigRulesEvaluationResponse -> StartConfigRulesEvaluationResponse -> Bool

(/=) :: StartConfigRulesEvaluationResponse -> StartConfigRulesEvaluationResponse -> Bool

type Rep StartConfigRulesEvaluationResponse

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

Arguments

:: Int

$sel:httpStatus:StartConfigRulesEvaluationResponse'

-> StartConfigRulesEvaluationResponse

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

The response's http status code.