{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/amazon-iot-device-management/json-schema/amazon-iot-device-management-get-indexing-configuration-response-schema.json",
  "title": "GetIndexingConfigurationResponse",
  "x-generated": "2026-11-11",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/amazon-iot-device-management-indexing-api-openapi.yml#/components/schemas/GetIndexingConfigurationResponse",
  "type": "object",
  "properties": {
    "thingIndexingConfiguration": {
      "allOf": [
        {
          "$ref": "#/$defs/ThingIndexingConfiguration"
        },
        {
          "description": "Thing indexing configuration."
        }
      ]
    },
    "thingGroupIndexingConfiguration": {
      "allOf": [
        {
          "$ref": "#/$defs/ThingGroupIndexingConfiguration"
        },
        {
          "description": "The index configuration."
        }
      ]
    }
  },
  "$defs": {
    "DeviceDefenderIndexingMode": {
      "type": "string",
      "enum": [
        "OFF",
        "VIOLATIONS"
      ]
    },
    "Field": {
      "type": "object",
      "properties": {
        "name": {
          "allOf": [
            {
              "$ref": "#/$defs/FieldName"
            },
            {
              "description": "The name of the field."
            }
          ]
        },
        "type": {
          "allOf": [
            {
              "$ref": "#/$defs/FieldType"
            },
            {
              "description": "The data type of the field."
            }
          ]
        }
      },
      "description": "Describes the name and data type at a field."
    },
    "FieldName": {
      "type": "string"
    },
    "FieldType": {
      "type": "string",
      "enum": [
        "Number",
        "String",
        "Boolean"
      ]
    },
    "Fields": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/Field"
      }
    },
    "IndexingFilter": {
      "type": "object",
      "properties": {
        "namedShadowNames": {
          "allOf": [
            {
              "$ref": "#/$defs/NamedShadowNamesFilter"
            },
            {
              "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 <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>. "
            }
          ]
        }
      },
      "description": "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>."
    },
    "NamedShadowIndexingMode": {
      "type": "string",
      "enum": [
        "OFF",
        "ON"
      ]
    },
    "NamedShadowNamesFilter": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/ShadowName"
      }
    },
    "ShadowName": {
      "type": "string",
      "pattern": "[a-zA-Z0-9:_-]+",
      "minLength": 1,
      "maxLength": 64
    },
    "ThingConnectivityIndexingMode": {
      "type": "string",
      "enum": [
        "OFF",
        "STATUS"
      ]
    },
    "ThingGroupIndexingConfiguration": {
      "type": "object",
      "required": [
        "thingGroupIndexingMode"
      ],
      "properties": {
        "thingGroupIndexingMode": {
          "allOf": [
            {
              "$ref": "#/$defs/ThingGroupIndexingMode"
            },
            {
              "description": "Thing group indexing mode."
            }
          ]
        },
        "managedFields": {
          "allOf": [
            {
              "$ref": "#/$defs/Fields"
            },
            {
              "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 <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>."
            }
          ]
        },
        "customFields": {
          "allOf": [
            {
              "$ref": "#/$defs/Fields"
            },
            {
              "description": "<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>"
            }
          ]
        }
      },
      "description": "Thing group indexing configuration."
    },
    "ThingGroupIndexingMode": {
      "type": "string",
      "enum": [
        "OFF",
        "ON"
      ]
    },
    "ThingIndexingConfiguration": {
      "type": "object",
      "required": [
        "thingIndexingMode"
      ],
      "properties": {
        "thingIndexingMode": {
          "allOf": [
            {
              "$ref": "#/$defs/ThingIndexingMode"
            },
            {
              "description": "<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": {
          "allOf": [
            {
              "$ref": "#/$defs/ThingConnectivityIndexingMode"
            },
            {
              "description": "<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": {
          "allOf": [
            {
              "$ref": "#/$defs/DeviceDefenderIndexingMode"
            },
            {
              "description": "<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": {
          "allOf": [
            {
              "$ref": "#/$defs/NamedShadowIndexingMode"
            },
            {
              "description": "<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": {
          "allOf": [
            {
              "$ref": "#/$defs/Fields"
            },
            {
              "description": "Contains fields that are indexed and whose types are already known by the Fleet Indexing service."
            }
          ]
        },
        "customFields": {
          "allOf": [
            {
              "$ref": "#/$defs/Fields"
            },
            {
              "description": "Contains custom field names and their data type."
            }
          ]
        },
        "filter": {
          "allOf": [
            {
              "$ref": "#/$defs/IndexingFilter"
            },
            {
              "description": "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>."
            }
          ]
        }
      },
      "description": "The thing indexing configuration. For more information, see <a href=\"https://docs.aws.amazon.com/iot/latest/developerguide/managing-index.html\">Managing Thing Indexing</a>."
    },
    "ThingIndexingMode": {
      "type": "string",
      "enum": [
        "OFF",
        "REGISTRY",
        "REGISTRY_AND_SHADOW"
      ]
    }
  }
}