indexing_configurations
Creates, updates, deletes, gets or lists an indexing_configurations resource.
Overview
| Name | indexing_configurations |
| Type | Resource |
| Id | aws.iot.indexing_configurations |
Fields
The following fields are returned by SELECT queries:
- get_indexing_configuration
| Name | Datatype | Description |
|---|---|---|
thing_group_indexing_configuration | object | The index configuration. |
thing_indexing_configuration | object | Thing indexing configuration. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get_indexing_configuration | select | region | Gets the indexing configuration. Requires permission to access the GetIndexingConfiguration action. | |
update_indexing_configuration | update | region | Updates the search configuration. Requires permission to access the UpdateIndexingConfiguration 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.
| Name | Datatype | Description |
|---|---|---|
region | string | AWS region (default: us-east-1) |
SELECT examples
- get_indexing_configuration
Gets the indexing configuration. Requires permission to access the GetIndexingConfiguration action.
SELECT
thing_group_indexing_configuration,
thing_indexing_configuration
FROM aws.iot.indexing_configurations
WHERE region = '{{ region }}' -- required
;
UPDATE examples
- update_indexing_configuration
Updates the search configuration. Requires permission to access the UpdateIndexingConfiguration action.
UPDATE aws.iot.indexing_configurations
SET
thingIndexingConfiguration = '{{ thingIndexingConfiguration }}',
thingGroupIndexingConfiguration = '{{ thingGroupIndexingConfiguration }}'
WHERE
region = '{{ region }}' --required;