GetInsightImpactGraph - Amazon X-Ray
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China.

GetInsightImpactGraph

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.

Request Syntax

POST /InsightImpactGraph HTTP/1.1 Content-type: application/json { "EndTime": number, "InsightId": "string", "NextToken": "string", "StartTime": number }

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

EndTime

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.

Type: Timestamp

Required: Yes

InsightId

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

Type: String

Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}

Required: Yes

NextToken

Specify the pagination token returned by a previous request to retrieve the next page of results.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2000.

Required: No

StartTime

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.

Type: Timestamp

Required: Yes

Response Syntax

HTTP/1.1 200 Content-type: application/json { "EndTime": number, "InsightId": "string", "NextToken": "string", "ServiceGraphEndTime": number, "ServiceGraphStartTime": number, "Services": [ { "AccountId": "string", "Edges": [ { "ReferenceId": number } ], "Name": "string", "Names": [ "string" ], "ReferenceId": number, "Type": "string" } ], "StartTime": number }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

EndTime

The provided end time.

Type: Timestamp

InsightId

The insight's unique identifier.

Type: String

Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}

NextToken

Pagination token.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2000.

ServiceGraphEndTime

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

Type: Timestamp

ServiceGraphStartTime

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

Type: Timestamp

Services

The Amazon instrumented services related to the insight.

Type: Array of InsightImpactGraphService objects

StartTime

The provided start time.

Type: Timestamp

Errors

For information about the errors that are common to all actions, see Common Errors.

InvalidRequestException

The request is missing required parameters or has invalid parameters.

HTTP Status Code: 400

ThrottledException

The request exceeds the maximum number of requests per second.

HTTP Status Code: 429

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: