XRay / Client / create_group

create_group#

XRay.Client.create_group(**kwargs)#

Creates a group resource with a name and a filter expression.

See also: AWS API Documentation

Request Syntax

response = client.create_group(
    GroupName='string',
    FilterExpression='string',
    InsightsConfiguration={
        'InsightsEnabled': True|False,
        'NotificationsEnabled': True|False
    },
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
Parameters:

  • GroupName (string) –

    [REQUIRED]

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

  • FilterExpression (string) – The filter expression defining criteria by which to group traces.

  • InsightsConfiguration (dict) –

    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.

    • InsightsEnabled (boolean) –

      Set the InsightsEnabled value to true to enable insights or false to disable insights.

    • NotificationsEnabled (boolean) –

      Set the NotificationsEnabled value to true to enable insights notifications. Notifications can only be enabled on a group with InsightsEnabled set to true.

  • Tags (list) –

    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.

    • (dict) –

      A map that contains tag keys and tag values to attach to an Amazon Web Services X-Ray group or sampling rule. 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

      • Tag keys and values are case sensitive.

      • Don’t use aws: as a prefix for keys; it’s reserved for Amazon Web Services use. You cannot edit or delete system tags.

      • Key (string) – [REQUIRED]

        A tag key, such as Stage or Name. A tag key cannot be empty. The key can be a maximum of 128 characters, and can contain only Unicode letters, numbers, or separators, or the following special characters: + - = . _ : /

      • Value (string) – [REQUIRED]

        An optional tag value, such as Production or test-only. The value can be a maximum of 255 characters, and contain only Unicode letters, numbers, or separators, or the following special characters: + - = . _ : /

Return type:

dict

Returns:

Response Syntax

{
    'Group': {
        'GroupName': 'string',
        'GroupARN': 'string',
        'FilterExpression': 'string',
        'InsightsConfiguration': {
            'InsightsEnabled': True|False,
            'NotificationsEnabled': True|False
        }
    }
}

Response Structure

  • (dict) –

    • Group (dict) –

      The group that was created. Contains the name of the group that was created, the Amazon Resource Name (ARN) of the group that was generated based on the group name, the filter expression, and the insight configuration that was assigned to the group.

      • GroupName (string) –

        The unique case-sensitive name of the group.

      • GroupARN (string) –

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

      • FilterExpression (string) –

        The filter expression defining the parameters to include traces.

      • InsightsConfiguration (dict) –

        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.

        • InsightsEnabled (boolean) –

          Set the InsightsEnabled value to true to enable insights or false to disable insights.

        • NotificationsEnabled (boolean) –

          Set the NotificationsEnabled value to true to enable insights notifications. Notifications can only be enabled on a group with InsightsEnabled set to true.

Exceptions