/indices/buckets - AWS IoT Wireless

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

Requires permission to access the GetBucketsAggregation action.

curl --location -g --request POST 'https://api.iotwireless.{region}.amazonaws.com/indices/buckets' \ --header 'Content-Type: application/json' \ --data-raw '{ "indexName": "string", "queryString": "string", "aggregationField": "string", "queryVersion": "string", "bucketsAggregationType": { "termsAggregation": { "maxBuckets": 0 } } }'

Request

Body Params application/json

indexName

string

optional

The name of the index to search.

>= 1 characters<= 128 characters

Match pattern:

[a-zA-Z0-9:_-]+

queryString

string

required

The search query string.

>= 1 characters

aggregationField

string

required

The aggregation field.

>= 1 characters

queryVersion

string

optional

The version of the query.

bucketsAggregationType

object

required

The type of bucketed aggregation performed.

termsAggregation

object

optional

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.

Examples

Responses

🟢200Success

application/json

Body

totalCount

integer

optional

The total number of documents that fit the query string criteria and contain a value for the Aggregation field targeted in the request.

buckets

array[object (Bucket) {2}]

optional

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.

keyValue

string

optional

The value counted for the particular bucket.

count

integer

optional

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

🟠480InvalidRequestException

🟠481ThrottlingException

🟠482UnauthorizedException

🟠483ServiceUnavailableException

🟠484InternalFailureException

🟠485ResourceNotFoundException

🟠486InvalidQueryException

🟠487InvalidAggregationException

🟠488IndexNotReadyException