Group - Amazon X-Ray
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

Group

Details and metadata for a group.

Contents

FilterExpression

The filter expression defining the parameters to include traces.

Type: String

Required: No

GroupARN

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

Type: String

Required: No

GroupName

The unique case-sensitive name of the group.

Type: String

Required: No

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

Type: InsightsConfiguration object

Required: No

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: