---
title: "GET /indexing/config"
method: GET
path: "/indexing/config"
---

# GET /indexing/config

`GET /indexing/config`

Gets the indexing configuration.

Requires permission to access the [GetIndexingConfiguration](https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

## Response `200`

Success

- GetIndexingConfigurationResponse
  - `thingIndexingConfiguration` object — Thing indexing configuration.
    - `thingIndexingMode` 'OFF' | 'REGISTRY' | 'REGISTRY_AND_SHADOW', required — <p>Thing indexing mode. Valid values are:</p> <ul> <li> <p>REGISTRY – Your thing index contains registry data only.</p> </li> <li> <p>REGISTRY_AND_SHADOW - Your thing index contains registry and shadow data.</p> </li> <li> <p>OFF - Thing indexing is disabled.</p> </li> </ul>
    - `thingConnectivityIndexingMode` 'OFF' | 'STATUS' — <p>Thing connectivity indexing mode. Valid values are: </p> <ul> <li> <p>STATUS – Your thing index contains connectivity status. To enable thing connectivity indexing, <i>thingIndexMode</i> must not be set to OFF.</p> </li> <li> <p>OFF - Thing connectivity status indexing is disabled.</p> </li> </ul>
    - `deviceDefenderIndexingMode` 'OFF' | 'VIOLATIONS' — <p>Device Defender indexing mode. Valid values are:</p> <ul> <li> <p>VIOLATIONS – Your thing index contains Device Defender violations. To enable Device Defender indexing, <i>deviceDefenderIndexingMode</i> must not be set to OFF.</p> </li> <li> <p>OFF - Device Defender indexing is disabled.</p> </li> </ul> <p>For more information about Device Defender violations, see <a href="https://docs.aws.amazon.com/iot/latest/developerguide/device-defender-detect.html">Device Defender Detect.</a> </p>
    - `namedShadowIndexingMode` 'OFF' | 'ON' — <p>Named shadow indexing mode. Valid values are:</p> <ul> <li> <p>ON – Your thing index contains named shadow. To enable thing named shadow indexing, <i>namedShadowIndexingMode</i> must not be set to OFF.</p> </li> <li> <p>OFF - Named shadow indexing is disabled.</p> </li> </ul> <p>For more information about Shadows, see <a href="https://docs.aws.amazon.com/iot/latest/developerguide/iot-device-shadows.html">IoT Device Shadow service.</a> </p>
    - `managedFields` Field[] — Contains fields that are indexed and whose types are already known by the Fleet Indexing service.
      - `name` string — The name of the field.
      - `type` 'Number' | 'String' | 'Boolean' — The data type of the field.
    - `customFields` Field[] — Contains custom field names and their data type.
      - `name` string — The name of the field.
      - `type` 'Number' | 'String' | 'Boolean' — The data type of the field.
    - `filter` object — Provides additional filters for specific data sources. Named shadow is the only data source that currently supports and requires a filter. To add named shadows to your fleet indexing configuration, set <code>namedShadowIndexingMode</code> to be <code>ON</code> and specify your shadow names in <code>filter</code>.
      - `namedShadowNames` ShadowName[] — The shadow names that you select to index. The default maximum number of shadow names for indexing is 10. To increase the limit, see <a href="https://docs.aws.amazon.com/general/latest/gr/iot_device_management.html#fleet-indexing-limits">Amazon Web Services IoT Device Management Quotas</a> in the <i>Amazon Web Services General Reference</i>.
  - `thingGroupIndexingConfiguration` object — The index configuration.
    - `thingGroupIndexingMode` 'OFF' | 'ON', required — Thing group indexing mode.
    - `managedFields` Field[] — 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 <a href="https://docs.aws.amazon.com/iot/latest/developerguide/managing-fleet-index.html#managed-field">Managed fields</a> in the <i>Amazon Web Services IoT Core Developer Guide</i>.
      - `name` string — The name of the field.
      - `type` 'Number' | 'String' | 'Boolean' — The data type of the field.
    - `customFields` Field[] — <p>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.</p> <p>Contains custom field names and their data type.</p>
      - `name` string — The name of the field.
      - `type` 'Number' | 'String' | 'Boolean' — The data type of the field.

## Other responses

- `480` — InvalidRequestException
- `481` — ThrottlingException
- `482` — UnauthorizedException
- `483` — ServiceUnavailableException
- `484` — InternalFailureException

---

[API](https://skmtc.net/aws/apis/iot.md) · [All operations](https://skmtc.net/aws/apis/iot/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/iot/revisions/deef5c4b09f0/schema)