Skip to content

UpdateGroupRequest

Source code in docs_src/capo_xray/types/update_group_request.py
class UpdateGroupRequest(TypedDict, closed=True):
    group_name: NotRequired["capo_xray.types.group_name.GroupName"]
    """<p>The case-sensitive name of the group.</p>"""
    group_arn: NotRequired["capo_xray.types.group_arn.GroupARN"]
    """<p>The ARN that was generated upon creation.</p>"""
    filter_expression: NotRequired["capo_xray.types.filter_expression.FilterExpression"]
    """<p>The updated filter expression defining criteria by which to group 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 for the group. Notifications can only be enabled on a group with InsightsEnabled set to true.</p> </li> </ul>"""

filter_expression instance-attribute

filter_expression: NotRequired[FilterExpression]

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

group_arn instance-attribute

group_arn: NotRequired[GroupARN]

The ARN that was generated upon creation.

group_name instance-attribute

group_name: NotRequired[GroupName]

The 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 for the group. Notifications can only be enabled on a group with InsightsEnabled set to true.