DescribeIndexResponse is a JSON Structure definition published by Amazon IoT Core, describing 3 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.
{
"$schema": "https://json-structure.org/meta/core/v0/#",
"$id": "https://raw.githubusercontent.com/api-evangelist/amazon-iot-core/refs/heads/main/json-structure/iot-core-describe-index-response-structure.json",
"name": "DescribeIndexResponse",
"description": "DescribeIndexResponse schema",
"type": "object",
"properties": {
"indexName": {
"allOf": [
{
"$ref": "#/components/schemas/IndexName"
},
{
"description": "The index name."
}
]
},
"indexStatus": {
"allOf": [
{
"$ref": "#/components/schemas/IndexStatus"
},
{
"description": "The index status."
}
]
},
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/IndexSchema"
},
{
"description": "<p>Contains a value that specifies the type of indexing performed. Valid values are:</p> <ul> <li> <p>REGISTRY \u2013 Your thing index contains only registry data.</p> </li> <li> <p>REGISTRY_AND_SHADOW - Your thing index contains registry data and shadow data.</p> </li> <li> <p>REGISTRY_AND_CONNECTIVITY_STATUS - Your thing index contains registry data and thing connectivity status data.</p> </li> <li> <p>REGISTRY_AND_SHADOW_AND_CONNECTIVITY_STATUS - Your thing index contains registry data, shadow data, and thing connectivity status data.</p> </li> <li> <p>MULTI_INDEXING_MODE - Your thing index contains multiple data sources. For more information, see <a href=\"https://docs.aws.amazon.com/iot/latest/apireference/API_GetIndexingConfiguration.html\">GetIndexingConfiguration</a>.</p> </li> </ul>"
}
]
}
}
}
Discovery needs no key. Ratings and market analysis are Pro.
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.