field_indexes

Creates, updates, deletes, gets or lists a field_indexes resource.

Overview

Name	field_indexes
Type	Resource
Id	aws.logs.field_indexes

Fields

The following fields are returned by SELECT queries:

describe_field_indexes

Name	Datatype	Description
field_indexes	array	An array containing the field index information.
next_token	string	The token for the next set of items to return. The token expires after 24 hours.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_field_indexes	select	region		Returns a list of field indexes discovered in log data. By default, the response includes the DEFAULT, CUSTOM, and INACTIVE index categories. To return indexes from other categories, use the indexCategories parameter. For more information about field index policies, see PutIndexPolicy.

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

describe_field_indexes

Returns a list of field indexes discovered in log data. By default, the response includes the DEFAULT, CUSTOM, and INACTIVE index categories. To return indexes from other categories, use the indexCategories parameter. For more information about field index policies, see PutIndexPolicy.

SELECT
field_indexes,
next_token
FROM aws.logs.field_indexes
WHERE region = '{{ region }}' -- required
;