amazonka-auditmanager-2.0: Amazon Audit Manager 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.AuditManager.Types.Evidence

Description

 
Synopsis

Documentation

data Evidence Source #

A record that contains the information needed to demonstrate compliance with the requirements specified by a control. Examples of evidence include change activity invoked by a user, or a system configuration snapshot.

See: newEvidence smart constructor.

Constructors

Evidence' 

Fields

  • assessmentReportSelection :: Maybe Text

    Specifies whether the evidence is included in the assessment report.

  • attributes :: Maybe (HashMap Text Text)

    The names and values that are used by the evidence event. This includes an attribute name (such as allowUsersToChangePassword) and value (such as true or false).

  • awsAccountId :: Maybe Text

    The identifier for the Amazon Web Services account.

  • awsOrganization :: Maybe Text

    The Amazon Web Services account that the evidence is collected from, and its organization path.

  • complianceCheck :: Maybe Text

    The evaluation status for automated evidence that falls under the compliance check category.

    • Audit Manager classes evidence as non-compliant if Security Hub reports a Fail result, or if Config reports a Non-compliant result.
    • Audit Manager classes evidence as compliant if Security Hub reports a Pass result, or if Config reports a Compliant result.
    • If a compliance check isn't available or applicable, then no compliance evaluation can be made for that evidence. This is the case if the evidence uses Config or Security Hub as the underlying data source type, but those services aren't enabled. This is also the case if the evidence uses an underlying data source type that doesn't support compliance checks (such as manual evidence, Amazon Web Services API calls, or CloudTrail).
  • dataSource :: Maybe Text

    The data source where the evidence was collected from.

  • eventName :: Maybe Text

    The name of the evidence event.

  • eventSource :: Maybe Text

    The Amazon Web Service that the evidence is collected from.

  • evidenceAwsAccountId :: Maybe Text

    The identifier for the Amazon Web Services account.

  • evidenceByType :: Maybe Text

    The type of automated evidence.

  • evidenceFolderId :: Maybe Text

    The identifier for the folder that the evidence is stored in.

  • iamId :: Maybe Text

    The unique identifier for the IAM user or role that's associated with the evidence.

  • id :: Maybe Text

    The identifier for the evidence.

  • resourcesIncluded :: Maybe [Resource]

    The list of resources that are assessed to generate the evidence.

  • time :: Maybe POSIX

    The timestamp that represents when the evidence was collected.

Instances

Instances details
FromJSON Evidence Source # 
Instance details

Defined in Amazonka.AuditManager.Types.Evidence

Generic Evidence Source # 
Instance details

Defined in Amazonka.AuditManager.Types.Evidence

Associated Types

type Rep Evidence :: Type -> Type #

Methods

from :: Evidence -> Rep Evidence x #

to :: Rep Evidence x -> Evidence #

Read Evidence Source # 
Instance details

Defined in Amazonka.AuditManager.Types.Evidence

Show Evidence Source # 
Instance details

Defined in Amazonka.AuditManager.Types.Evidence

NFData Evidence Source # 
Instance details

Defined in Amazonka.AuditManager.Types.Evidence

Methods

rnf :: Evidence -> () #

Eq Evidence Source # 
Instance details

Defined in Amazonka.AuditManager.Types.Evidence

Hashable Evidence Source # 
Instance details

Defined in Amazonka.AuditManager.Types.Evidence

Methods

hashWithSalt :: Int -> Evidence -> Int #

hash :: Evidence -> Int #

type Rep Evidence Source # 
Instance details

Defined in Amazonka.AuditManager.Types.Evidence

type Rep Evidence = D1 ('MetaData "Evidence" "Amazonka.AuditManager.Types.Evidence" "amazonka-auditmanager-2.0-FZ7GH2VR8PBBaoTT7BhtJQ" 'False) (C1 ('MetaCons "Evidence'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "assessmentReportSelection") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "attributes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: S1 ('MetaSel ('Just "awsAccountId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "awsOrganization") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "complianceCheck") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "dataSource") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "eventName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: (((S1 ('MetaSel ('Just "eventSource") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "evidenceAwsAccountId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "evidenceByType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "evidenceFolderId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "iamId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "resourcesIncluded") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Resource])) :*: S1 ('MetaSel ('Just "time") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)))))))

newEvidence :: Evidence Source #

Create a value of Evidence 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:assessmentReportSelection:Evidence', evidence_assessmentReportSelection - Specifies whether the evidence is included in the assessment report.

$sel:attributes:Evidence', evidence_attributes - The names and values that are used by the evidence event. This includes an attribute name (such as allowUsersToChangePassword) and value (such as true or false).

$sel:awsAccountId:Evidence', evidence_awsAccountId - The identifier for the Amazon Web Services account.

$sel:awsOrganization:Evidence', evidence_awsOrganization - The Amazon Web Services account that the evidence is collected from, and its organization path.

Evidence, evidence_complianceCheck - The evaluation status for automated evidence that falls under the compliance check category.

  • Audit Manager classes evidence as non-compliant if Security Hub reports a Fail result, or if Config reports a Non-compliant result.
  • Audit Manager classes evidence as compliant if Security Hub reports a Pass result, or if Config reports a Compliant result.
  • If a compliance check isn't available or applicable, then no compliance evaluation can be made for that evidence. This is the case if the evidence uses Config or Security Hub as the underlying data source type, but those services aren't enabled. This is also the case if the evidence uses an underlying data source type that doesn't support compliance checks (such as manual evidence, Amazon Web Services API calls, or CloudTrail).

$sel:dataSource:Evidence', evidence_dataSource - The data source where the evidence was collected from.

$sel:eventName:Evidence', evidence_eventName - The name of the evidence event.

$sel:eventSource:Evidence', evidence_eventSource - The Amazon Web Service that the evidence is collected from.

$sel:evidenceAwsAccountId:Evidence', evidence_evidenceAwsAccountId - The identifier for the Amazon Web Services account.

$sel:evidenceByType:Evidence', evidence_evidenceByType - The type of automated evidence.

$sel:evidenceFolderId:Evidence', evidence_evidenceFolderId - The identifier for the folder that the evidence is stored in.

$sel:iamId:Evidence', evidence_iamId - The unique identifier for the IAM user or role that's associated with the evidence.

$sel:id:Evidence', evidence_id - The identifier for the evidence.

$sel:resourcesIncluded:Evidence', evidence_resourcesIncluded - The list of resources that are assessed to generate the evidence.

$sel:time:Evidence', evidence_time - The timestamp that represents when the evidence was collected.

evidence_assessmentReportSelection :: Lens' Evidence (Maybe Text) Source #

Specifies whether the evidence is included in the assessment report.

evidence_attributes :: Lens' Evidence (Maybe (HashMap Text Text)) Source #

The names and values that are used by the evidence event. This includes an attribute name (such as allowUsersToChangePassword) and value (such as true or false).

evidence_awsAccountId :: Lens' Evidence (Maybe Text) Source #

The identifier for the Amazon Web Services account.

evidence_awsOrganization :: Lens' Evidence (Maybe Text) Source #

The Amazon Web Services account that the evidence is collected from, and its organization path.

evidence_complianceCheck :: Lens' Evidence (Maybe Text) Source #

The evaluation status for automated evidence that falls under the compliance check category.

  • Audit Manager classes evidence as non-compliant if Security Hub reports a Fail result, or if Config reports a Non-compliant result.
  • Audit Manager classes evidence as compliant if Security Hub reports a Pass result, or if Config reports a Compliant result.
  • If a compliance check isn't available or applicable, then no compliance evaluation can be made for that evidence. This is the case if the evidence uses Config or Security Hub as the underlying data source type, but those services aren't enabled. This is also the case if the evidence uses an underlying data source type that doesn't support compliance checks (such as manual evidence, Amazon Web Services API calls, or CloudTrail).

evidence_dataSource :: Lens' Evidence (Maybe Text) Source #

The data source where the evidence was collected from.

evidence_eventName :: Lens' Evidence (Maybe Text) Source #

The name of the evidence event.

evidence_eventSource :: Lens' Evidence (Maybe Text) Source #

The Amazon Web Service that the evidence is collected from.

evidence_evidenceAwsAccountId :: Lens' Evidence (Maybe Text) Source #

The identifier for the Amazon Web Services account.

evidence_evidenceByType :: Lens' Evidence (Maybe Text) Source #

The type of automated evidence.

evidence_evidenceFolderId :: Lens' Evidence (Maybe Text) Source #

The identifier for the folder that the evidence is stored in.

evidence_iamId :: Lens' Evidence (Maybe Text) Source #

The unique identifier for the IAM user or role that's associated with the evidence.

evidence_id :: Lens' Evidence (Maybe Text) Source #

The identifier for the evidence.

evidence_resourcesIncluded :: Lens' Evidence (Maybe [Resource]) Source #

The list of resources that are assessed to generate the evidence.

evidence_time :: Lens' Evidence (Maybe UTCTime) Source #

The timestamp that represents when the evidence was collected.