usage_totals

Creates, updates, deletes, gets or lists a usage_totals resource.

Overview

Name	usage_totals
Type	Resource
Id	aws.macie2.usage_totals

Fields

The following fields are returned by SELECT queries:

get_usage_totals

Name	Datatype	Description
time_range	string	An inclusive time period that Amazon Macie usage data applies to. Possible values are: (MONTH_TO_DATE, PAST_30_DAYS)
usage_totals	array	An array of objects that contains the results of the query. Each object contains the data for a specific usage metric.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_usage_totals	select	region	timeRange	Retrieves (queries) aggregated usage data for an account.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)
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.

SELECT examples

get_usage_totals

Retrieves (queries) aggregated usage data for an account.

SELECT
time_range,
usage_totals
FROM aws.macie2.usage_totals
WHERE region = '{{ region }}' -- required
AND timeRange = '{{ timeRange }}'
;