GetBucketsAggregation
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.
- aggregationField
-
The aggregation field.
Type: String
Length Constraints: Minimum length of 1.
Required: Yes
- bucketsAggregationType
-
The basic control of the response shape and the bucket aggregation type to perform.
Type: BucketsAggregationType object
Required: Yes
- indexName
-
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
-
The search query string.
Type: String
Length Constraints: Minimum length of 1.
Required: Yes
- queryVersion
-
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.
- buckets
-
The main part of the response with a list of buckets. Each bucket contains a
keyValueand acount.keyValue: The aggregation field value counted for the particular bucket.count: The number of documents that have that value.Type: Array of Bucket objects
- totalCount
-
The total number of things that fit the query string criteria.
Type: Integer
Errors
- IndexNotReadyException
-
The index is not ready.
HTTP Status Code: 400
- InternalFailureException
-
An unexpected error has occurred.
HTTP Status Code: 500
- InvalidAggregationException
-
The aggregation is invalid.
HTTP Status Code: 400
- InvalidQueryException
-
The query is invalid.
HTTP Status Code: 400
- InvalidRequestException
-
The request is not valid.
HTTP Status Code: 400
- ResourceNotFoundException
-
The specified resource does not exist.
HTTP Status Code: 404
- ServiceUnavailableException
-
The service is temporarily unavailable.
HTTP Status Code: 503
- ThrottlingException
-
The rate exceeds the limit.
HTTP Status Code: 400
- UnauthorizedException
-
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 AWS SDKs, see the following:
