amazonka-config-1.6.1: Amazon Config SDK.

Copyright(c) 2013-2018 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 AWS 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 AWS 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 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:

  • screConfigRuleNames - The list of names of AWS Config rules that you want to run evaluations for.

data StartConfigRulesEvaluation Source #

See: startConfigRulesEvaluation smart constructor.

Instances
Eq StartConfigRulesEvaluation Source # 
Instance details

Defined in Network.AWS.Config.StartConfigRulesEvaluation

Data StartConfigRulesEvaluation Source # 
Instance details

Defined in Network.AWS.Config.StartConfigRulesEvaluation

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 # 
Instance details

Defined in Network.AWS.Config.StartConfigRulesEvaluation

Show StartConfigRulesEvaluation Source # 
Instance details

Defined in Network.AWS.Config.StartConfigRulesEvaluation

Generic StartConfigRulesEvaluation Source # 
Instance details

Defined in Network.AWS.Config.StartConfigRulesEvaluation

Associated Types

type Rep StartConfigRulesEvaluation :: Type -> Type #

Hashable StartConfigRulesEvaluation Source # 
Instance details

Defined in Network.AWS.Config.StartConfigRulesEvaluation

ToJSON StartConfigRulesEvaluation Source # 
Instance details

Defined in Network.AWS.Config.StartConfigRulesEvaluation

AWSRequest StartConfigRulesEvaluation Source # 
Instance details

Defined in Network.AWS.Config.StartConfigRulesEvaluation

Associated Types

type Rs StartConfigRulesEvaluation :: Type #

ToHeaders StartConfigRulesEvaluation Source # 
Instance details

Defined in Network.AWS.Config.StartConfigRulesEvaluation

ToPath StartConfigRulesEvaluation Source # 
Instance details

Defined in Network.AWS.Config.StartConfigRulesEvaluation

ToQuery StartConfigRulesEvaluation Source # 
Instance details

Defined in Network.AWS.Config.StartConfigRulesEvaluation

NFData StartConfigRulesEvaluation Source # 
Instance details

Defined in Network.AWS.Config.StartConfigRulesEvaluation

type Rep StartConfigRulesEvaluation Source # 
Instance details

Defined in Network.AWS.Config.StartConfigRulesEvaluation

type Rep StartConfigRulesEvaluation = D1 (MetaData "StartConfigRulesEvaluation" "Network.AWS.Config.StartConfigRulesEvaluation" "amazonka-config-1.6.1-7ZYB8js37ntD2x5LWqLcCi" True) (C1 (MetaCons "StartConfigRulesEvaluation'" PrefixI True) (S1 (MetaSel (Just "_screConfigRuleNames") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe (List1 Text)))))
type Rs StartConfigRulesEvaluation Source # 
Instance details

Defined in Network.AWS.Config.StartConfigRulesEvaluation

Request Lenses

screConfigRuleNames :: Lens' StartConfigRulesEvaluation (Maybe (NonEmpty Text)) Source #

The list of names of AWS 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 AWS Config rule.

See: startConfigRulesEvaluationResponse smart constructor.

Instances
Eq StartConfigRulesEvaluationResponse Source # 
Instance details

Defined in Network.AWS.Config.StartConfigRulesEvaluation

Data StartConfigRulesEvaluationResponse Source # 
Instance details

Defined in Network.AWS.Config.StartConfigRulesEvaluation

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 # 
Instance details

Defined in Network.AWS.Config.StartConfigRulesEvaluation

Show StartConfigRulesEvaluationResponse Source # 
Instance details

Defined in Network.AWS.Config.StartConfigRulesEvaluation

Generic StartConfigRulesEvaluationResponse Source # 
Instance details

Defined in Network.AWS.Config.StartConfigRulesEvaluation

Associated Types

type Rep StartConfigRulesEvaluationResponse :: Type -> Type #

NFData StartConfigRulesEvaluationResponse Source # 
Instance details

Defined in Network.AWS.Config.StartConfigRulesEvaluation

type Rep StartConfigRulesEvaluationResponse Source # 
Instance details

Defined in Network.AWS.Config.StartConfigRulesEvaluation

type Rep StartConfigRulesEvaluationResponse = D1 (MetaData "StartConfigRulesEvaluationResponse" "Network.AWS.Config.StartConfigRulesEvaluation" "amazonka-config-1.6.1-7ZYB8js37ntD2x5LWqLcCi" True) (C1 (MetaCons "StartConfigRulesEvaluationResponse'" PrefixI True) (S1 (MetaSel (Just "_scrersResponseStatus") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Int)))

Response Lenses