How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Amazon IoT Device Management Indices API

The Indices API from Amazon IoT Device Management — 7 operation(s) for indices.

Amazon IoT Device Management Indices API is one of 69 APIs that Amazon IoT Device Management publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Indices. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, and pricing.

This API exposes 7 operations across 7 paths, and defines 57 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against 4 base URLs: http://iot.{region}.amazonaws.com, https://iot.{region}.amazonaws.com, http://iot.{region}.amazonaws.com.cn, https://iot.{region}.amazonaws.com.cn.

7 operations 7 paths 57 schemas 2 GET5 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://iot.amazonaws.com
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

Amazon IoT Device Management Indices API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (hmac). By default, every request must be authenticated.

  • hmac — Amazon Signature authorization v4

Paths & Operations 7

Across 7 paths, the API surfaces 7 operations — 2 GET, 5 POST. Each is listed below with its method, path, parameters, and response codes.

Indices 7
GET
/indices/{indexName}
Amazon IoT Device Management Describe Index
DescribeIndex 8 params → 200480481482483484485
POST
/indices/buckets
Amazon IoT Device Management Get Buckets Aggregation
GetBucketsAggregation 7 params body → 200480481482483484485486
POST
/indices/cardinality
Amazon IoT Device Management Get Cardinality
GetCardinality 7 params body → 200480481482483484485486
POST
/indices/percentiles
Amazon IoT Device Management Get Percentiles
GetPercentiles 7 params body → 200480481482483484485486
POST
/indices/statistics
Amazon IoT Device Management Get Statistics
GetStatistics 7 params body → 200480481482483484485486
GET
/indices
Amazon IoT Device Management List Indices
ListIndices 9 params → 200480481482483484
POST
/indices/search
Amazon IoT Device Management Search Index
SearchIndex 7 params body → 200480481482483484485486

Schemas 57

The contract defines 57 schemas that model the data the API accepts and returns. The most detailed are ThingDocument (8 properties), Statistics (8 properties), ThingGroupDocument (5 properties), ThingConnectivity (3 properties). Each schema is shown below with its type and property counts.

Variance
number
ThingGroupDocument
object
The thing group search index document.
5 properties
Percent
number
Attributes
object
ThrottlingException
IndexStatus
string
InvalidQueryException
InternalFailureException
Statistics
object
A map of key-value pairs for all supported statistics. For issues with missing or unexpected values for this API, consult Fleet indexing troubleshooting guide .
8 properties
Boolean
boolean
GetPercentilesResponse
object
1 property
TermsAggregation
object
Performs an aggregation that will return a list of buckets. The list of buckets is a ranked list of the number of occurrences of an aggregation field value.
1 property
SumOfSquares
number
ThingGroupId
string
Sum
number
InvalidRequestException
IndexNamesList
array
ThingGroupName
string
Minimum
number
MaxBuckets
integer
InvalidAggregationException
Maximum
number
ThingId
string
ThingTypeName
string
UnauthorizedException
ThingGroupNameList
array
ThingConnectivity
object
The connectivity status of the thing.
3 properties
ThingDocument
object
The thing search index document.
8 properties
JsonDocument
string
PercentValue
number
ThingGroupDocumentList
array
Average
number
ThingGroupDescription
string
Bucket
object
A count of documents that meets a specific aggregation criteria.
2 properties
ServiceUnavailableException
DisconnectReason
string
IndexSchema
string
AttributeValue
string
SearchIndexResponse
object
3 properties
IndexName
string
StdDeviation
number
NextToken
string
DescribeIndexResponse
object
3 properties
Percentiles
array
ThingName
string
GetBucketsAggregationResponse
object
2 properties
ThingDocumentList
array
PercentPair
object
Describes the percentile and percentile value.
2 properties
GetStatisticsResponse
object
1 property
ResourceNotFoundException
ListIndicesResponse
object
2 properties
BucketKeyValue
string
IndexNotReadyException
Buckets
array
GetCardinalityResponse
object
1 property
Count
integer
ConnectivityTimestamp
integer

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

amazon-iot-device-management-indices-api-openapi.yml Raw ↑

Other APIs Amazon IoT Device Management publishes across the network.

Amazon IoT Device Management Accept Certificate Transfer API
Amazon IoT Device Management Active Violations API
Amazon IoT Device Management Attached Policies API
Amazon IoT Device Management Audit API
Amazon IoT Device Management Authorizer API
Amazon IoT Device Management Authorizers API
Amazon IoT Device Management Behavior Model Training API
Amazon IoT Device Management Billing Groups API
Amazon IoT Device Management Cacertificate API
Amazon IoT Device Management Cacertificates API
Amazon IoT Device Management Cancel Certificate Transfer API
Amazon IoT Device Management Certificate API
Where this information came from

This is an independent, third-party profile of Amazon IoT Device Management Indices API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.