Skip to content

ListCoverageRequest

Source code in docs_src/capo_guardduty/types/list_coverage_request.py 
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
class ListCoverageRequest(TypedDict, closed=True):
    detector_id: "capo_guardduty.types.detector_id.DetectorId"
    """<p>The unique ID of the detector whose coverage details you want to retrieve.</p> <p>To find the <code>detectorId</code> in the current Region, see the Settings page in the GuardDuty console, or run the <a href="https://docs.aws.amazon.com/guardduty/latest/APIReference/API_ListDetectors.html">ListDetectors</a> API.</p>"""
    next_token: NotRequired["capo_guardduty.types.string.String"]
    """<p>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.</p>"""
    max_results: NotRequired["capo_guardduty.types.max_results.MaxResults"]
    """<p>The maximum number of results to return in the response.</p>"""
    filter_criteria: NotRequired[
        "capo_guardduty.types.coverage_filter_criteria.CoverageFilterCriteria"
    ]
    """<p>Represents the criteria used to filter the coverage details.</p>"""
    sort_criteria: NotRequired[
        "capo_guardduty.types.coverage_sort_criteria.CoverageSortCriteria"
    ]
    """<p>Represents the criteria used to sort the coverage details.</p>"""

detector_id instance-attribute 

detector_id: DetectorId

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: NotRequired[CoverageFilterCriteria]

Represents the criteria used to filter the coverage details.

max_results instance-attribute 

max_results: NotRequired[MaxResults]

The maximum number of results to return in the response.

next_token instance-attribute 

next_token: NotRequired[String]

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: NotRequired[CoverageSortCriteria]

Represents the criteria used to sort the coverage details.