Skip to content

Updates a group resource

Description

Updates a group resource.

Usage

xray_update_group(GroupName, GroupARN, FilterExpression,
  InsightsConfiguration)

Arguments

  • GroupName

    The case-sensitive name of the group.

  • GroupARN

    The ARN that was generated upon creation.

  • FilterExpression

    The updated filter expression defining criteria by which to group traces.

  • InsightsConfiguration

    The structure containing configurations related to insights.

    • The InsightsEnabled boolean can be set to true to enable insights for the group or false to disable insights for the group.
    • The NotificationsEnabled boolean can be set to true to enable insights notifications for the group. Notifications can only be enabled on a group with InsightsEnabled set to true.

Value

A list with the following syntax:

list(
  Group = list(
    GroupName = "string",
    GroupARN = "string",
    FilterExpression = "string",
    InsightsConfiguration = list(
      InsightsEnabled = TRUE|FALSE,
      NotificationsEnabled = TRUE|FALSE
    )
  )
)

Request syntax

svc$update_group(
  GroupName = "string",
  GroupARN = "string",
  FilterExpression = "string",
  InsightsConfiguration = list(
    InsightsEnabled = TRUE|FALSE,
    NotificationsEnabled = TRUE|FALSE
  )
)