update_group

XRay.Client.update_group(**kwargs)

Updates a group resource.

See also: AWS API Documentation

Request Syntax

response = client.update_group(
    GroupName='string',
    GroupARN='string',
    FilterExpression='string',
    InsightsConfiguration={
        'InsightsEnabled': True|False,
        'NotificationsEnabled': True|False
    }
)

Parameters

• GroupName (string) -- The case-sensitive name of the group.
• GroupARN (string) -- The ARN that was generated upon creation.
• FilterExpression (string) -- The updated filter expression defining criteria by which to group traces.
• InsightsConfiguration (dict) --

  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.
  • InsightsEnabled (boolean) --

    Set the InsightsEnabled value to true to enable insights or false to disable insights.

  • NotificationsEnabled (boolean) --

    Set the NotificationsEnabled value to true to enable insights notifications. Notifications can only be enabled on a group with InsightsEnabled set to true.

Return type

dict

Returns

Response Syntax

{
    'Group': {
        'GroupName': 'string',
        'GroupARN': 'string',
        'FilterExpression': 'string',
        'InsightsConfiguration': {
            'InsightsEnabled': True|False,
            'NotificationsEnabled': True|False
        }
    }
}

Response Structure

• (dict) --

  • Group (dict) --

    The group that was updated. Contains the name of the group that was updated, the ARN of the group that was updated, the updated filter expression, and the updated insight configuration assigned to the group.

    • GroupName (string) --

      The unique case-sensitive name of the group.

    • GroupARN (string) --

      The Amazon Resource Name (ARN) of the group generated based on the GroupName.

    • FilterExpression (string) --

      The filter expression defining the parameters to include traces.

    • InsightsConfiguration (dict) --

      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 through Amazon EventBridge for the group.

      • InsightsEnabled (boolean) --

        Set the InsightsEnabled value to true to enable insights or false to disable insights.

      • NotificationsEnabled (boolean) --

        Set the NotificationsEnabled value to true to enable insights notifications. Notifications can only be enabled on a group with InsightsEnabled set to true.

Exceptions

• XRay.Client.exceptions.InvalidRequestException
• XRay.Client.exceptions.ThrottledException