get_insight¶

XRay.Client.get_insight(**kwargs)¶

Retrieves the summary information of an insight. This includes impact to clients and root cause services, the top anomalous services, the category, the state of the insight, and the start and end time of the insight.

See also: AWS API Documentation

Request Syntax

response = client.get_insight(
    InsightId='string'
)

Parameters

InsightId (string) --

[REQUIRED]

The insight's unique identifier. Use the GetInsightSummaries action to retrieve an InsightId.

Return type

dict

Returns

Response Syntax

{
    'Insight': {
        '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'
                }
            },
        ]
    }
}

Response Structure

(dict) --
- Insight (dict) --
  The summary information of 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) --
    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) --

Exceptions

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

Table Of Contents

get_insight¶