get_usage_statistics ¶

def get_usage_statistics(
    self,
    *,
    config_overrides: Optional[Macie2ClientConfig] = None,
    filter_by: Optional[
        "capo_macie2.types.__list_of_usage_statistics_filter.__listOfUsageStatisticsFilter"
    ] = None,
    max_results: Optional["capo_macie2.types.__integer.__integer"] = None,
    next_token: Optional["capo_macie2.types.__string.__string"] = None,
    sort_by: Optional[
        "capo_macie2.types.usage_statistics_sort_by.UsageStatisticsSortBy"
    ] = None,
    time_range: Optional["capo_macie2.types.time_range.TimeRange"] = None,
) -> "capo_macie2.types.get_usage_statistics_response.GetUsageStatisticsResponse":
    """<p>Retrieves (queries) quotas and aggregated usage data for one or more accounts.</p>

    Args:
        filter_by: <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: <p>The maximum number of items to include in each page of the response.</p>
        next_token: <p>The nextToken string that specifies which page of results to return in a paginated response.</p>
        sort_by: <p>The criteria to use to sort the query results.</p>
        time_range: <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>

    Raises:
        capo_macie2.errors.access_denied_exception.AccessDeniedException: <p>Provides information about an error that occurred due to insufficient access to a specified resource.</p>
        capo_macie2.errors.conflict_exception.ConflictException: <p>Provides information about an error that occurred due to a versioning conflict for a specified resource.</p>
        capo_macie2.errors.internal_server_exception.InternalServerException: <p>Provides information about an error that occurred due to an unknown internal server error, exception, or failure.</p>
        capo_macie2.errors.resource_not_found_exception.ResourceNotFoundException: <p>Provides information about an error that occurred because a specified resource wasn't found.</p>
        capo_macie2.errors.service_quota_exceeded_exception.ServiceQuotaExceededException: <p>Provides information about an error that occurred due to one or more service quotas for an account.</p>
        capo_macie2.errors.throttling_exception.ThrottlingException: <p>Provides information about an error that occurred because too many requests were sent during a certain amount of time.</p>
        capo_macie2.errors.validation_exception.ValidationException: <p>Provides information about an error that occurred due to a syntax error in a request.</p>
        capo_macie2.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_macie2.types.get_usage_statistics_request.GetUsageStatisticsRequest]",
    ) -> OperationResponse[
        "capo_macie2.types.get_usage_statistics_response.GetUsageStatisticsResponse"
    ]:
        import capo_macie2._operations.macie2.get_usage_statistics

        output, http_response = (
            capo_macie2._operations.macie2.get_usage_statistics.get_usage_statistics(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetUsageStatistics")
    )
    input_: capo_macie2.types.get_usage_statistics_request.GetUsageStatisticsRequest = {}
    if filter_by is not None:
        input_["filter_by"] = filter_by
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token
    if sort_by is not None:
        input_["sort_by"] = sort_by
    if time_range is not None:
        input_["time_range"] = time_range

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output