Skip to content

Update Indexing Rule

xray_update_indexing_rule R Documentation

Modifies an indexing rule’s configuration

Description

Modifies an indexing rule’s configuration.

Indexing rules are used for determining the sampling rate for spans indexed from CloudWatch Logs. For more information, see Transaction Search.

Usage

xray_update_indexing_rule(Name, Rule)

Arguments

Name

[required] Name of the indexing rule to be updated.

Rule

[required] Rule configuration to be updated.

Value

A list with the following syntax:

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

Request syntax

svc$update_indexing_rule(
  Name = "string",
  Rule = list(
    Probabilistic = list(
      DesiredSamplingPercentage = 123.0
    )
  )
)