Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . iot ]

get-indexing-configuration¶

Description¶

Gets the indexing configuration.

Requires permission to access the GetIndexingConfiguration action.

Synopsis¶

  get-indexing-configuration
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options¶

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options¶

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

json
text
table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

on
off
auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Examples¶

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal's quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

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.

deviceDefenderIndexingMode -> (string)

Device Defender indexing mode. Valid values are:

VIOLATIONS – Your thing index contains Device Defender violations. To enable Device Defender indexing, deviceDefenderIndexingMode must not be set to OFF.

OFF - Device Defender indexing is disabled.

For more information about Device Defender violations, see Device Defender Detect.

namedShadowIndexingMode -> (string)

Named shadow indexing mode. Valid values are:

ON – Your thing index contains named shadow. To enable thing named shadow indexing, namedShadowIndexingMode must not be set to OFF.

OFF - Named shadow indexing is disabled.

For more information about Shadows, see IoT Device Shadow service.

managedFields -> (list)

Contains fields that are indexed and whose types are already known by the Fleet Indexing service. This is an optional field. For more information, see Managed fields in the Amazon Web Services IoT Core Developer Guide .

Note
You can't modify managed fields by updating fleet indexing configuration.

(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.

filter -> (structure)

Provides additional selections for named shadows and geolocation data.

To add named shadows to your fleet indexing configuration, set namedShadowIndexingMode to be ON and specify your shadow names in namedShadowNames filter.

To add geolocation data to your fleet indexing configuration:

If you store geolocation data in a class/unnamed shadow, set thingIndexingMode to be REGISTRY_AND_SHADOW and specify your geolocation data in geoLocations filter.

If you store geolocation data in a named shadow, set namedShadowIndexingMode to be ON , add the shadow name in namedShadowNames filter, and specify your geolocation data in geoLocations filter. For more information, see Managing fleet indexing .

namedShadowNames -> (list)

The shadow names that you select to index. The default maximum number of shadow names for indexing is 10. To increase the limit, see Amazon Web Services IoT Device Management Quotas in the Amazon Web Services General Reference .

(string)

geoLocations -> (list)

The list of geolocation targets that you select to index. The default maximum number of geolocation targets for indexing is 1 . To increase the limit, see Amazon Web Services IoT Device Management Quotas in the Amazon Web Services General Reference .

(structure)

A geolocation target that you select to index. Each geolocation target contains a name and order key-value pair that specifies the geolocation target fields.

name -> (string)

The name of the geolocation target field. If the target field is part of a named shadow, you must select the named shadow using the namedShadow filter.

order -> (string)

The order of the geolocation target field. This field is optional. The default value is LatLon .

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. This is an optional field. For more information, see Managed fields in the Amazon Web Services IoT Core Developer Guide .

Note
You can't modify managed fields by updating fleet indexing configuration.

(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.

Table Of Contents

Feedback

User Guide

Note:

get-indexing-configuration¶

Description¶

Synopsis¶

Options¶

Global Options¶

Examples¶

Note

Output¶

Note

Note