buckets_aggregations

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

Overview

Name	buckets_aggregations
Type	Resource
Id	aws.iot.buckets_aggregations

Fields

The following fields are returned by SELECT queries:

get_buckets_aggregation

Name	Datatype	Description
buckets	array	The main part of the response with a list of buckets. Each bucket contains a keyValue and a count. keyValue: The aggregation field value counted for the particular bucket. count: The number of documents that have that value.
total_count	integer	The total number of things that fit the query string criteria.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_buckets_aggregation	select	region		Aggregates on indexed data with search queries pertaining to particular fields. Requires permission to access the GetBucketsAggregation action.

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)

SELECT examples

get_buckets_aggregation

Aggregates on indexed data with search queries pertaining to particular fields. Requires permission to access the GetBucketsAggregation action.

SELECT
buckets,
total_count
FROM aws.iot.buckets_aggregations
WHERE region = '{{ region }}' -- required
;