Amazon IoT Device Management · Schema
DescribeIndexResponse
DescribeIndexResponse schema
Device ManagementFleet ManagementIoTOTA Updates
Properties
| Name | Type | Description |
|---|---|---|
| indexName | object | |
| indexStatus | object | |
| schema | object |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/api-evangelist/amazon-iot-device-management/refs/heads/main/json-schema/iot-device-management-describe-index-response-schema.json",
"title": "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>"
}
]
}
}
}