Skip to content

get_coverage_statistics

Operation

get_coverage_statistics

get_coverage_statistics(request: GetCoverageStatisticsInput | GetCoverageStatisticsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetCoverageStatisticsInputDict]) -> GetCoverageStatisticsOutput

Retrieves aggregated statistics for your account. If you are a GuardDuty administrator, you can retrieve the statistics for all the resources associated with the active member accounts in your organization who have enabled Runtime Monitoring and have the GuardDuty security agent running on their resources.

Parameters:

Name Type Description Default
request GetCoverageStatisticsInput | GetCoverageStatisticsInputDict | 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[GetCoverageStatisticsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetCoverageStatisticsOutput

An instance of GetCoverageStatisticsOutput.

get_coverage_statistics async

get_coverage_statistics(request: GetCoverageStatisticsInput | GetCoverageStatisticsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetCoverageStatisticsInputDict]) -> GetCoverageStatisticsOutput

Retrieves aggregated statistics for your account. If you are a GuardDuty administrator, you can retrieve the statistics for all the resources associated with the active member accounts in your organization who have enabled Runtime Monitoring and have the GuardDuty security agent running on their resources.

Parameters:

Name Type Description Default
request GetCoverageStatisticsInput | GetCoverageStatisticsInputDict | 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[GetCoverageStatisticsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetCoverageStatisticsOutput

An instance of GetCoverageStatisticsOutput.

Input

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

GetCoverageStatisticsInputDict

Bases: TypedDict

Dictionary form of GetCoverageStatisticsInput.

Attributes

detector_id instance-attribute
detector_id: Required[str]

The unique ID of the GuardDuty detector.

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

filter_criteria instance-attribute

Represents the criteria used to filter the coverage statistics.

statistics_type instance-attribute
statistics_type: Required[Sequence[str]]

Represents the statistics type used to aggregate the coverage details.

GetCoverageStatisticsInput dataclass

Bases: _SerdeShape

Dataclass for GetCoverageStatisticsInput structure.

Attributes

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

The unique ID of the GuardDuty detector.

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

filter_criteria class-attribute instance-attribute
filter_criteria: CoverageFilterCriteria | None = ...

Represents the criteria used to filter the coverage statistics.

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

Represents the statistics type used to aggregate the coverage details.

Output

GetCoverageStatisticsOutput dataclass

Bases: _SerdeShape

Dataclass for GetCoverageStatisticsOutput structure.

Attributes

coverage_statistics class-attribute instance-attribute
coverage_statistics: CoverageStatistics | None = ...

Represents the count aggregated by the statusCode and resourceType.

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.