get_usage_totals ¶

get_usage_totals(
    *,
    config_overrides: Optional[Macie2ClientConfig] = None,
    time_range: Optional[__string] = None,
) -> GetUsageTotalsResponse

Retrieves (queries) aggregated usage data for an account.

Parameters:

time_range (Optional[__string], default: None ) –

The inclusive time period to retrieve the 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 for this parameter, Amazon Macie provides aggregated usage data for the preceding 30 days.

Raises:

AccessDeniedException –

Provides information about an error that occurred due to insufficient access to a specified resource.
ConflictException –

Provides information about an error that occurred due to a versioning conflict for a specified resource.
InternalServerException –

Provides information about an error that occurred due to an unknown internal server error, exception, or failure.
ResourceNotFoundException –

Provides information about an error that occurred because a specified resource wasn't found.
ServiceQuotaExceededException –

Provides information about an error that occurred due to one or more service quotas for an account.
ThrottlingException –

Provides information about an error that occurred because too many requests were sent during a certain amount of time.
ValidationException –

Provides information about an error that occurred due to a syntax error in a request.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_macie2/_services/macie2.py

def get_usage_totals(
    self,
    *,
    config_overrides: Optional[Macie2ClientConfig] = None,
    time_range: Optional["capo_macie2.types.__string.__string"] = None,
) -> "capo_macie2.types.get_usage_totals_response.GetUsageTotalsResponse":
    """<p>Retrieves (queries) aggregated usage data for an account.</p>

    Args:
        time_range: <p>The inclusive time period to retrieve the 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 for this parameter, Amazon Macie provides aggregated 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_totals_request.GetUsageTotalsRequest]",
    ) -> OperationResponse[
        "capo_macie2.types.get_usage_totals_response.GetUsageTotalsResponse"
    ]:
        import capo_macie2._operations.macie2.get_usage_totals

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetUsageTotals")
    )
    input_: capo_macie2.types.get_usage_totals_request.GetUsageTotalsRequest = {}
    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