Menu
AWS IoT
Developer Guide

ListIndices

Lists the search indices.

Request syntax:

GET /indices?nextToken=nextToken&maxResults=maxResults

URI Request Parameters:

Name

Type

Req?

Description

nextToken

NextToken

no

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

maxResults

QueryMaxResults

no

The maximum number of results to return at one time.

Response syntax:

Content-type: application/json { "indexNames": [ "string" ], "nextToken": "string" }

Response Body Parameters:

Name

Type

Req?

Description

indexNames

IndexNamesList

no

The index names.

nextToken

NextToken

no

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

Errors:

InvalidRequestException

The contents of the request were invalid. For example, this code is returned when an UpdateJobExecution request contains invalid status details. The message contains details about the error.

HTTP response code: 400

ThrottlingException

The rate exceeds the limit.

HTTP response code: 429

UnauthorizedException

You are not authorized to perform this operation.

HTTP response code: 401

ServiceUnavailableException

The service is temporarily unavailable.

HTTP response code: 503

InternalFailureException

An unexpected error has occurred.

HTTP response code: 500

CLI

Synopsis:

aws iot list-indices \ [--next-token <value>] \ [--max-results <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

cli-input-json format:

{ "nextToken": "string", "maxResults": "integer" }

cli-input-json fields:

Name

Type

Description

nextToken

string

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

maxResults

integer

java class: java.lang.Integer

range- max:500 min:1

The maximum number of results to return at one time.

Output:

{ "indexNames": [ "string" ], "nextToken": "string" }

cli output fields:

Name

Type

Description

indexNames

list

member: IndexName

java class: java.util.List

The index names.

IndexName

string

length max:128 min:1

pattern: [a-zA-Z0-9:_-]+

nextToken

string

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

On this page: