XRay / Client / get_insight_summaries

get_insight_summaries#

XRay.Client.get_insight_summaries(**kwargs)#

Retrieves the summaries of all insights in the specified group matching the provided filter values.

See also: AWS API Documentation

Request Syntax

response = client.get_insight_summaries(
    States=[
        'ACTIVE'|'CLOSED',
    ],
    GroupARN='string',
    GroupName='string',
    StartTime=datetime(2015, 1, 1),
    EndTime=datetime(2015, 1, 1),
    MaxResults=123,
    NextToken='string'
)
Parameters:

  • States (list) –

    The list of insight states.

    • (string) –

  • GroupARN (string) – The Amazon Resource Name (ARN) of the group. Required if the GroupName isn’t provided.

  • GroupName (string) – The name of the group. Required if the GroupARN isn’t provided.

  • StartTime (datetime) –

    [REQUIRED]

    The beginning of the time frame in which the insights started. The start time can’t be more than 30 days old.

  • EndTime (datetime) –

    [REQUIRED]

    The end of the time frame in which the insights ended. The end time can’t be more than 30 days old.

  • MaxResults (integer) – The maximum number of results to display.

  • NextToken (string) – Pagination token.

Return type:

dict

Returns:

Response Syntax

{
    'InsightSummaries': [
        {
            'InsightId': 'string',
            'GroupARN': 'string',
            'GroupName': 'string',
            'RootCauseServiceId': {
                'Name': 'string',
                'Names': [
                    'string',
                ],
                'AccountId': 'string',
                'Type': 'string'
            },
            'Categories': [
                'FAULT',
            ],
            'State': 'ACTIVE'|'CLOSED',
            'StartTime': datetime(2015, 1, 1),
            'EndTime': datetime(2015, 1, 1),
            'Summary': 'string',
            'ClientRequestImpactStatistics': {
                'FaultCount': 123,
                'OkCount': 123,
                'TotalCount': 123
            },
            'RootCauseServiceRequestImpactStatistics': {
                'FaultCount': 123,
                'OkCount': 123,
                'TotalCount': 123
            },
            'TopAnomalousServices': [
                {
                    'ServiceId': {
                        'Name': 'string',
                        'Names': [
                            'string',
                        ],
                        'AccountId': 'string',
                        'Type': 'string'
                    }
                },
            ],
            'LastUpdateTime': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • InsightSummaries (list) –

      The summary of each insight within the group matching the provided filters. The summary contains the InsightID, start and end time, the root cause service, the root cause and client impact statistics, the top anomalous services, and the status of the insight.

      • (dict) –

        Information that describes an insight.

        • InsightId (string) –

          The insights unique identifier.

        • GroupARN (string) –

          The Amazon Resource Name (ARN) of the group that the insight belongs to.

        • GroupName (string) –

          The name of the group that the insight belongs to.

        • RootCauseServiceId (dict) –

          • Name (string) –

          • Names (list) –

            • (string) –

          • AccountId (string) –

          • Type (string) –

        • Categories (list) –

          Categories The categories that label and describe the type of insight.

          • (string) –

        • State (string) –

          The current state of the insight.

        • StartTime (datetime) –

          The time, in Unix seconds, at which the insight began.

        • EndTime (datetime) –

          The time, in Unix seconds, at which the insight ended.

        • Summary (string) –

          A brief description of the insight.

        • ClientRequestImpactStatistics (dict) –

          The impact statistics of the client side service. This includes the number of requests to the client service and whether the requests were faults or okay.

          • FaultCount (integer) –

            The number of requests that have resulted in a fault,

          • OkCount (integer) –

            The number of successful requests.

          • TotalCount (integer) –

            The total number of requests to the service.

        • RootCauseServiceRequestImpactStatistics (dict) –

          The impact statistics of the root cause service. This includes the number of requests to the client service and whether the requests were faults or okay.

          • FaultCount (integer) –

            The number of requests that have resulted in a fault,

          • OkCount (integer) –

            The number of successful requests.

          • TotalCount (integer) –

            The total number of requests to the service.

        • TopAnomalousServices (list) –

          The service within the insight that is most impacted by the incident.

          • (dict) –

            The service within the service graph that has anomalously high fault rates.

            • ServiceId (dict) –

              • Name (string) –

              • Names (list) –

                • (string) –

              • AccountId (string) –

              • Type (string) –

        • LastUpdateTime (datetime) –

          The time, in Unix seconds, that the insight was last updated.

    • NextToken (string) –

      Pagination token.

Exceptions