AuditManager / Client / get_insights

get_insights¶

AuditManager.Client.get_insights()¶

Gets the latest analytics data for all your current active assessments.

Request Syntax

response = client.get_insights()

Return type:

dict

Returns:

Response Syntax

{
    'insights': {
        'activeAssessmentsCount': 123,
        'noncompliantEvidenceCount': 123,
        'compliantEvidenceCount': 123,
        'inconclusiveEvidenceCount': 123,
        'assessmentControlsCountByNoncompliantEvidence': 123,
        'totalAssessmentControlsCount': 123,
        'lastUpdated': datetime(2015, 1, 1)
    }
}

Response Structure

(dict) –
- insights (dict) –
  
  The analytics data that the GetInsights API returned.
  - activeAssessmentsCount (integer) –
    
    The number of active assessments in Audit Manager.
  - noncompliantEvidenceCount (integer) –
    
    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.
  - compliantEvidenceCount (integer) –
    
    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 (integer) –
    
    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).
    
    Note
    If evidence has a compliance check status of not applicable, it’s classed as inconclusive in Insights data.
  - assessmentControlsCountByNoncompliantEvidence (integer) –
    
    The number of assessment controls that collected non-compliant evidence on the lastUpdated date.
  - totalAssessmentControlsCount (integer) –
    
    The total number of controls across all active assessments.
  - lastUpdated (datetime) –
    
    The time when the cross-assessment insights were last updated.

Exceptions

AuditManager.Client.exceptions.AccessDeniedException
AuditManager.Client.exceptions.InternalServerException