Skip to content

FindingsOutput

Source code in docs_src/capo_securityhub/types/findings_output.py 
13
14
15
16
17
18
19
20
21
22
23
24
25
class FindingsOutput(TypedDict, closed=True):
    format: NotRequired[
        "capo_securityhub.types.findings_export_format.FindingsExportFormat"
    ]
    """<p>The output format of the export. <code>CSV</code> produces comma-separated rows that are suitable for spreadsheets and analysis tools. <code>OCSF_JSON</code> produces newline-delimited JSON records in the Open Cybersecurity Schema Framework (OCSF) format used elsewhere in Security Hub.</p>"""
    filters: NotRequired[
        "capo_securityhub.types.ocsf_finding_filters.OcsfFindingFilters"
    ]
    """<p>An optional set of OCSF finding filters that restrict which findings are exported. The filter structure is the same as the one used by <code>GetFindingsV2</code>. If you omit this member, Security Hub exports all findings available to the caller. When echoed by <code>GetExportJobV2</code>, relative date ranges are returned unresolved.</p>"""
    selected_fields: NotRequired[
        "capo_securityhub.types.findings_selected_field_list.FindingsSelectedFieldList"
    ]
    """<p>The OCSF finding fields to include in the export, specified as OCSF field paths (for example, <code>finding_info.title</code> or <code>severity</code>). You can specify from 1 to 50 fields.</p> <p>Whether this parameter is required depends on the value of <code>Format</code>:</p> <ul> <li> <p> <code>CSV</code> – Required. The field paths that you specify become the columns of the output, in the order that you provide them. If you omit this parameter, the request returns a <code>ValidationException</code>.</p> </li> <li> <p> <code>OCSF_JSON</code> – Not supported. This format includes each finding in full, so field selection doesn't apply. If you specify this parameter, the request returns a <code>ValidationException</code>.</p> </li> </ul>"""

filters instance-attribute 

filters: NotRequired[OcsfFindingFilters]

An optional set of OCSF finding filters that restrict which findings are exported. The filter structure is the same as the one used by GetFindingsV2. If you omit this member, Security Hub exports all findings available to the caller. When echoed by GetExportJobV2, relative date ranges are returned unresolved.

format instance-attribute 

format: NotRequired[FindingsExportFormat]

The output format of the export. CSV produces comma-separated rows that are suitable for spreadsheets and analysis tools. OCSF_JSON produces newline-delimited JSON records in the Open Cybersecurity Schema Framework (OCSF) format used elsewhere in Security Hub.

selected_fields instance-attribute 

selected_fields: NotRequired[FindingsSelectedFieldList]

The OCSF finding fields to include in the export, specified as OCSF field paths (for example, finding_info.title or severity). You can specify from 1 to 50 fields.

Whether this parameter is required depends on the value of Format:

  • CSV – Required. The field paths that you specify become the columns of the output, in the order that you provide them. If you omit this parameter, the request returns a ValidationException.

  • OCSF_JSON – Not supported. This format includes each finding in full, so field selection doesn't apply. If you specify this parameter, the request returns a ValidationException.