Amazon IoT Core Indexing API

The Indexing API from Amazon IoT Core — 1 operation(s) for indexing.

GitHub OpenAPI

Operations 2

GET /indexing/config Get Indexing Configuration #
POST /indexing/config Update Indexing Configuration #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/amazon-iot-core:amazon-iot-core-indexing-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

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.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

amazon-iot-core-indexing-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: AWS IoT Indexing API
  version: '2015-05-28'
  description: Generated from AWS's published Smithy model for AWS IoT. 2 operation(s).
  contact:
    name: Amazon Web Services
    url: https://aws.amazon.com/contact-us/
  license:
    name: Apache 2.0
    identifier: Apache-2.0
    url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://iot.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /indexing/config:
    get:
      operationId: GetIndexingConfiguration
      summary: Get Indexing Configuration
      description: Gets the indexing configuration. Requires permission to access the GetIndexingConfiguration action.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetIndexingConfigurationResponse'
        '500':
          description: InternalFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalFailureException'
        '400':
          description: InvalidRequestException; ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidRequestException'
        '503':
          description: ServiceUnavailableException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceUnavailableException'
        '401':
          description: UnauthorizedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetIndexingConfigurationRequest'
      tags:
      - Indexing
    post:
      operationId: UpdateIndexingConfiguration
      summary: Update Indexing Configuration
      description: Updates the search configuration. Requires permission to access the UpdateIndexingConfiguration action.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateIndexingConfigurationResponse'
        '500':
          description: InternalFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalFailureException'
        '400':
          description: InvalidRequestException; ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidRequestException'
        '503':
          description: ServiceUnavailableException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceUnavailableException'
        '401':
          description: UnauthorizedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateIndexingConfigurationRequest'
      tags:
      - Indexing
components:
  securitySchemes:
    sigv4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical
        request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
      x-aws-sigv4:
        signingName: iot
  schemas:
    ConnectivityFilter:
      type: object
      properties:
        includeSocketInformation:
          type: array
          items:
            type: string
            enum:
            - GET_THING_CONNECTIVITY_DATA
          description: A list of fleet indexing APIs for which to enable socket information retrieval. Currently, the only
            supported value is GET_THING_CONNECTIVITY_DATA.
    Field:
      type: object
      properties:
        name:
          type: string
          description: The name of the field.
        type:
          type: string
          enum:
          - Number
          - String
          - Boolean
          description: The data type of the field.
    GeoLocationTarget:
      type: object
      properties:
        name:
          type: string
          description: The name of the geolocation target field. If the target field is part of a named shadow, you must select
            the named shadow using the namedShadow filter.
        order:
          type: string
          enum:
          - LatLon
          - LonLat
          description: The order of the geolocation target field. This field is optional. The default value is LatLon.
    GetIndexingConfigurationRequest:
      type: object
      properties: {}
    GetIndexingConfigurationResponse:
      type: object
      properties:
        thingIndexingConfiguration:
          $ref: '#/components/schemas/ThingIndexingConfiguration'
        thingGroupIndexingConfiguration:
          $ref: '#/components/schemas/ThingGroupIndexingConfiguration'
    IndexingFilter:
      type: object
      properties:
        namedShadowNames:
          type: array
          items:
            type: string
          description: The shadow names that you select to index. The default maximum number of shadow names for indexing
            is 10. To increase the limit, see Amazon Web Services IoT Device Management Quotas in the Amazon Web Services
            General Reference.
        geoLocations:
          type: array
          items:
            $ref: '#/components/schemas/GeoLocationTarget'
          description: The list of geolocation targets that you select to index. The default maximum number of geolocation
            targets for indexing is 1. To increase the limit, see Amazon Web Services IoT Device Management Quotas in the
            Amazon Web Services General Reference.
        connectivity:
          $ref: '#/components/schemas/ConnectivityFilter'
    InternalFailureException:
      type: object
      properties:
        message:
          type: string
          description: The message for the exception.
    InvalidRequestException:
      type: object
      properties:
        message:
          type: string
          description: The message for the exception.
    ServiceUnavailableException:
      type: object
      properties:
        message:
          type: string
          description: The message for the exception.
    ThingGroupIndexingConfiguration:
      type: object
      properties:
        thingGroupIndexingMode:
          type: string
          enum:
          - 'OFF'
          - 'ON'
          description: Thing group indexing mode.
        managedFields:
          type: array
          items:
            $ref: '#/components/schemas/Field'
          description: Contains fields that are indexed and whose types are already known by the Fleet Indexing service. This
            is an optional field. For more information, see Managed fields in the Amazon Web Services IoT Core Developer Guide.
            You can't modify managed fields by updating fleet indexing configuration.
        customFields:
          type: array
          items:
            $ref: '#/components/schemas/Field'
          description: A list of thing group fields to index. This list cannot contain any managed fields. Use the GetIndexingConfiguration
            API to get a list of managed fields. Contains custom field names and their data type.
      required:
      - thingGroupIndexingMode
    ThingIndexingConfiguration:
      type: object
      properties:
        thingIndexingMode:
          type: string
          enum:
          - 'OFF'
          - REGISTRY
          - REGISTRY_AND_SHADOW
          description: 'Thing indexing mode. Valid values are: REGISTRY – Your thing index contains registry data only. REGISTRY_AND_SHADOW
            - Your thing index contains registry and shadow data. OFF - Thing indexing is disabled.'
        thingConnectivityIndexingMode:
          type: string
          enum:
          - 'OFF'
          - STATUS
          description: 'Thing connectivity indexing mode. Valid values are: STATUS – Your thing index contains connectivity
            status. To enable thing connectivity indexing, thingIndexMode must not be set to OFF. OFF - Thing connectivity
            status indexing is disabled.'
        deviceDefenderIndexingMode:
          type: string
          enum:
          - 'OFF'
          - VIOLATIONS
          description: 'Device Defender indexing mode. Valid values are: VIOLATIONS – Your thing index contains Device Defender
            violations. To enable Device Defender indexing, deviceDefenderIndexingMode must not be set to OFF. OFF - Device
            Defender indexing is disabled. For more information about Device Defender violations, see Device Defender Detect.'
        namedShadowIndexingMode:
          type: string
          enum:
          - 'OFF'
          - 'ON'
          description: 'Named shadow indexing mode. Valid values are: ON – Your thing index contains named shadow. To enable
            thing named shadow indexing, namedShadowIndexingMode must not be set to OFF. OFF - Named shadow indexing is disabled.
            For more information about Shadows, see IoT Device Shadow service.'
        managedFields:
          type: array
          items:
            $ref: '#/components/schemas/Field'
          description: Contains fields that are indexed and whose types are already known by the Fleet Indexing service. This
            is an optional field. For more information, see Managed fields in the Amazon Web Services IoT Core Developer Guide.
            You can't modify managed fields by updating fleet indexing configuration.
        customFields:
          type: array
          items:
            $ref: '#/components/schemas/Field'
          description: Contains custom field names and their data type.
        filter:
          $ref: '#/components/schemas/IndexingFilter'
      required:
      - thingIndexingMode
    UnauthorizedException:
      type: object
      properties:
        message:
          type: string
          description: The message for the exception.
    UpdateIndexingConfigurationRequest:
      type: object
      properties:
        thingIndexingConfiguration:
          $ref: '#/components/schemas/ThingIndexingConfiguration'
        thingGroupIndexingConfiguration:
          $ref: '#/components/schemas/ThingGroupIndexingConfiguration'
    UpdateIndexingConfigurationResponse:
      type: object
      properties: {}
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/iot/service/2015-05-28/iot-2015-05-28.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)