Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.
openapi: 3.2.0
info:
title: Amazon Web Services iot Indices API
description: 'IoT
IoT provides secure, bi-directional communication between Internet-connected devices (such as sensors, actuators, embedded devices, or smart appliances) and the Amazon Web Services cloud. You can discover your custom IoT-Data endpoint to communicate with, configure rules for data processing and integration with other services, organize resources associated with each device (Registry), configure logging, and create and manage policies and credentials to authenticate devices.
The service endpoints that expose this API are listed in Amazon Web Services IoT Core Endpoints and Quotas. You must use the endpoint for the region that has the resources you want to access.
The service name used by Amazon Web Services Signature Version 4 to sign the request is: execute-api.
For more information about how IoT works, see the Developer Guide.
For information about how to use the credentials provider for IoT, see Authorizing Direct Calls to Amazon Web Services Services.'
tags:
- name: Indices
paths:
/indices/{indexName}:
GET:
summary: Amazon Web Services Describeindex
description: Describes a search index. Requires permission to access the DescribeIndex action.
operationId: amazonWebServicesDescribeIndex
tags:
- Indices
/indices/buckets:
POST:
summary: Amazon Web Services Getbucketsaggregation
description: Aggregates on indexed data with search queries pertaining to particular fields. Requires permission to access the GetBucketsAggregation action.
operationId: amazonWebServicesGetBucketsAggregation
tags:
- Indices
/indices/cardinality:
POST:
summary: Amazon Web Services Getcardinality
description: Returns the approximate count of unique values that match the query. Requires permission to access the GetCardinality action.
operationId: amazonWebServicesGetCardinality
tags:
- Indices
/indices/percentiles:
POST:
summary: Amazon Web Services Getpercentiles
description: '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.'
operationId: amazonWebServicesGetPercentiles
tags:
- Indices
/indices/statistics:
POST:
summary: Amazon Web Services Getstatistics
description: 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.
operationId: amazonWebServicesGetStatistics
tags:
- Indices
/indices:
GET:
summary: Amazon Web Services Listindices
description: Lists the search indices. Requires permission to access the ListIndices action.
operationId: amazonWebServicesListIndices
tags:
- Indices
/indices/search:
POST:
summary: Amazon Web Services Searchindex
description: The query search index. Requires permission to access the SearchIndex action.
operationId: amazonWebServicesSearchIndex
tags:
- Indices