Skip to content

GetFindingsV2Request

Source code in docs_src/capo_securityhub/types/get_findings_v2_request.py 
15
16
17
18
19
20
21
22
23
24
25
26
27
class GetFindingsV2Request(TypedDict, closed=True):
    filters: NotRequired[
        "capo_securityhub.types.ocsf_finding_filters.OcsfFindingFilters"
    ]
    """<p>The finding attributes used to define a condition to filter the returned OCSF findings. You can filter up to 10 composite filters. For each filter type inside of a composite filter, you can provide up to 20 filters.</p>"""
    scopes: NotRequired["capo_securityhub.types.finding_scopes.FindingScopes"]
    """<p>Limits the results to findings from specific organizational units or from the delegated administrator's organization. Only the delegated administrator account can use this parameter. Other accounts receive an <code>AccessDeniedException</code>.</p> <p>This parameter is optional. If you omit it, the delegated administrator sees findings from all accounts across the entire organization. Other accounts see only their own findings.</p> <p>You can specify up to 10 entries in <code>Scopes.AwsOrganizations</code>. If multiple entries are specified, the entries are combined using OR logic.</p>"""
    sort_criteria: NotRequired["capo_securityhub.types.sort_criteria.SortCriteria"]
    """<p>The finding attributes used to sort the list of returned findings.</p>"""
    next_token: NotRequired["capo_securityhub.types.next_token.NextToken"]
    """<p> The token required for pagination. On your first call, set the value of this parameter to <code>NULL</code>. For subsequent calls, to continue listing data, set the value of this parameter to the value returned in the previous response.</p>"""
    max_results: NotRequired["capo_securityhub.types.max_results.MaxResults"]
    """<p>The maximum number of results to return.</p>"""

filters instance-attribute 

filters: NotRequired[OcsfFindingFilters]

The finding attributes used to define a condition to filter the returned OCSF findings. You can filter up to 10 composite filters. For each filter type inside of a composite filter, you can provide up to 20 filters.

max_results instance-attribute 

max_results: NotRequired[MaxResults]

The maximum number of results to return.

next_token instance-attribute 

next_token: NotRequired[NextToken]

The token required for pagination. On your first call, set the value of this parameter to NULL. For subsequent calls, to continue listing data, set the value of this parameter to the value returned in the previous response.

scopes instance-attribute 

scopes: NotRequired[FindingScopes]

Limits the results to findings from specific organizational units or from the delegated administrator's organization. Only the delegated administrator account can use this parameter. Other accounts receive an AccessDeniedException.

This parameter is optional. If you omit it, the delegated administrator sees findings from all accounts across the entire organization. Other accounts see only their own findings.

You can specify up to 10 entries in Scopes.AwsOrganizations. If multiple entries are specified, the entries are combined using OR logic.

sort_criteria instance-attribute 

sort_criteria: NotRequired[SortCriteria]

The finding attributes used to sort the list of returned findings.