[ aws . iot ]

search-index

Description

The query search index.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  search-index
[--index-name <value>]
--query-string <value>
[--next-token <value>]
[--max-results <value>]
[--query-version <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options

--index-name (string)

The search index name.

--query-string (string)

The search query string.

--next-token (string)

The token used to get the next set of results, or null if there are no additional results.

--max-results (integer)

The maximum number of results to return at one time.

--query-version (string)

The query version.

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

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Examples

To query the thing index

The following search-index example queries the AWS_Things index for things that have a type of LightBulb.

aws iot search-index \
    --index-name "AWS_Things" \
    --query-string "thingTypeName:LightBulb"

Output:

{
    "things": [
        {
            "thingName": "MyLightBulb",
            "thingId": "40da2e73-c6af-406e-b415-15acae538797",
            "thingTypeName": "LightBulb",
            "thingGroupNames": [
                "LightBulbs",
                "DeadBulbs"
            ],
            "attributes": {
                "model": "123",
                "wattage": "75"
            },
            "connectivity": {
                "connected": false
            }
        },
        {
            "thingName": "ThirdBulb",
            "thingId": "615c8455-33d5-40e8-95fd-3ee8b24490af",
            "thingTypeName": "LightBulb",
            "attributes": {
                "model": "123",
                "wattage": "75"
            },
            "connectivity": {
                "connected": false
            }
        },
        {
            "thingName": "MyOtherLightBulb",
            "thingId": "6dae0d3f-40c1-476a-80c4-1ed24ba6aa11",
            "thingTypeName": "LightBulb",
            "attributes": {
                "model": "123",
                "wattage": "75"
            },
            "connectivity": {
                "connected": false
            }
        }
    ]
}

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

Output

nextToken -> (string)

The token used to get the next set of results, or null if there are no additional results.

things -> (list)

The things that match the search query.

(structure)

The thing search index document.

thingName -> (string)

The thing name.

thingId -> (string)

The thing ID.

thingTypeName -> (string)

The thing type name.

thingGroupNames -> (list)

Thing group names.

(string)

attributes -> (map)

The attributes.

key -> (string)

value -> (string)

shadow -> (string)

The shadow.

connectivity -> (structure)

Indicates whether the thing is connected to the AWS IoT service.

connected -> (boolean)

True if the thing is connected to the AWS IoT service; false if it is not connected.

timestamp -> (long)

The epoch time (in milliseconds) when the thing last connected or disconnected. If the thing has been disconnected for more than a few weeks, the time value might be missing.

thingGroups -> (list)

The thing groups that match the search query.

(structure)

The thing group search index document.

thingGroupName -> (string)

The thing group name.

thingGroupId -> (string)

The thing group ID.

thingGroupDescription -> (string)

The thing group description.

attributes -> (map)

The thing group attributes.

key -> (string)

value -> (string)

parentGroupNames -> (list)

Parent group names.

(string)