Skip to content

CreateGroupRequest

Source code in docs_src/capo_xray/types/create_group_request.py 
16
17
18
19
20
21
22
23
24
25
26
class CreateGroupRequest(TypedDict, closed=True):
    group_name: "capo_xray.types.group_name.GroupName"
    """<p>The case-sensitive name of the new group. Default is a reserved name and names must be unique.</p>"""
    filter_expression: NotRequired["capo_xray.types.filter_expression.FilterExpression"]
    """<p>The 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 new group or false to disable insights for the new group.</p> </li> <li> <p>The NotificationsEnabled boolean can be set to true to enable insights notifications for the new group. Notifications may only be enabled on a group with InsightsEnabled set to true.</p> </li> </ul>"""
    tags: NotRequired["capo_xray.types.tag_list.TagList"]
    """<p>A map that contains one or more tag keys and tag values to attach to an X-Ray group. For more information about ways to use tags, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services resources</a> in the <i>Amazon Web Services General Reference</i>.</p> <p>The following restrictions apply to tags:</p> <ul> <li> <p>Maximum number of user-applied tags per resource: 50</p> </li> <li> <p>Maximum tag key length: 128 Unicode characters</p> </li> <li> <p>Maximum tag value length: 256 Unicode characters</p> </li> <li> <p>Valid values for key and value: a-z, A-Z, 0-9, space, and the following characters: _ . : / = + - and @</p> </li> <li> <p>Tag keys and values are case sensitive.</p> </li> <li> <p>Don't use <code>aws:</code> as a prefix for keys; it's reserved for Amazon Web Services use.</p> </li> </ul>"""

filter_expression instance-attribute 

filter_expression: NotRequired[FilterExpression]

The filter expression defining criteria by which to group traces.

group_name instance-attribute 

group_name: GroupName

The case-sensitive name of the new group. Default is a reserved name and names must be unique.

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 new group or false to disable insights for the new group.

  • The NotificationsEnabled boolean can be set to true to enable insights notifications for the new group. Notifications may only be enabled on a group with InsightsEnabled set to true.

tags instance-attribute 

tags: NotRequired[TagList]

A map that contains one or more tag keys and tag values to attach to an X-Ray group. For more information about ways to use tags, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference.

The following restrictions apply to tags:

  • Maximum number of user-applied tags per resource: 50

  • Maximum tag key length: 128 Unicode characters

  • Maximum tag value length: 256 Unicode characters

  • Valid values for key and value: a-z, A-Z, 0-9, space, and the following characters: _ . : / = + - and @

  • Tag keys and values are case sensitive.

  • Don't use aws: as a prefix for keys; it's reserved for Amazon Web Services use.