amazonka-config-1.5.0: Amazon Config SDK.

Copyright(c) 2013-2017 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.Config.StartConfigRulesEvaluation

Contents

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

Synopsis

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:

data StartConfigRulesEvaluation Source #

See: startConfigRulesEvaluation smart constructor.

Instances

Eq StartConfigRulesEvaluation Source # 
Data StartConfigRulesEvaluation Source # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> StartConfigRulesEvaluation -> c StartConfigRulesEvaluation #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c StartConfigRulesEvaluation #

toConstr :: StartConfigRulesEvaluation -> Constr #

dataTypeOf :: StartConfigRulesEvaluation -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c StartConfigRulesEvaluation) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c StartConfigRulesEvaluation) #

gmapT :: (forall b. Data b => b -> b) -> StartConfigRulesEvaluation -> StartConfigRulesEvaluation #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> StartConfigRulesEvaluation -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> StartConfigRulesEvaluation -> r #

gmapQ :: (forall d. Data d => d -> u) -> StartConfigRulesEvaluation -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> StartConfigRulesEvaluation -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> StartConfigRulesEvaluation -> m StartConfigRulesEvaluation #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> StartConfigRulesEvaluation -> m StartConfigRulesEvaluation #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> StartConfigRulesEvaluation -> m StartConfigRulesEvaluation #

Read StartConfigRulesEvaluation Source # 
Show StartConfigRulesEvaluation Source # 
Generic StartConfigRulesEvaluation Source # 
Hashable StartConfigRulesEvaluation Source # 
ToJSON StartConfigRulesEvaluation Source # 
NFData StartConfigRulesEvaluation Source # 
AWSRequest StartConfigRulesEvaluation Source # 
ToQuery StartConfigRulesEvaluation Source # 
ToPath StartConfigRulesEvaluation Source # 
ToHeaders StartConfigRulesEvaluation Source # 
type Rep StartConfigRulesEvaluation Source # 
type Rep StartConfigRulesEvaluation = D1 (MetaData "StartConfigRulesEvaluation" "Network.AWS.Config.StartConfigRulesEvaluation" "amazonka-config-1.5.0-2Fgj67GIa59CyLznjGxu6Y" True) (C1 (MetaCons "StartConfigRulesEvaluation'" PrefixI True) (S1 (MetaSel (Just Symbol "_screConfigRuleNames") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe (List1 Text)))))
type Rs StartConfigRulesEvaluation Source # 

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:

data StartConfigRulesEvaluationResponse Source #

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

See: startConfigRulesEvaluationResponse smart constructor.

Instances

Eq StartConfigRulesEvaluationResponse Source # 
Data StartConfigRulesEvaluationResponse Source # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> StartConfigRulesEvaluationResponse -> c StartConfigRulesEvaluationResponse #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c StartConfigRulesEvaluationResponse #

toConstr :: StartConfigRulesEvaluationResponse -> Constr #

dataTypeOf :: StartConfigRulesEvaluationResponse -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c StartConfigRulesEvaluationResponse) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c StartConfigRulesEvaluationResponse) #

gmapT :: (forall b. Data b => b -> b) -> StartConfigRulesEvaluationResponse -> StartConfigRulesEvaluationResponse #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> StartConfigRulesEvaluationResponse -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> StartConfigRulesEvaluationResponse -> r #

gmapQ :: (forall d. Data d => d -> u) -> StartConfigRulesEvaluationResponse -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> StartConfigRulesEvaluationResponse -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> StartConfigRulesEvaluationResponse -> m StartConfigRulesEvaluationResponse #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> StartConfigRulesEvaluationResponse -> m StartConfigRulesEvaluationResponse #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> StartConfigRulesEvaluationResponse -> m StartConfigRulesEvaluationResponse #

Read StartConfigRulesEvaluationResponse Source # 
Show StartConfigRulesEvaluationResponse Source # 
Generic StartConfigRulesEvaluationResponse Source # 
NFData StartConfigRulesEvaluationResponse Source # 
type Rep StartConfigRulesEvaluationResponse Source # 
type Rep StartConfigRulesEvaluationResponse = D1 (MetaData "StartConfigRulesEvaluationResponse" "Network.AWS.Config.StartConfigRulesEvaluation" "amazonka-config-1.5.0-2Fgj67GIa59CyLznjGxu6Y" True) (C1 (MetaCons "StartConfigRulesEvaluationResponse'" PrefixI True) (S1 (MetaSel (Just Symbol "_scrersResponseStatus") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Int)))

Response Lenses