# GetBucketsAggregation
<a name="API_GetBucketsAggregation"></a>

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

Requires permission to access the [GetBucketsAggregation](https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

## Request Syntax
<a name="API_GetBucketsAggregation_RequestSyntax"></a>

```
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
<a name="API_GetBucketsAggregation_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_GetBucketsAggregation_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [aggregationField](#API_GetBucketsAggregation_RequestSyntax) **   <a name="iot-GetBucketsAggregation-request-aggregationField"></a>
The aggregation field.  
Type: String  
Length Constraints: Minimum length of 1.  
Required: Yes

 ** [bucketsAggregationType](#API_GetBucketsAggregation_RequestSyntax) **   <a name="iot-GetBucketsAggregation-request-bucketsAggregationType"></a>
The basic control of the response shape and the bucket aggregation type to perform.   
Type: [BucketsAggregationType](API_BucketsAggregationType.md) object  
Required: Yes

 ** [indexName](#API_GetBucketsAggregation_RequestSyntax) **   <a name="iot-GetBucketsAggregation-request-indexName"></a>
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

 ** [queryString](#API_GetBucketsAggregation_RequestSyntax) **   <a name="iot-GetBucketsAggregation-request-queryString"></a>
The search query string.  
Type: String  
Length Constraints: Minimum length of 1.  
Required: Yes

 ** [queryVersion](#API_GetBucketsAggregation_RequestSyntax) **   <a name="iot-GetBucketsAggregation-request-queryVersion"></a>
The version of the query.  
Type: String  
Required: No

## Response Syntax
<a name="API_GetBucketsAggregation_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "buckets": [ 
      { 
         "count": number,
         "keyValue": "string"
      }
   ],
   "totalCount": number
}
```

## Response Elements
<a name="API_GetBucketsAggregation_ResponseElements"></a>

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

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

 ** [buckets](#API_GetBucketsAggregation_ResponseSyntax) **   <a name="iot-GetBucketsAggregation-response-buckets"></a>
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](API_Bucket.md) objects

 ** [totalCount](#API_GetBucketsAggregation_ResponseSyntax) **   <a name="iot-GetBucketsAggregation-response-totalCount"></a>
The total number of things that fit the query string criteria.  
Type: Integer

## Errors
<a name="API_GetBucketsAggregation_Errors"></a>

 ** IndexNotReadyException **   
The index is not ready.    
 ** message **   
The message for the exception.
HTTP Status Code: 400

 ** InternalFailureException **   
An unexpected error has occurred.    
 ** message **   
The message for the exception.
HTTP Status Code: 500

 ** InvalidAggregationException **   
The aggregation is invalid.  
HTTP Status Code: 400

 ** InvalidQueryException **   
The query is invalid.    
 ** message **   
The message for the exception.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** message **   
The message for the exception.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource does not exist.    
 ** message **   
The message for the exception.
HTTP Status Code: 404

 ** ServiceUnavailableException **   
The service is temporarily unavailable.    
 ** message **   
The message for the exception.
HTTP Status Code: 503

 ** ThrottlingException **   
The rate exceeds the limit.    
 ** message **   
The message for the exception.
HTTP Status Code: 400

 ** UnauthorizedException **   
You are not authorized to perform this operation.    
 ** message **   
The message for the exception.
HTTP Status Code: 401

## See Also
<a name="API_GetBucketsAggregation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/iot-2015-05-28/GetBucketsAggregation) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/iot-2015-05-28/GetBucketsAggregation) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/iot-2015-05-28/GetBucketsAggregation) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/iot-2015-05-28/GetBucketsAggregation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/iot-2015-05-28/GetBucketsAggregation) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/iot-2015-05-28/GetBucketsAggregation) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/iot-2015-05-28/GetBucketsAggregation) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/iot-2015-05-28/GetBucketsAggregation) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/iot-2015-05-28/GetBucketsAggregation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/iot-2015-05-28/GetBucketsAggregation)