Skip to content

GetUsageStatisticsRequest

Source code in docs_src/capo_macie2/types/get_usage_statistics_request.py
class GetUsageStatisticsRequest(TypedDict, closed=True):
    filter_by: NotRequired[
        "capo_macie2.types.__list_of_usage_statistics_filter.__listOfUsageStatisticsFilter"
    ]
    """<p>An array of objects, one for each condition to use to filter the query results. If you specify more than one condition, Amazon Macie uses an AND operator to join the conditions.</p>"""
    max_results: NotRequired["capo_macie2.types.__integer.__integer"]
    """<p>The maximum number of items to include in each page of the response.</p>"""
    next_token: NotRequired["capo_macie2.types.__string.__string"]
    """<p>The nextToken string that specifies which page of results to return in a paginated response.</p>"""
    sort_by: NotRequired[
        "capo_macie2.types.usage_statistics_sort_by.UsageStatisticsSortBy"
    ]
    """<p>The criteria to use to sort the query results.</p>"""
    time_range: NotRequired["capo_macie2.types.time_range.TimeRange"]
    """<p>The inclusive time period to query usage data for. Valid values are: MONTH_TO_DATE, for the current calendar month to date; and, PAST_30_DAYS, for the preceding 30 days. If you don't specify a value, Amazon Macie provides usage data for the preceding 30 days.</p>"""

filter_by instance-attribute

filter_by: NotRequired[__listOfUsageStatisticsFilter]

An array of objects, one for each condition to use to filter the query results. If you specify more than one condition, Amazon Macie uses an AND operator to join the conditions.

max_results instance-attribute

max_results: NotRequired[__integer]

The maximum number of items to include in each page of the response.

next_token instance-attribute

next_token: NotRequired[__string]

The nextToken string that specifies which page of results to return in a paginated response.

sort_by instance-attribute

sort_by: NotRequired[UsageStatisticsSortBy]

The criteria to use to sort the query results.

time_range instance-attribute

time_range: NotRequired[TimeRange]

The inclusive time period to query usage data for. Valid values are: MONTH_TO_DATE, for the current calendar month to date; and, PAST_30_DAYS, for the preceding 30 days. If you don't specify a value, Amazon Macie provides usage data for the preceding 30 days.