Skip to content

MetricsSummary

Source code in docs_src/capo_codeguru_security/types/metrics_summary.py 
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
class MetricsSummary(TypedDict, closed=True):
    date: NotRequired["datetime.datetime"]
    """<p>The date from which the metrics summary information was retrieved.</p>"""
    open_findings: NotRequired[
        "capo_codeguru_security.types.finding_metrics_value_per_severity.FindingMetricsValuePerSeverity"
    ]
    """<p>The number of open findings of each severity.</p>"""
    categories_with_most_findings: NotRequired[
        "capo_codeguru_security.types.categories_with_most_findings.CategoriesWithMostFindings"
    ]
    """<p>A list of <code>CategoryWithFindingNum</code> objects for the top 5 finding categories with the most findings.</p>"""
    scans_with_most_open_findings: NotRequired[
        "capo_codeguru_security.types.scans_with_most_open_findings.ScansWithMostOpenFindings"
    ]
    """<p>A list of <code>ScanNameWithFindingNum</code> objects for the top 3 scans with the most number of open findings.</p>"""
    scans_with_most_open_critical_findings: NotRequired[
        "capo_codeguru_security.types.scans_with_most_open_critical_findings.ScansWithMostOpenCriticalFindings"
    ]
    """<p>A list of <code>ScanNameWithFindingNum</code> objects for the top 3 scans with the most number of open critical findings.</p>"""

categories_with_most_findings instance-attribute 

categories_with_most_findings: NotRequired[CategoriesWithMostFindings]

A list of CategoryWithFindingNum objects for the top 5 finding categories with the most findings.

date instance-attribute 

date: NotRequired[datetime]

The date from which the metrics summary information was retrieved.

open_findings instance-attribute 

open_findings: NotRequired[FindingMetricsValuePerSeverity]

The number of open findings of each severity.

scans_with_most_open_critical_findings instance-attribute 

scans_with_most_open_critical_findings: NotRequired[ScansWithMostOpenCriticalFindings]

A list of ScanNameWithFindingNum objects for the top 3 scans with the most number of open critical findings.

scans_with_most_open_findings instance-attribute 

scans_with_most_open_findings: NotRequired[ScansWithMostOpenFindings]

A list of ScanNameWithFindingNum objects for the top 3 scans with the most number of open findings.