/indices/{indexName}

The AWS IoT Wireless multi-region endpoint

https://api.iotwireless.{region}.amazonaws.com

GET

Describes a search index.

Requires permission to access the DescribeIndex action.

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request GET 'https://api.iotwireless.{region}.amazonaws.com/indices/'

Response Example

200 - Example 1

{
    "indexName": "string",
    "indexStatus": "ACTIVE",
    "schema": "string"
}

Request

Path Params

indexName

string

required

The index name.

Responses

🟢200Success

application/json

Body

indexName

string

optional

The index name.

>= 1 characters<= 128 characters

Match pattern:

[a-zA-Z0-9:_-]+

indexStatus

enum<string>

optional

The index status.

Allowed values:

ACTIVEBUILDINGREBUILDING

schema

string

optional

Contains a value that specifies the type of indexing performed. Valid values are:

REGISTRY – Your thing index contains only registry data.
REGISTRY_AND_SHADOW - Your thing index contains registry data and shadow data.
REGISTRY_AND_CONNECTIVITY_STATUS - Your thing index contains registry data and thing connectivity status data.
REGISTRY_AND_SHADOW_AND_CONNECTIVITY_STATUS - Your thing index contains registry data, shadow data, and thing connectivity status data.

🟠480InvalidRequestException

🟠481ThrottlingException

🟠482UnauthorizedException

🟠483ServiceUnavailableException

🟠484InternalFailureException

🟠485ResourceNotFoundException

Modified at 2022-09-10 23:12:16

/event-configurations

/things/{thingName}/jobs/{jobId}