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

Description

 
Synopsis

Documentation

data Insights Source #

A summary of the latest analytics data for all your active assessments.

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

The Insights data is eventually consistent. This means that, when you read data from Insights, 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 should return 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: newInsights smart constructor.

Constructors

Insights' 

Fields

  • activeAssessmentsCount :: Maybe Int

    The number of active assessments in Audit Manager.

  • 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 on the lastUpdated date. 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 number of evidence without a compliance check ruling. Evidence is inconclusive when the associated control uses Security Hub or Config as a data source but you didn't enable those services. This is also the case when 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 classed as inconclusive in Insights data.

  • lastUpdated :: Maybe POSIX

    The time when the cross-assessment insights were last updated.

  • noncompliantEvidenceCount :: Maybe Int

    The number of compliance check evidence that Audit Manager classified as non-compliant on the lastUpdated date. 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 across all active assessments.

Instances

Instances details
FromJSON Insights Source # 
Instance details

Defined in Amazonka.AuditManager.Types.Insights

Generic Insights Source # 
Instance details

Defined in Amazonka.AuditManager.Types.Insights

Associated Types

type Rep Insights :: Type -> Type #

Methods

from :: Insights -> Rep Insights x #

to :: Rep Insights x -> Insights #

Read Insights Source # 
Instance details

Defined in Amazonka.AuditManager.Types.Insights

Show Insights Source # 
Instance details

Defined in Amazonka.AuditManager.Types.Insights

NFData Insights Source # 
Instance details

Defined in Amazonka.AuditManager.Types.Insights

Methods

rnf :: Insights -> () #

Eq Insights Source # 
Instance details

Defined in Amazonka.AuditManager.Types.Insights

Hashable Insights Source # 
Instance details

Defined in Amazonka.AuditManager.Types.Insights

Methods

hashWithSalt :: Int -> Insights -> Int #

hash :: Insights -> Int #

type Rep Insights Source # 
Instance details

Defined in Amazonka.AuditManager.Types.Insights

type Rep Insights = D1 ('MetaData "Insights" "Amazonka.AuditManager.Types.Insights" "amazonka-auditmanager-2.0-FZ7GH2VR8PBBaoTT7BhtJQ" 'False) (C1 ('MetaCons "Insights'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "activeAssessmentsCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: (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))))))

newInsights :: Insights Source #

Create a value of Insights 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:activeAssessmentsCount:Insights', insights_activeAssessmentsCount - The number of active assessments in Audit Manager.

$sel:assessmentControlsCountByNoncompliantEvidence:Insights', insights_assessmentControlsCountByNoncompliantEvidence - The number of assessment controls that collected non-compliant evidence on the lastUpdated date.

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

$sel:inconclusiveEvidenceCount:Insights', insights_inconclusiveEvidenceCount - The number of evidence without a compliance check ruling. Evidence is inconclusive when the associated control uses Security Hub or Config as a data source but you didn't enable those services. This is also the case when 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 classed as inconclusive in Insights data.

$sel:lastUpdated:Insights', insights_lastUpdated - The time when the cross-assessment insights were last updated.

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

$sel:totalAssessmentControlsCount:Insights', insights_totalAssessmentControlsCount - The total number of controls across all active assessments.

insights_activeAssessmentsCount :: Lens' Insights (Maybe Int) Source #

The number of active assessments in Audit Manager.

insights_assessmentControlsCountByNoncompliantEvidence :: Lens' Insights (Maybe Int) Source #

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

insights_compliantEvidenceCount :: Lens' Insights (Maybe Int) Source #

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

insights_inconclusiveEvidenceCount :: Lens' Insights (Maybe Int) Source #

The number of evidence without a compliance check ruling. Evidence is inconclusive when the associated control uses Security Hub or Config as a data source but you didn't enable those services. This is also the case when 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 classed as inconclusive in Insights data.

insights_lastUpdated :: Lens' Insights (Maybe UTCTime) Source #

The time when the cross-assessment insights were last updated.

insights_noncompliantEvidenceCount :: Lens' Insights (Maybe Int) Source #

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

insights_totalAssessmentControlsCount :: Lens' Insights (Maybe Int) Source #

The total number of controls across all active assessments.