Skip to content

GetFindingsStatisticsRequest

Source code in docs_src/capo_guardduty/types/get_findings_statistics_request.py 
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
class GetFindingsStatisticsRequest(TypedDict, closed=True):
    detector_id: "capo_guardduty.types.detector_id.DetectorId"
    """<p>The ID of the detector whose findings statistics you want to retrieve.</p> <p>To find the <code>detectorId</code> in the current Region, see the Settings page in the GuardDuty console, or run the <a href="https://docs.aws.amazon.com/guardduty/latest/APIReference/API_ListDetectors.html">ListDetectors</a> API.</p>"""
    finding_statistic_types: NotRequired[
        "capo_guardduty.types.finding_statistic_types.FindingStatisticTypes"
    ]
    """<p>The types of finding statistics to retrieve.</p>"""
    finding_criteria: NotRequired[
        "capo_guardduty.types.finding_criteria.FindingCriteria"
    ]
    """<p>Represents the criteria that is used for querying findings.</p>"""
    group_by: NotRequired["capo_guardduty.types.group_by_type.GroupByType"]
    """<p>Displays the findings statistics grouped by one of the listed valid values.</p>"""
    order_by: NotRequired["capo_guardduty.types.order_by.OrderBy"]
    """<p>Displays the sorted findings in the requested order. The default value of <code>orderBy</code> is <code>DESC</code>.</p> <p>You can use this parameter only with the <code>groupBy</code> parameter.</p>"""
    max_results: NotRequired["capo_guardduty.types.max_results100.MaxResults100"]
    """<p>The maximum number of results to be returned in the response. The default value is 25.</p> <p>You can use this parameter only with the <code>groupBy</code> parameter.</p>"""

detector_id instance-attribute 

detector_id: DetectorId

The ID of the detector whose findings statistics you want to retrieve.

To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.

finding_criteria instance-attribute 

finding_criteria: NotRequired[FindingCriteria]

Represents the criteria that is used for querying findings.

finding_statistic_types instance-attribute 

finding_statistic_types: NotRequired[FindingStatisticTypes]

The types of finding statistics to retrieve.

group_by instance-attribute 

group_by: NotRequired[GroupByType]

Displays the findings statistics grouped by one of the listed valid values.

max_results instance-attribute 

max_results: NotRequired[MaxResults100]

The maximum number of results to be returned in the response. The default value is 25.

You can use this parameter only with the groupBy parameter.

order_by instance-attribute 

order_by: NotRequired[OrderBy]

Displays the sorted findings in the requested order. The default value of orderBy is DESC.

You can use this parameter only with the groupBy parameter.