list_coverage¶
Operation¶
async
¶
list_coverage(input: ListCoverageInput, plugins: list[Plugin] | None = None) -> ListCoverageOutput
Lists coverage details for your GuardDuty account. If you're a GuardDuty administrator, you can retrieve all resources associated with the active member accounts in your organization.
Make sure the accounts have Runtime Monitoring enabled and GuardDuty agent running on their resources.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
ListCoverageInput
|
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 |
|---|---|
ListCoverageOutput
|
An instance of |
Input¶
dataclass
¶
Dataclass for ListCoverageInput structure.
Attributes¶
class-attribute
instance-attribute
¶
detector_id: str | None = None
The unique ID of the detector whose coverage details 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.
class-attribute
instance-attribute
¶
filter_criteria: CoverageFilterCriteria | None = None
Represents the criteria used to filter the coverage details.
class-attribute
instance-attribute
¶
max_results: int | None = None
The maximum number of results to return in the response.
class-attribute
instance-attribute
¶
next_token: str | None = None
A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. For subsequent calls, use the NextToken value returned from the previous request to continue listing results after the first page.
class-attribute
instance-attribute
¶
sort_criteria: CoverageSortCriteria | None = None
Represents the criteria used to sort the coverage details.
Output¶
dataclass
¶
Dataclass for ListCoverageOutput structure.
Attributes¶
class-attribute
instance-attribute
¶
next_token: str | None = None
The pagination parameter to be used on the next list operation to retrieve more items.
class-attribute
instance-attribute
¶
resources: list[CoverageResource] | None = None
A list of resources and their attributes providing cluster details.