Skip to content

GuardDuty  >  Operations  >  get_coverage_statistics

get_coverage_statistics

Operation

get_coverage_statistics async 

get_coverage_statistics(input: GetCoverageStatisticsInput, plugins: list[Plugin] | None = None) -> 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
input GetCoverageStatisticsInput

An instance of GetCoverageStatisticsInput.

 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
GetCoverageStatisticsOutput

An instance of GetCoverageStatisticsOutput.

Input

GetCoverageStatisticsInput dataclass

Dataclass for GetCoverageStatisticsInput structure.

Attributes

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

Represents the criteria used to filter the coverage statistics.

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

Represents the statistics type used to aggregate the coverage details.

Output

GetCoverageStatisticsOutput dataclass

Dataclass for GetCoverageStatisticsOutput structure.

Attributes

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

Represents the count aggregated by the statusCode and resourceType.

response_metadata class-attribute instance-attribute 
response_metadata: ResponseMetadata = field(default=EMPTY_RESPONSE_METADATA, repr=False, compare=False)

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.