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 Defender Indices API

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

Amazon IoT Device Defender Indices API is one of 69 APIs that Amazon IoT Device Defender 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 Defender 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 Defender Describe Index
DescribeIndex 8 params → 200480481482483484485
POST
/indices/buckets
Amazon IoT Device Defender Get Buckets Aggregation
GetBucketsAggregation 7 params body → 200480481482483484485486
POST
/indices/cardinality
Amazon IoT Device Defender Get Cardinality
GetCardinality 7 params body → 200480481482483484485486
POST
/indices/percentiles
Amazon IoT Device Defender Get Percentiles
GetPercentiles 7 params body → 200480481482483484485486
POST
/indices/statistics
Amazon IoT Device Defender Get Statistics
GetStatistics 7 params body → 200480481482483484485486
GET
/indices
Amazon IoT Device Defender List Indices
ListIndices 9 params → 200480481482483484
POST
/indices/search
Amazon IoT Device Defender 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), SearchIndexResponse (3 properties). Each schema is shown below with its type and property counts.

GetStatisticsResponse
object
1 property
UnauthorizedException
ThingGroupDescription
string
ThingDocumentList
array
Buckets
array
DescribeIndexResponse
object
3 properties
ThingConnectivity
object
The connectivity status of the thing.
3 properties
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
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
InvalidQueryException
ThingGroupName
string
ConnectivityTimestamp
integer
Count
integer
Boolean
boolean
ThingTypeName
string
Maximum
number
Percentiles
array
Attributes
object
ThingGroupDocumentList
array
Minimum
number
JsonDocument
string
AttributeValue
string
ThingName
string
ThingId
string
NextToken
string
ThingGroupId
string
GetCardinalityResponse
object
1 property
InvalidRequestException
SearchIndexResponse
object
3 properties
BucketKeyValue
string
ThingGroupDocument
object
The thing group search index document.
5 properties
Average
number
ListIndicesResponse
object
2 properties
PercentPair
object
Describes the percentile and percentile value.
2 properties
InternalFailureException
GetBucketsAggregationResponse
object
2 properties
Variance
number
ServiceUnavailableException
ThingDocument
object
The thing search index document.
8 properties
ThrottlingException
IndexSchema
string
GetPercentilesResponse
object
1 property
InvalidAggregationException
ResourceNotFoundException
IndexNotReadyException
ThingGroupNameList
array
Percent
number
Sum
number
StdDeviation
number
SumOfSquares
number
DisconnectReason
string
Bucket
object
A count of documents that meets a specific aggregation criteria.
2 properties
IndexName
string
PercentValue
number
IndexStatus
string
IndexNamesList
array
MaxBuckets
integer

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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

Other APIs Amazon IoT Device Defender publishes across the network.

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

This is an independent, third-party profile of Amazon IoT Device Defender 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.