Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

GetIndexingConfiguration

Gets the indexing configuration.

Requires permission to access the GetIndexingConfiguration action.

Request Syntax


GET /indexing/config HTTP/1.1

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "thingGroupIndexingConfiguration": { 
      "customFields": [ 
         { 
            "name": "string",
            "type": "string"
         }
      ],
      "managedFields": [ 
         { 
            "name": "string",
            "type": "string"
         }
      ],
      "thingGroupIndexingMode": "string"
   },
   "thingIndexingConfiguration": { 
      "customFields": [ 
         { 
            "name": "string",
            "type": "string"
         }
      ],
      "deviceDefenderIndexingMode": "string",
      "filter": { 
         "geoLocations": [ 
            { 
               "name": "string",
               "order": "string"
            }
         ],
         "namedShadowNames": [ "string" ]
      },
      "managedFields": [ 
         { 
            "name": "string",
            "type": "string"
         }
      ],
      "namedShadowIndexingMode": "string",
      "thingConnectivityIndexingMode": "string",
      "thingIndexingMode": "string"
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

thingGroupIndexingConfiguration

The index configuration.

Type: ThingGroupIndexingConfiguration object

thingIndexingConfiguration

Thing indexing configuration.

Type: ThingIndexingConfiguration object

Errors

InternalFailureException

An unexpected error has occurred.

HTTP Status Code: 500

InvalidRequestException

The request is not valid.

HTTP Status Code: 400

ServiceUnavailableException

The service is temporarily unavailable.

HTTP Status Code: 503

ThrottlingException

The rate exceeds the limit.

HTTP Status Code: 400

UnauthorizedException

You are not authorized to perform this operation.

HTTP Status Code: 401