XRay / Client / get_insight_impact_graph

get_insight_impact_graph#

XRay.Client.get_insight_impact_graph(**kwargs)#

Retrieves a service graph structure filtered by the specified insight. The service graph is limited to only structural information. For a complete service graph, use this API with the GetServiceGraph API.

See also: AWS API Documentation

Request Syntax

response = client.get_insight_impact_graph(
    InsightId='string',
    StartTime=datetime(2015, 1, 1),
    EndTime=datetime(2015, 1, 1),
    NextToken='string'
)
Parameters:

  • InsightId (string) –

    [REQUIRED]

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

  • StartTime (datetime) –

    [REQUIRED]

    The estimated start time of the insight, in Unix time seconds. The StartTime is inclusive of the value provided and can’t be more than 30 days old.

  • EndTime (datetime) –

    [REQUIRED]

    The estimated end time of the insight, in Unix time seconds. The EndTime is exclusive of the value provided. The time range between the start time and end time can’t be more than six hours.

  • NextToken (string) – Specify the pagination token returned by a previous request to retrieve the next page of results.

Return type:

dict

Returns:

Response Syntax

{
    'InsightId': 'string',
    'StartTime': datetime(2015, 1, 1),
    'EndTime': datetime(2015, 1, 1),
    'ServiceGraphStartTime': datetime(2015, 1, 1),
    'ServiceGraphEndTime': datetime(2015, 1, 1),
    'Services': [
        {
            'ReferenceId': 123,
            'Type': 'string',
            'Name': 'string',
            'Names': [
                'string',
            ],
            'AccountId': 'string',
            'Edges': [
                {
                    'ReferenceId': 123
                },
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • InsightId (string) –

      The insight’s unique identifier.

    • StartTime (datetime) –

      The provided start time.

    • EndTime (datetime) –

      The provided end time.

    • ServiceGraphStartTime (datetime) –

      The time, in Unix seconds, at which the service graph started.

    • ServiceGraphEndTime (datetime) –

      The time, in Unix seconds, at which the service graph ended.

    • Services (list) –

      The Amazon Web Services instrumented services related to the insight.

      • (dict) –

        Information about an application that processed requests, users that made requests, or downstream services, resources, and applications that an application used.

        • ReferenceId (integer) –

          Identifier for the service. Unique within the service map.

        • Type (string) –

          Identifier for the service. Unique within the service map.

          • Amazon Web Services Resource - The type of an Amazon Web Services resource. For example, AWS::EC2::Instance for an application running on Amazon EC2 or AWS::DynamoDB::Table for an Amazon DynamoDB table that the application used.

          • Amazon Web Services Service - The type of an Amazon Web Services service. For example, AWS::DynamoDB for downstream calls to Amazon DynamoDB that didn’t target a specific table.

          • Amazon Web Services Service - The type of an Amazon Web Services service. For example, AWS::DynamoDB for downstream calls to Amazon DynamoDB that didn’t target a specific table.

          • remote - A downstream service of indeterminate type.

        • Name (string) –

          The canonical name of the service.

        • Names (list) –

          A list of names for the service, including the canonical name.

          • (string) –

        • AccountId (string) –

          Identifier of the Amazon Web Services account in which the service runs.

        • Edges (list) –

          Connections to downstream services.

          • (dict) –

            The connection between two service in an insight impact graph.

            • ReferenceId (integer) –

              Identifier of the edge. Unique within a service map.

    • NextToken (string) –

      Pagination token.

Exceptions

  • XRay.Client.exceptions.InvalidRequestException

  • XRay.Client.exceptions.ThrottledException