get_groups

XRay.Client.get_groups(**kwargs)

Retrieves all active group details.

See also: AWS API Documentation

Request Syntax

response = client.get_groups(
    NextToken='string'
)

Parameters

NextToken (string) -- Pagination token.

Return type

dict

Returns

Response Syntax

{
    'Groups': [
        {
            'GroupName': 'string',
            'GroupARN': 'string',
            'FilterExpression': 'string',
            'InsightsConfiguration': {
                'InsightsEnabled': True|False,
                'NotificationsEnabled': True|False
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) --
  • Groups (list) --

    The collection of all active groups.

    • (dict) --

      Details for a group without metadata.

      • GroupName (string) --

        The unique case-sensitive name of the group.

      • GroupARN (string) --

        The 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. Notifications can 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.

  • NextToken (string) --

    Pagination token.

Exceptions

• XRay.Client.exceptions.InvalidRequestException
• XRay.Client.exceptions.ThrottledException