Skip to content

get_findings_statistics

Operation

get_findings_statistics

get_findings_statistics(request: GetFindingsStatisticsInput | GetFindingsStatisticsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetFindingsStatisticsInputDict]) -> 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
request GetFindingsStatisticsInput | GetFindingsStatisticsInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[GetFindingsStatisticsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetFindingsStatisticsOutput

An instance of GetFindingsStatisticsOutput.

get_findings_statistics async

get_findings_statistics(request: GetFindingsStatisticsInput | GetFindingsStatisticsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetFindingsStatisticsInputDict]) -> 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
request GetFindingsStatisticsInput | GetFindingsStatisticsInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[GetFindingsStatisticsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetFindingsStatisticsOutput

An instance of GetFindingsStatisticsOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

GetFindingsStatisticsInputDict

Bases: TypedDict

Dictionary form of GetFindingsStatisticsInput.

Attributes

detector_id instance-attribute
detector_id: Required[str]

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: FindingCriteria | FindingCriteriaDict | None

Represents the criteria that is used for querying findings.

finding_statistic_types instance-attribute
finding_statistic_types: Sequence[str] | None

The types of finding statistics to retrieve.

group_by instance-attribute
group_by: str | None

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

max_results instance-attribute
max_results: int | 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 instance-attribute
order_by: str | 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.

GetFindingsStatisticsInput dataclass

Bases: _SerdeShape

Dataclass for GetFindingsStatisticsInput structure.

Attributes

detector_id class-attribute instance-attribute
detector_id: str | 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 = ...

Represents the criteria that is used for querying findings.

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

The types of finding statistics to retrieve.

group_by class-attribute instance-attribute
group_by: str | None = ...

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

max_results class-attribute instance-attribute
max_results: int | 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: str | 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

Bases: _SerdeShape

Dataclass for GetFindingsStatisticsOutput structure.

Attributes

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

The finding statistics object.

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

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

This parameter is currently not supported.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.