Skip to content

GuardDuty  >  Operations  >  get_findings_statistics

get_findings_statistics

Operation

get_findings_statistics async 

get_findings_statistics(input: GetFindingsStatisticsInput, plugins: list[Plugin] | None = None) -> GetFindingsStatisticsOutput

Lists GuardDuty findings statistics for the specified detector ID.

You must provide either findingStatisticTypes or groupBy parameter, and not both. You can use the maxResults and orderBy parameters only when using groupBy.

There might be regional differences because some flags might not be available in all the Regions where GuardDuty is currently supported. For more information, see Regions and endpoints.

Parameters:

Name Type Description Default
input GetFindingsStatisticsInput

An instance of GetFindingsStatisticsInput.

 required
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

 None

Returns:

Type Description
GetFindingsStatisticsOutput

An instance of GetFindingsStatisticsOutput.

Input

GetFindingsStatisticsInput dataclass

Dataclass for GetFindingsStatisticsInput structure.

Attributes

detector_id class-attribute instance-attribute 
detector_id: str | None = None

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 class-attribute instance-attribute 
finding_criteria: FindingCriteria | None = None

Represents the criteria that is used for querying findings.

finding_statistic_types class-attribute instance-attribute 
finding_statistic_types: list[FindingStatisticType] | None = None

The types of finding statistics to retrieve.

group_by class-attribute instance-attribute 
group_by: GroupByType | None = None

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

max_results class-attribute instance-attribute 
max_results: int | None = None

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 class-attribute instance-attribute 
order_by: OrderBy | None = None

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.

Output

GetFindingsStatisticsOutput dataclass

Dataclass for GetFindingsStatisticsOutput structure.

Attributes

finding_statistics class-attribute instance-attribute 
finding_statistics: FindingStatistics | None = None

The finding statistics object.

next_token class-attribute instance-attribute 
next_token: str | None = None

The pagination parameter to be used on the next list operation to retrieve more items.

This parameter is currently not supported.