/indices/buckets

The AWS IoT Wireless multi-region endpoint

https://api.iotwireless.{region}.amazonaws.com

POST

/indices/buckets

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

Requires permission to access the GetBucketsAggregation action.

Request

Body Params application/json

Examples

Responses

🟢200Success

application/json

Bodyapplication/json

🟠480InvalidRequestException

🟠481ThrottlingException

🟠482UnauthorizedException

🟠483ServiceUnavailableException

🟠484InternalFailureException

🟠485ResourceNotFoundException

🟠486InvalidQueryException

🟠487InvalidAggregationException

🟠488IndexNotReadyException

Request Example

Shell

JavaScript

Java

Swift

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

Response Example

200 - Example 1

{
    "totalCount": 0,
    "buckets": []
}

Modified at 2022-09-10 23:12:17

/behavior-model-training/summaries

/indices/cardinality