GetBucketsAggregation - Amazon IoT
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).


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

Requires permission to access the GetBucketsAggregation action.

Request Syntax

POST /indices/buckets HTTP/1.1 Content-type: application/json { "aggregationField": "string", "bucketsAggregationType": { "termsAggregation": { "maxBuckets": number } }, "indexName": "string", "queryString": "string", "queryVersion": "string" }

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.


The aggregation field.

Type: String

Length Constraints: Minimum length of 1.

Required: Yes


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

Type: BucketsAggregationType object

Required: Yes


The name of the index to search.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

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

Required: No


The search query string.

Type: String

Length Constraints: Minimum length of 1.

Required: Yes


The version of the query.

Type: String

Required: No

Response Syntax

HTTP/1.1 200 Content-type: application/json { "buckets": [ { "count": number, "keyValue": "string" } ], "totalCount": number }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.


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.

Type: Array of Bucket objects


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

Type: Integer



The index is not ready.

HTTP Status Code: 400


An unexpected error has occurred.

HTTP Status Code: 500


The aggregation is invalid.

HTTP Status Code: 400


The query is invalid.

HTTP Status Code: 400


The request is not valid.

HTTP Status Code: 400


The specified resource does not exist.

HTTP Status Code: 404


The service is temporarily unavailable.

HTTP Status Code: 503


The rate exceeds the limit.

HTTP Status Code: 400


You are not authorized to perform this operation.

HTTP Status Code: 401

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: