Skip to content
AWS for Query.Farm

aws.iot.get_buckets_aggregation

Example SQL Queries

SELECT * FROM
aws.iot.get_buckets_aggregation
WHERE
"query_string" = 'VALUE'
AND "aggregation_field" = 'VALUE'
AND "buckets_aggregation_type" = 'VALUE';

Description

Aggregates on indexed data with search queries pertaining to particular fields.

Requires permission to access the GetBucketsAggregation action.

Table Definition

Column NameColumn Data Type
aggregation_field Required Input Column

The aggregation field.

VARCHAR
buckets_aggregation_type Required Input Column

The basic control of the response shape and the bucket aggregation type to perform. 

STRUCT(
    "terms_aggregation" STRUCT(
        "max_buckets" BIGINT
    )
)
Show child fields
buckets_aggregation_type.terms_aggregation

Performs an aggregation that will return a list of buckets. The list of buckets is a ranked list of the number of occurrences of an aggregation field value.

Show child fields
buckets_aggregation_type.terms_aggregation.max_buckets

The number of buckets to return in the response. Default to 10.

query_string Required Input Column

The search query string.

VARCHAR
index_name Input Column

The name of the index to search.

VARCHAR
query_version Input Column

The version of the query.

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
buckets

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.

STRUCT(
    "key_value" VARCHAR,
    "count" BIGINT
)[]
Show child fields
buckets[]
Show child fields
buckets[].count

The number of documents that have the value counted for the particular bucket.

buckets[].key_value

The value counted for the particular bucket.

total_count

The total number of things that fit the query string criteria.

BIGINT