IoT / Client / list_indices

list_indices#

IoT.Client.list_indices(**kwargs)#

Lists the search indices.

Requires permission to access the ListIndices action.

See also: AWS API Documentation

Request Syntax

response = client.list_indices(
    nextToken='string',
    maxResults=123
)
Parameters:

  • nextToken (string) – The token used to get the next set of results, or null if there are no additional results.

  • maxResults (integer) – The maximum number of results to return at one time.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    • indexNames (list) –

      The index names.

      • (string) –

    • nextToken (string) –

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

Exceptions

  • IoT.Client.exceptions.InvalidRequestException

  • IoT.Client.exceptions.ThrottlingException

  • IoT.Client.exceptions.UnauthorizedException

  • IoT.Client.exceptions.ServiceUnavailableException

  • IoT.Client.exceptions.InternalFailureException