GetCardinality - AWS IoT

GetCardinality

Returns the approximate count of unique values that match the query.

Requires permission to access the GetCardinality action.

Request Syntax

POST /indices/cardinality 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.

aggregationField

The field to aggregate.

Type: String

Length Constraints: Minimum length of 1.

Required: No

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 query version.

Type: String

Required: No

Response Syntax

HTTP/1.1 200 Content-type: application/json { "cardinality": 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.

cardinality

The approximate count of unique values that match the query.

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: