Class: Aws::XRay::Types::UpdateGroupRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-xray/types.rb

Overview

Note:

When making an API call, you may pass UpdateGroupRequest data as a hash:

{
  group_name: "GroupName",
  group_arn: "GroupARN",
  filter_expression: "FilterExpression",
  insights_configuration: {
    insights_enabled: false,
    notifications_enabled: false,
  },
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#filter_expressionString

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

Returns:

  • (String)

3456
3457
3458
3459
3460
3461
3462
3463
# File 'lib/aws-sdk-xray/types.rb', line 3456

class UpdateGroupRequest < Struct.new(
  :group_name,
  :group_arn,
  :filter_expression,
  :insights_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#group_arnString

The ARN that was generated upon creation.

Returns:

  • (String)

3456
3457
3458
3459
3460
3461
3462
3463
# File 'lib/aws-sdk-xray/types.rb', line 3456

class UpdateGroupRequest < Struct.new(
  :group_name,
  :group_arn,
  :filter_expression,
  :insights_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#group_nameString

The case-sensitive name of the group.

Returns:

  • (String)

3456
3457
3458
3459
3460
3461
3462
3463
# File 'lib/aws-sdk-xray/types.rb', line 3456

class UpdateGroupRequest < Struct.new(
  :group_name,
  :group_arn,
  :filter_expression,
  :insights_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#insights_configurationTypes::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 NotifcationsEnabled 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.


3456
3457
3458
3459
3460
3461
3462
3463
# File 'lib/aws-sdk-xray/types.rb', line 3456

class UpdateGroupRequest < Struct.new(
  :group_name,
  :group_arn,
  :filter_expression,
  :insights_configuration)
  SENSITIVE = []
  include Aws::Structure
end