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

Description

 
Synopsis

Documentation

data InsightsByAssessment Source #

A summary of the latest analytics data for a specific active assessment.

This summary is a snapshot of the data that was collected on the lastUpdated date. It’s important to understand that the totals in InsightsByAssessment are daily counts based on this date — they aren’t a total sum to date.

The InsightsByAssessment data is eventually consistent. This means that when you read data from InsightsByAssessment, the response might not instantly reflect the results of a recently completed write or update operation. If you repeat your read request after a few hours, the response returns the latest data.

If you delete an assessment or change its status to inactive, InsightsByAssessment includes data for that assessment as follows.

  • Inactive assessments - If Audit Manager collected evidence for your assessment before you changed it inactive, that evidence is included in the InsightsByAssessment counts for that day.
  • Deleted assessments - If Audit Manager collected evidence for your assessment before you deleted it, that evidence isn't included in the InsightsByAssessment counts for that day.

See: newInsightsByAssessment smart constructor.

Constructors

InsightsByAssessment' 

Fields

  • assessmentControlsCountByNoncompliantEvidence :: Maybe Int

    The number of assessment controls that collected non-compliant evidence on the lastUpdated date.

  • compliantEvidenceCount :: Maybe Int

    The number of compliance check evidence that Audit Manager classified as compliant. This includes evidence that was collected from Security Hub with a Pass ruling, or collected from Config with a Compliant ruling.

  • inconclusiveEvidenceCount :: Maybe Int

    The amount of evidence without a compliance check ruling. Evidence is inconclusive if the associated control uses Security Hub or Config as a data source and you didn't enable those services. This is also the case if a control uses a data source that doesn’t support compliance checks (for example, manual evidence, API calls, or CloudTrail).

    If evidence has a compliance check status of not applicable, it's classified as inconclusive in InsightsByAssessment data.

  • lastUpdated :: Maybe POSIX

    The time when the assessment insights were last updated.

  • noncompliantEvidenceCount :: Maybe Int

    The number of compliance check evidence that Audit Manager classified as non-compliant. This includes evidence that was collected from Security Hub with a Fail ruling, or collected from Config with a Non-compliant ruling.

  • totalAssessmentControlsCount :: Maybe Int

    The total number of controls in the assessment.

Instances

Instances details
FromJSON InsightsByAssessment Source # 
Instance details

Defined in Amazonka.AuditManager.Types.InsightsByAssessment

Generic InsightsByAssessment Source # 
Instance details

Defined in Amazonka.AuditManager.Types.InsightsByAssessment

Associated Types

type Rep InsightsByAssessment :: Type -> Type #

Read InsightsByAssessment Source # 
Instance details

Defined in Amazonka.AuditManager.Types.InsightsByAssessment

Show InsightsByAssessment Source # 
Instance details

Defined in Amazonka.AuditManager.Types.InsightsByAssessment

NFData InsightsByAssessment Source # 
Instance details

Defined in Amazonka.AuditManager.Types.InsightsByAssessment

Methods

rnf :: InsightsByAssessment -> () #

Eq InsightsByAssessment Source # 
Instance details

Defined in Amazonka.AuditManager.Types.InsightsByAssessment

Hashable InsightsByAssessment Source # 
Instance details

Defined in Amazonka.AuditManager.Types.InsightsByAssessment

type Rep InsightsByAssessment Source # 
Instance details

Defined in Amazonka.AuditManager.Types.InsightsByAssessment

type Rep InsightsByAssessment = D1 ('MetaData "InsightsByAssessment" "Amazonka.AuditManager.Types.InsightsByAssessment" "amazonka-auditmanager-2.0-FZ7GH2VR8PBBaoTT7BhtJQ" 'False) (C1 ('MetaCons "InsightsByAssessment'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "assessmentControlsCountByNoncompliantEvidence") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: (S1 ('MetaSel ('Just "compliantEvidenceCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "inconclusiveEvidenceCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))) :*: (S1 ('MetaSel ('Just "lastUpdated") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: (S1 ('MetaSel ('Just "noncompliantEvidenceCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "totalAssessmentControlsCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))))))

newInsightsByAssessment :: InsightsByAssessment Source #

Create a value of InsightsByAssessment 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:assessmentControlsCountByNoncompliantEvidence:InsightsByAssessment', insightsByAssessment_assessmentControlsCountByNoncompliantEvidence - The number of assessment controls that collected non-compliant evidence on the lastUpdated date.

$sel:compliantEvidenceCount:InsightsByAssessment', insightsByAssessment_compliantEvidenceCount - The number of compliance check evidence that Audit Manager classified as compliant. This includes evidence that was collected from Security Hub with a Pass ruling, or collected from Config with a Compliant ruling.

$sel:inconclusiveEvidenceCount:InsightsByAssessment', insightsByAssessment_inconclusiveEvidenceCount - The amount of evidence without a compliance check ruling. Evidence is inconclusive if the associated control uses Security Hub or Config as a data source and you didn't enable those services. This is also the case if a control uses a data source that doesn’t support compliance checks (for example, manual evidence, API calls, or CloudTrail).

If evidence has a compliance check status of not applicable, it's classified as inconclusive in InsightsByAssessment data.

$sel:lastUpdated:InsightsByAssessment', insightsByAssessment_lastUpdated - The time when the assessment insights were last updated.

$sel:noncompliantEvidenceCount:InsightsByAssessment', insightsByAssessment_noncompliantEvidenceCount - The number of compliance check evidence that Audit Manager classified as non-compliant. This includes evidence that was collected from Security Hub with a Fail ruling, or collected from Config with a Non-compliant ruling.

$sel:totalAssessmentControlsCount:InsightsByAssessment', insightsByAssessment_totalAssessmentControlsCount - The total number of controls in the assessment.

insightsByAssessment_assessmentControlsCountByNoncompliantEvidence :: Lens' InsightsByAssessment (Maybe Int) Source #

The number of assessment controls that collected non-compliant evidence on the lastUpdated date.

insightsByAssessment_compliantEvidenceCount :: Lens' InsightsByAssessment (Maybe Int) Source #

The number of compliance check evidence that Audit Manager classified as compliant. This includes evidence that was collected from Security Hub with a Pass ruling, or collected from Config with a Compliant ruling.

insightsByAssessment_inconclusiveEvidenceCount :: Lens' InsightsByAssessment (Maybe Int) Source #

The amount of evidence without a compliance check ruling. Evidence is inconclusive if the associated control uses Security Hub or Config as a data source and you didn't enable those services. This is also the case if a control uses a data source that doesn’t support compliance checks (for example, manual evidence, API calls, or CloudTrail).

If evidence has a compliance check status of not applicable, it's classified as inconclusive in InsightsByAssessment data.

insightsByAssessment_lastUpdated :: Lens' InsightsByAssessment (Maybe UTCTime) Source #

The time when the assessment insights were last updated.

insightsByAssessment_noncompliantEvidenceCount :: Lens' InsightsByAssessment (Maybe Int) Source #

The number of compliance check evidence that Audit Manager classified as non-compliant. This includes evidence that was collected from Security Hub with a Fail ruling, or collected from Config with a Non-compliant ruling.