Skip to content

GetFindingsRequest

Source code in docs_src/capo_securityhub/types/get_findings_request.py 
14
15
16
17
18
19
20
21
22
23
24
class GetFindingsRequest(TypedDict, closed=True):
    filters: NotRequired[
        "capo_securityhub.types.aws_security_finding_filters.AwsSecurityFindingFilters"
    ]
    """<p>The finding attributes used to define a condition to filter the returned findings.</p> <p>You can filter by up to 10 finding attributes. For each attribute, you can provide up to 20 filter values.</p> <p>Note that in the available filter fields, <code>WorkflowState</code> is deprecated. To search for a finding based on its workflow status, use <code>WorkflowStatus</code>.</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 that is required for pagination. On your first call to the <code>GetFindings</code> operation, set the value of this parameter to <code>NULL</code>.</p> <p>For subsequent calls to the operation, to continue listing data, set the value of this parameter to the value returned from the previous response.</p>"""
    max_results: NotRequired["capo_securityhub.types.max_results.MaxResults"]
    """<p>The maximum number of findings to return.</p>"""

filters instance-attribute 

filters: NotRequired[AwsSecurityFindingFilters]

The finding attributes used to define a condition to filter the returned findings.

You can filter by up to 10 finding attributes. For each attribute, you can provide up to 20 filter values.

Note that in the available filter fields, WorkflowState is deprecated. To search for a finding based on its workflow status, use WorkflowStatus.

max_results instance-attribute 

max_results: NotRequired[MaxResults]

The maximum number of findings to return.

next_token instance-attribute 

next_token: NotRequired[NextToken]

The token that is required for pagination. On your first call to the GetFindings operation, set the value of this parameter to NULL.

For subsequent calls to the operation, to continue listing data, set the value of this parameter to the value returned from the previous response.

sort_criteria instance-attribute 

sort_criteria: NotRequired[SortCriteria]

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