Skip to main content

indices

Creates, updates, deletes, gets or lists an indices resource.

Overview​

Nameindices
TypeResource
Idaws.iot.indices

Fields​

The following fields are returned by SELECT queries:

NameDatatypeDescription
index_namestringThe index names.

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
list_indicesselectregionnextToken, maxResultsLists the search indices. Requires permission to access the ListIndices action.

Parameters​

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
regionstringAWS region (default: us-east-1)
maxResultsintegerThe maximum number of results to return at one time.
nextTokenstringThe token used to get the next set of results, or null if there are no additional results.

SELECT examples​

Lists the search indices. Requires permission to access the ListIndices action.

SELECT
index_name
FROM aws.iot.indices
WHERE region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
;