Skip to content

Group

Source code in docs_src/capo_xray/types/group.py 
12
13
14
15
16
17
18
19
20
21
22
class Group(TypedDict, closed=True):
    group_name: NotRequired["capo_xray.types.string.String"]
    """<p>The unique case-sensitive name of the group.</p>"""
    group_arn: NotRequired["capo_xray.types.string.String"]
    """<p>The Amazon Resource Name (ARN) of the group generated based on the GroupName.</p>"""
    filter_expression: NotRequired["capo_xray.types.string.String"]
    """<p>The filter expression defining the parameters to include traces.</p>"""
    insights_configuration: NotRequired[
        "capo_xray.types.insights_configuration.InsightsConfiguration"
    ]
    """<p>The structure containing configurations related to insights.</p> <ul> <li> <p>The InsightsEnabled boolean can be set to true to enable insights for the group or false to disable insights for the group.</p> </li> <li> <p>The NotificationsEnabled boolean can be set to true to enable insights notifications through Amazon EventBridge for the group.</p> </li> </ul>"""

filter_expression instance-attribute 

filter_expression: NotRequired[String]

The filter expression defining the parameters to include traces.

group_arn instance-attribute 

group_arn: NotRequired[String]

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

group_name instance-attribute 

group_name: NotRequired[String]

The unique case-sensitive name of the group.

insights_configuration instance-attribute 

insights_configuration: NotRequired[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.