GetStatistics - Amazon IoT
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).


Returns the count, average, sum, minimum, maximum, sum of squares, variance, and standard deviation for the specified aggregated field. If the aggregation field is of type String, only the count statistic is returned.

Requires permission to access the GetStatistics action.

Request Syntax

POST /indices/statistics HTTP/1.1 Content-type: application/json { "aggregationField": "string", "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.


The aggregation field name.

Type: String

Length Constraints: Minimum length of 1.

Required: No


The name of the index to search. The default value is AWS_Things.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

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

Required: No


The query used to search. You can specify "*" for the query string to get the count of all indexed things in your Amazon account.

Type: String

Length Constraints: Minimum length of 1.

Required: Yes


The version of the query used to search.

Type: String

Required: No

Response Syntax

HTTP/1.1 200 Content-type: application/json { "statistics": { "average": number, "count": number, "maximum": number, "minimum": number, "stdDeviation": number, "sum": number, "sumOfSquares": number, "variance": 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.


The statistics returned by the Fleet Indexing service based on the query and aggregation field.

Type: Statistics object



The index is not ready.

HTTP Status Code: 400


An unexpected error has occurred.

HTTP Status Code: 500


The aggregation is invalid.

HTTP Status Code: 400


The query is invalid.

HTTP Status Code: 400


The request is not valid.

HTTP Status Code: 400


The specified resource does not exist.

HTTP Status Code: 404


The service is temporarily unavailable.

HTTP Status Code: 503


The rate exceeds the limit.

HTTP Status Code: 400


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 Amazon SDKs, see the following: