Get Indexing Rules

xray_get_indexing_rules

R Documentation

Retrieves all indexing rules¶

Description¶

Retrieves all indexing rules.

Indexing rules are used to determine the server-side sampling rate for spans ingested through the CloudWatchLogs destination and indexed by X-Ray. For more information, see Transaction Search.

Usage¶

xray_get_indexing_rules(NextToken)

Arguments¶

NextToken: Specify the pagination token returned by a previous request to retrieve the next page of indexes.

Value¶

A list with the following syntax:

list(
  IndexingRules = list(
    list(
      Name = "string",
      ModifiedAt = as.POSIXct(
        "2015-01-01"
      ),
      Rule = list(
        Probabilistic = list(
          DesiredSamplingPercentage = 123.0,
          ActualSamplingPercentage = 123.0
        )
      )
    )
  ),
  NextToken = "string"
)

Request syntax¶

svc$get_indexing_rules(
  NextToken = "string"
)