Skip to content

/AWS1/CL_IOTDESCRINDEXRESPONSE

DescribeIndexResponse

CONSTRUCTOR

IMPORTING

Optional arguments:

IV_INDEXNAME TYPE /AWS1/IOTINDEXNAME /AWS1/IOTINDEXNAME

The index name.

IV_INDEXSTATUS TYPE /AWS1/IOTINDEXSTATUS /AWS1/IOTINDEXSTATUS

The index status.

IV_SCHEMA TYPE /AWS1/IOTINDEXSCHEMA /AWS1/IOTINDEXSCHEMA

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.

  • MULTI_INDEXING_MODE - Your thing index contains multiple data sources. For more information, see GetIndexingConfiguration.

Queryable Attributes

indexName

The index name.

Accessible with the following methods

Method Description
GET_INDEXNAME() Getter for INDEXNAME, with configurable default
ASK_INDEXNAME() Getter for INDEXNAME w/ exceptions if field has no value
HAS_INDEXNAME() Determine if INDEXNAME has a value

indexStatus

The index status.

Accessible with the following methods

Method Description
GET_INDEXSTATUS() Getter for INDEXSTATUS, with configurable default
ASK_INDEXSTATUS() Getter for INDEXSTATUS w/ exceptions if field has no value
HAS_INDEXSTATUS() Determine if INDEXSTATUS has a value

schema

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.

  • MULTI_INDEXING_MODE - Your thing index contains multiple data sources. For more information, see GetIndexingConfiguration.

Accessible with the following methods

Method Description
GET_SCHEMA() Getter for SCHEMA, with configurable default
ASK_SCHEMA() Getter for SCHEMA w/ exceptions if field has no value
HAS_SCHEMA() Determine if SCHEMA has a value