POST

/indices/buckets

http://iot.{region}.amazonaws.com/indices/buckets

<p>Aggregates on indexed data with search queries pertaining to particular fields. </p> <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">GetBucketsAggregation</a> action.</p>

Access Token Required: API Key

Body Params

indexNamestring

The name of the index to search.

queryStringstringrequired

The search query string.

queryVersionstring

The version of the query.

aggregationFieldstringrequired

The aggregation field.

bucketsAggregationTypeobjectrequired

The type of bucketed aggregation performed.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request POST \
2     --url 'http://iot.{region}.amazonaws.com/indices/buckets' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}