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

Description

 
Synopsis

Documentation

data EvaluationResult Source #

The details of an Config evaluation. Provides the Amazon Web Services resource that was evaluated, the compliance of the resource, related time stamps, and supplementary information.

See: newEvaluationResult smart constructor.

Constructors

EvaluationResult' 

Fields

  • annotation :: Maybe Text

    Supplementary information about how the evaluation determined the compliance.

  • complianceType :: Maybe ComplianceType

    Indicates whether the Amazon Web Services resource complies with the Config rule that evaluated it.

    For the EvaluationResult data type, Config supports only the COMPLIANT, NON_COMPLIANT, and NOT_APPLICABLE values. Config does not support the INSUFFICIENT_DATA value for the EvaluationResult data type.

  • configRuleInvokedTime :: Maybe POSIX

    The time when the Config rule evaluated the Amazon Web Services resource.

  • evaluationResultIdentifier :: Maybe EvaluationResultIdentifier

    Uniquely identifies the evaluation result.

  • resultRecordedTime :: Maybe POSIX

    The time when Config recorded the evaluation result.

  • resultToken :: Maybe Text

    An encrypted token that associates an evaluation with an Config rule. The token identifies the rule, the Amazon Web Services resource being evaluated, and the event that triggered the evaluation.

Instances

Instances details
FromJSON EvaluationResult Source # 
Instance details

Defined in Amazonka.Config.Types.EvaluationResult

Generic EvaluationResult Source # 
Instance details

Defined in Amazonka.Config.Types.EvaluationResult

Associated Types

type Rep EvaluationResult :: Type -> Type #

Read EvaluationResult Source # 
Instance details

Defined in Amazonka.Config.Types.EvaluationResult

Show EvaluationResult Source # 
Instance details

Defined in Amazonka.Config.Types.EvaluationResult

NFData EvaluationResult Source # 
Instance details

Defined in Amazonka.Config.Types.EvaluationResult

Methods

rnf :: EvaluationResult -> () #

Eq EvaluationResult Source # 
Instance details

Defined in Amazonka.Config.Types.EvaluationResult

Hashable EvaluationResult Source # 
Instance details

Defined in Amazonka.Config.Types.EvaluationResult

type Rep EvaluationResult Source # 
Instance details

Defined in Amazonka.Config.Types.EvaluationResult

type Rep EvaluationResult = D1 ('MetaData "EvaluationResult" "Amazonka.Config.Types.EvaluationResult" "amazonka-config-2.0-7GF0fBbVw65uROwJwpcE3" 'False) (C1 ('MetaCons "EvaluationResult'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "annotation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "complianceType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ComplianceType)) :*: S1 ('MetaSel ('Just "configRuleInvokedTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)))) :*: (S1 ('MetaSel ('Just "evaluationResultIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EvaluationResultIdentifier)) :*: (S1 ('MetaSel ('Just "resultRecordedTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "resultToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newEvaluationResult :: EvaluationResult Source #

Create a value of EvaluationResult 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:annotation:EvaluationResult', evaluationResult_annotation - Supplementary information about how the evaluation determined the compliance.

$sel:complianceType:EvaluationResult', evaluationResult_complianceType - Indicates whether the Amazon Web Services resource complies with the Config rule that evaluated it.

For the EvaluationResult data type, Config supports only the COMPLIANT, NON_COMPLIANT, and NOT_APPLICABLE values. Config does not support the INSUFFICIENT_DATA value for the EvaluationResult data type.

$sel:configRuleInvokedTime:EvaluationResult', evaluationResult_configRuleInvokedTime - The time when the Config rule evaluated the Amazon Web Services resource.

$sel:evaluationResultIdentifier:EvaluationResult', evaluationResult_evaluationResultIdentifier - Uniquely identifies the evaluation result.

$sel:resultRecordedTime:EvaluationResult', evaluationResult_resultRecordedTime - The time when Config recorded the evaluation result.

$sel:resultToken:EvaluationResult', evaluationResult_resultToken - An encrypted token that associates an evaluation with an Config rule. The token identifies the rule, the Amazon Web Services resource being evaluated, and the event that triggered the evaluation.

evaluationResult_annotation :: Lens' EvaluationResult (Maybe Text) Source #

Supplementary information about how the evaluation determined the compliance.

evaluationResult_complianceType :: Lens' EvaluationResult (Maybe ComplianceType) Source #

Indicates whether the Amazon Web Services resource complies with the Config rule that evaluated it.

For the EvaluationResult data type, Config supports only the COMPLIANT, NON_COMPLIANT, and NOT_APPLICABLE values. Config does not support the INSUFFICIENT_DATA value for the EvaluationResult data type.

evaluationResult_configRuleInvokedTime :: Lens' EvaluationResult (Maybe UTCTime) Source #

The time when the Config rule evaluated the Amazon Web Services resource.

evaluationResult_resultRecordedTime :: Lens' EvaluationResult (Maybe UTCTime) Source #

The time when Config recorded the evaluation result.

evaluationResult_resultToken :: Lens' EvaluationResult (Maybe Text) Source #

An encrypted token that associates an evaluation with an Config rule. The token identifies the rule, the Amazon Web Services resource being evaluated, and the event that triggered the evaluation.