list_coverage¶
Operation¶
list_coverage
¶
list_coverage(request: ListCoverageInput | ListCoverageInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListCoverageInputDict]) -> 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 |
|---|---|---|---|
request
|
ListCoverageInput | ListCoverageInputDict | 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[ListCoverageInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
ListCoverageOutput
|
An instance of |
list_coverage
async
¶
list_coverage(request: ListCoverageInput | ListCoverageInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListCoverageInputDict]) -> 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 |
|---|---|---|---|
request
|
ListCoverageInput | ListCoverageInputDict | 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[ListCoverageInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
ListCoverageOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
ListCoverageInputDict
¶
Bases: TypedDict
Dictionary form of ListCoverageInput.
Attributes¶
detector_id
instance-attribute
¶
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.
filter_criteria
instance-attribute
¶
filter_criteria: CoverageFilterCriteria | CoverageFilterCriteriaDict | None
Represents the criteria used to filter the coverage details.
max_results
instance-attribute
¶
max_results: int | None
The maximum number of results to return in the response.
next_token
instance-attribute
¶
next_token: str | 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.
sort_criteria
instance-attribute
¶
sort_criteria: CoverageSortCriteria | CoverageSortCriteriaDict | None
Represents the criteria used to sort the coverage details.
ListCoverageInput
dataclass
¶
Bases: _SerdeShape
Dataclass for ListCoverageInput structure.
Attributes¶
detector_id
class-attribute
instance-attribute
¶
detector_id: str | 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.
filter_criteria
class-attribute
instance-attribute
¶
filter_criteria: CoverageFilterCriteria | None = ...
Represents the criteria used to filter the coverage details.
max_results
class-attribute
instance-attribute
¶
max_results: int | None = ...
The maximum number of results to return in the response.
next_token
class-attribute
instance-attribute
¶
next_token: str | 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.
sort_criteria
class-attribute
instance-attribute
¶
sort_criteria: CoverageSortCriteria | None = ...
Represents the criteria used to sort the coverage details.
Output¶
ListCoverageOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for ListCoverageOutput structure.
Attributes¶
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.
resources
class-attribute
instance-attribute
¶
resources: list[CoverageResource] | None = ...
A list of resources and their attributes providing cluster details.
response_metadata
class-attribute
instance-attribute
¶
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.