Skip to content

GetUsageStatisticsRequest

Source code in docs_src/capo_guardduty/types/get_usage_statistics_request.py 
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
class GetUsageStatisticsRequest(TypedDict, closed=True):
    detector_id: "capo_guardduty.types.detector_id.DetectorId"
    """<p>The ID of the detector that specifies the GuardDuty service whose usage statistics 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>"""
    usage_statistic_type: NotRequired[
        "capo_guardduty.types.usage_statistic_type.UsageStatisticType"
    ]
    """<p>The type of usage statistics to retrieve.</p>"""
    usage_criteria: NotRequired["capo_guardduty.types.usage_criteria.UsageCriteria"]
    """<p>Represents the criteria used for querying usage.</p>"""
    unit: NotRequired["capo_guardduty.types.string.String"]
    """<p>The currency unit you would like to view your usage statistics in. Current valid values are USD.</p>"""
    max_results: NotRequired["capo_guardduty.types.max_results.MaxResults"]
    """<p>The maximum number of results to return in the response.</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>"""

detector_id instance-attribute 

detector_id: DetectorId

The ID of the detector that specifies the GuardDuty service whose usage statistics 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.

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.

unit instance-attribute 

unit: NotRequired[String]

The currency unit you would like to view your usage statistics in. Current valid values are USD.

usage_criteria instance-attribute 

usage_criteria: NotRequired[UsageCriteria]

Represents the criteria used for querying usage.

usage_statistic_type instance-attribute 

usage_statistic_type: NotRequired[UsageStatisticType]

The type of usage statistics to retrieve.