/indices/percentiles - AWS IoT Wireless

Groups the aggregated values that match the query into percentile groupings. The default percentile groupings are: 1,5,25,50,75,95,99, although you can specify your own when you call GetPercentiles. This function returns a value for each percentile group specified (or the default percentile groupings). The percentile group "1" contains the aggregated field value that occurs in approximately one percent of the values that match the query. The percentile group "5" contains the aggregated field value that occurs in approximately five percent of the values that match the query, and so on. The result is an approximation, the more values that match the query, the more accurate the percentile values.

Requires permission to access the GetPercentiles action.

curl --location -g --request POST 'https://api.iotwireless.{region}.amazonaws.com/indices/percentiles' \ --header 'Content-Type: application/json' \ --data-raw '{ "indexName": "string", "queryString": "string", "aggregationField": "string", "queryVersion": "string", "percents": [ 0 ] }'

Request

Body Params application/json

indexName

string

optional

The name of the index to search.

>= 1 characters<= 128 characters

Match pattern:

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

queryString

string

required

The search query string.

>= 1 characters

aggregationField

string

optional

The field to aggregate.

>= 1 characters

queryVersion

string

optional

The query version.

percents

array[number <double>]

optional

The percentile groups returned.

Examples

Responses

🟢200Success

application/json

Body

percentiles

array[object (PercentPair) {2}]

optional

The percentile values of the aggregated fields.

percent

number <double>

optional

The percentile.

>= 0<= 100

value

number <double>

optional

The value of the percentile.

🟠480InvalidRequestException

🟠481ThrottlingException

🟠482UnauthorizedException

🟠483ServiceUnavailableException

🟠484InternalFailureException

🟠485ResourceNotFoundException

🟠486InvalidQueryException

🟠487InvalidAggregationException

🟠488IndexNotReadyException