get_coverage_statistics¶
Operation¶
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 |
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 |
Input¶
dataclass
¶
Dataclass for GetCoverageStatisticsInput structure.
Attributes¶
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.
class-attribute
instance-attribute
¶
filter_criteria: CoverageFilterCriteria | None = None
Represents the criteria used to filter the coverage statistics.
class-attribute
instance-attribute
¶
statistics_type: list[CoverageStatisticsType] | None = None
Represents the statistics type used to aggregate the coverage details.
Output¶
dataclass
¶
Dataclass for GetCoverageStatisticsOutput structure.
Attributes¶
class-attribute
instance-attribute
¶
coverage_statistics: CoverageStatistics | None = None
Represents the count aggregated by the statusCode and resourceType.