Macie2 / Client / get_usage_totals

get_usage_totals#

Macie2.Client.get_usage_totals(**kwargs)#

Retrieves (queries) aggregated usage data for an account.

See also: AWS API Documentation

Request Syntax

response = client.get_usage_totals(
    timeRange='string'
)
Parameters:

timeRange (string) – 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.

Return type:

dict

Returns:

Response Syntax

{
    'timeRange': 'MONTH_TO_DATE'|'PAST_30_DAYS',
    'usageTotals': [
        {
            'currency': 'USD',
            'estimatedCost': 'string',
            'type': 'DATA_INVENTORY_EVALUATION'|'SENSITIVE_DATA_DISCOVERY'|'AUTOMATED_SENSITIVE_DATA_DISCOVERY'|'AUTOMATED_OBJECT_MONITORING'
        },
    ]
}

Response Structure

  • (dict) –

    The request succeeded.

    • timeRange (string) –

      The inclusive time period that the usage data applies to. Possible values are: MONTH_TO_DATE, for the current calendar month to date; and, PAST_30_DAYS, for the preceding 30 days.

    • usageTotals (list) –

      An array of objects that contains the results of the query. Each object contains the data for a specific usage metric.

      • (dict) –

        Provides aggregated data for an Amazon Macie usage metric. The value for the metric reports estimated usage data for an account for the preceding 30 days or the current calendar month to date, depending on the time period (timeRange) specified in the request.

        • currency (string) –

          The type of currency that the value for the metric (estimatedCost) is reported in.

        • estimatedCost (string) –

          The estimated value for the metric.

        • type (string) –

          The name of the metric. Possible values are: AUTOMATED_OBJECT_MONITORING, to monitor S3 objects for automated sensitive data discovery; AUTOMATED_SENSITIVE_DATA_DISCOVERY, to analyze S3 objects for automated sensitive data discovery; DATA_INVENTORY_EVALUATION, to monitor S3 buckets; and, SENSITIVE_DATA_DISCOVERY, to run classification jobs.

Exceptions