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

Description

Used by an Lambda function to deliver evaluation results to Config. This action is required in every Lambda function that is invoked by an Config rule.

Synopsis

Creating a Request

data PutEvaluations Source #

See: newPutEvaluations smart constructor.

Constructors

PutEvaluations' 

Fields

  • evaluations :: Maybe [Evaluation]

    The assessments that the Lambda function performs. Each evaluation identifies an Amazon Web Services resource and indicates whether it complies with the Config rule that invokes the Lambda function.

  • testMode :: Maybe Bool

    Use this parameter to specify a test run for PutEvaluations. You can verify whether your Lambda function will deliver evaluation results to Config. No updates occur to your existing evaluations, and evaluation results are not sent to Config.

    When TestMode is true, PutEvaluations doesn't require a valid value for the ResultToken parameter, but the value cannot be null.

  • resultToken :: Text

    An encrypted token that associates an evaluation with an Config rule. Identifies the rule and the event that triggered the evaluation.

Instances

Instances details
ToJSON PutEvaluations Source # 
Instance details

Defined in Amazonka.Config.PutEvaluations

ToHeaders PutEvaluations Source # 
Instance details

Defined in Amazonka.Config.PutEvaluations

ToPath PutEvaluations Source # 
Instance details

Defined in Amazonka.Config.PutEvaluations

ToQuery PutEvaluations Source # 
Instance details

Defined in Amazonka.Config.PutEvaluations

AWSRequest PutEvaluations Source # 
Instance details

Defined in Amazonka.Config.PutEvaluations

Associated Types

type AWSResponse PutEvaluations #

Generic PutEvaluations Source # 
Instance details

Defined in Amazonka.Config.PutEvaluations

Associated Types

type Rep PutEvaluations :: Type -> Type #

Read PutEvaluations Source # 
Instance details

Defined in Amazonka.Config.PutEvaluations

Show PutEvaluations Source # 
Instance details

Defined in Amazonka.Config.PutEvaluations

NFData PutEvaluations Source # 
Instance details

Defined in Amazonka.Config.PutEvaluations

Methods

rnf :: PutEvaluations -> () #

Eq PutEvaluations Source # 
Instance details

Defined in Amazonka.Config.PutEvaluations

Hashable PutEvaluations Source # 
Instance details

Defined in Amazonka.Config.PutEvaluations

type AWSResponse PutEvaluations Source # 
Instance details

Defined in Amazonka.Config.PutEvaluations

type Rep PutEvaluations Source # 
Instance details

Defined in Amazonka.Config.PutEvaluations

type Rep PutEvaluations = D1 ('MetaData "PutEvaluations" "Amazonka.Config.PutEvaluations" "amazonka-config-2.0-7GF0fBbVw65uROwJwpcE3" 'False) (C1 ('MetaCons "PutEvaluations'" 'PrefixI 'True) (S1 ('MetaSel ('Just "evaluations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Evaluation])) :*: (S1 ('MetaSel ('Just "testMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "resultToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newPutEvaluations Source #

Create a value of PutEvaluations 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:evaluations:PutEvaluations', putEvaluations_evaluations - The assessments that the Lambda function performs. Each evaluation identifies an Amazon Web Services resource and indicates whether it complies with the Config rule that invokes the Lambda function.

$sel:testMode:PutEvaluations', putEvaluations_testMode - Use this parameter to specify a test run for PutEvaluations. You can verify whether your Lambda function will deliver evaluation results to Config. No updates occur to your existing evaluations, and evaluation results are not sent to Config.

When TestMode is true, PutEvaluations doesn't require a valid value for the ResultToken parameter, but the value cannot be null.

PutEvaluations, putEvaluations_resultToken - An encrypted token that associates an evaluation with an Config rule. Identifies the rule and the event that triggered the evaluation.

Request Lenses

putEvaluations_evaluations :: Lens' PutEvaluations (Maybe [Evaluation]) Source #

The assessments that the Lambda function performs. Each evaluation identifies an Amazon Web Services resource and indicates whether it complies with the Config rule that invokes the Lambda function.

putEvaluations_testMode :: Lens' PutEvaluations (Maybe Bool) Source #

Use this parameter to specify a test run for PutEvaluations. You can verify whether your Lambda function will deliver evaluation results to Config. No updates occur to your existing evaluations, and evaluation results are not sent to Config.

When TestMode is true, PutEvaluations doesn't require a valid value for the ResultToken parameter, but the value cannot be null.

putEvaluations_resultToken :: Lens' PutEvaluations Text Source #

An encrypted token that associates an evaluation with an Config rule. Identifies the rule and the event that triggered the evaluation.

Destructuring the Response

data PutEvaluationsResponse Source #

See: newPutEvaluationsResponse smart constructor.

Constructors

PutEvaluationsResponse' 

Fields

Instances

Instances details
Generic PutEvaluationsResponse Source # 
Instance details

Defined in Amazonka.Config.PutEvaluations

Associated Types

type Rep PutEvaluationsResponse :: Type -> Type #

Read PutEvaluationsResponse Source # 
Instance details

Defined in Amazonka.Config.PutEvaluations

Show PutEvaluationsResponse Source # 
Instance details

Defined in Amazonka.Config.PutEvaluations

NFData PutEvaluationsResponse Source # 
Instance details

Defined in Amazonka.Config.PutEvaluations

Methods

rnf :: PutEvaluationsResponse -> () #

Eq PutEvaluationsResponse Source # 
Instance details

Defined in Amazonka.Config.PutEvaluations

type Rep PutEvaluationsResponse Source # 
Instance details

Defined in Amazonka.Config.PutEvaluations

type Rep PutEvaluationsResponse = D1 ('MetaData "PutEvaluationsResponse" "Amazonka.Config.PutEvaluations" "amazonka-config-2.0-7GF0fBbVw65uROwJwpcE3" 'False) (C1 ('MetaCons "PutEvaluationsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "failedEvaluations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Evaluation])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newPutEvaluationsResponse Source #

Create a value of PutEvaluationsResponse 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:failedEvaluations:PutEvaluationsResponse', putEvaluationsResponse_failedEvaluations - Requests that failed because of a client or server error.

$sel:httpStatus:PutEvaluationsResponse', putEvaluationsResponse_httpStatus - The response's http status code.

Response Lenses

putEvaluationsResponse_failedEvaluations :: Lens' PutEvaluationsResponse (Maybe [Evaluation]) Source #

Requests that failed because of a client or server error.