[ aws . iot ]

get-indexing-configuration

Description

Gets the indexing configuration.

Requires permission to access the GetIndexingConfiguration action.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  get-indexing-configuration
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Examples

To get the thing indexing configuration

The following get-indexing-configuration example gets the current configuration data for AWS IoT fleet indexing.

aws iot get-indexing-configuration

Output:

{
    "thingIndexingConfiguration": {
        "thingIndexingMode": "OFF",
        "thingConnectivityIndexingMode": "OFF"
    },
    "thingGroupIndexingConfiguration": {
        "thingGroupIndexingMode": "OFF"
    }
}

For more information, see Managing Thing Indexing in the AWS IoT Developers Guide.

Output

thingIndexingConfiguration -> (structure)

Thing indexing configuration.

thingIndexingMode -> (string)

Thing indexing mode. Valid values are:

• REGISTRY – Your thing index contains registry data only.

• REGISTRY_AND_SHADOW - Your thing index contains registry and shadow data.

• OFF - Thing indexing is disabled.

thingConnectivityIndexingMode -> (string)

Thing connectivity indexing mode. Valid values are:

• STATUS – Your thing index contains connectivity status. To enable thing connectivity indexing, thingIndexMode must not be set to OFF.

• OFF - Thing connectivity status indexing is disabled.

managedFields -> (list)

Contains fields that are indexed and whose types are already known by the Fleet Indexing service.

(structure)

Describes the name and data type at a field.

name -> (string)

The name of the field.

type -> (string)

The data type of the field.

customFields -> (list)

Contains custom field names and their data type.

(structure)

Describes the name and data type at a field.

name -> (string)

The name of the field.

type -> (string)

The data type of the field.

thingGroupIndexingConfiguration -> (structure)

The index configuration.

thingGroupIndexingMode -> (string)

Thing group indexing mode.

managedFields -> (list)

Contains fields that are indexed and whose types are already known by the Fleet Indexing service.

(structure)

Describes the name and data type at a field.

name -> (string)

The name of the field.

type -> (string)

The data type of the field.

customFields -> (list)

A list of thing group fields to index. This list cannot contain any managed fields. Use the GetIndexingConfiguration API to get a list of managed fields.

Contains custom field names and their data type.

(structure)

Describes the name and data type at a field.

name -> (string)

The name of the field.

type -> (string)

The data type of the field.