Skip to content

Describe Field Indexes

cloudwatchlogs_describe_field_indexes R Documentation

Returns a list of custom and default field indexes which are discovered in log data

Description

Returns a list of custom and default field indexes which are discovered in log data. For more information about field index policies, see put_index_policy.

Usage

cloudwatchlogs_describe_field_indexes(logGroupIdentifiers, nextToken)

Arguments

logGroupIdentifiers

[required] An array containing the names or ARNs of the log groups that you want to retrieve field indexes for.

nextToken

The token for the next set of items to return. The token expires after 24 hours.

Value

A list with the following syntax:

list(
  fieldIndexes = list(
    list(
      logGroupIdentifier = "string",
      fieldIndexName = "string",
      lastScanTime = 123,
      firstEventTime = 123,
      lastEventTime = 123,
      type = "FACET"|"FIELD_INDEX"
    )
  ),
  nextToken = "string"
)

Request syntax

svc$describe_field_indexes(
  logGroupIdentifiers = list(
    "string"
  ),
  nextToken = "string"
)