Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

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 ]

update-indexing-configuration

Description

Updates the search configuration.

Requires permission to access the UpdateIndexingConfiguration action.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  update-indexing-configuration
[--thing-indexing-configuration <value>]
[--thing-group-indexing-configuration <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--thing-indexing-configuration (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.

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

Shorthand Syntax:

thingIndexingMode=string,thingConnectivityIndexingMode=string,deviceDefenderIndexingMode=string,namedShadowIndexingMode=string,managedFields=[{name=string,type=string},{name=string,type=string}],customFields=[{name=string,type=string},{name=string,type=string}]

JSON Syntax:

{
  "thingIndexingMode": "OFF"|"REGISTRY"|"REGISTRY_AND_SHADOW",
  "thingConnectivityIndexingMode": "OFF"|"STATUS",
  "deviceDefenderIndexingMode": "OFF"|"VIOLATIONS",
  "namedShadowIndexingMode": "OFF"|"ON",
  "managedFields": [
    {
      "name": "string",
      "type": "Number"|"String"|"Boolean"
    }
    ...
  ],
  "customFields": [
    {
      "name": "string",
      "type": "Number"|"String"|"Boolean"
    }
    ...
  ]
}

--thing-group-indexing-configuration (structure)

Thing group indexing 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.

Shorthand Syntax:

thingGroupIndexingMode=string,managedFields=[{name=string,type=string},{name=string,type=string}],customFields=[{name=string,type=string},{name=string,type=string}]

JSON Syntax:

{
  "thingGroupIndexingMode": "OFF"|"ON",
  "managedFields": [
    {
      "name": "string",
      "type": "Number"|"String"|"Boolean"
    }
    ...
  ],
  "customFields": [
    {
      "name": "string",
      "type": "Number"|"String"|"Boolean"
    }
    ...
  ]
}

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

See 'aws help' for descriptions of global parameters.

Examples

To enable thing indexing

The following update-indexing-configuration example enables thing indexing to support searching registry data, shadow data, and thing connectivity status using the AWS_Things index.

aws iot update-indexing-configuration
    --thing-indexing-configuration thingIndexingMode=REGISTRY_AND_SHADOW,thingConnectivityIndexingMode=STATUS

This command produces no output.

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

Output

None