StartRouteAnalysis - AWS Global Networks for Transit Gateways


Starts analyzing the routing path between the specified source and destination. For more information, see Route Analyzer.

Request Syntax

POST /global-networks/globalNetworkId/route-analyses HTTP/1.1 Content-type: application/json { "Destination": { "IpAddress": "string", "TransitGatewayAttachmentArn": "string" }, "IncludeReturnPath": boolean, "Source": { "IpAddress": "string", "TransitGatewayAttachmentArn": "string" }, "UseMiddleboxes": boolean }

URI Request Parameters

The request uses the following URI parameters.


The ID of the global network.

Length Constraints: Minimum length of 0. Maximum length of 50.

Pattern: [\s\S]*

Required: Yes

Request Body

The request accepts the following data in JSON format.


The destination.

Type: RouteAnalysisEndpointOptionsSpecification object

Required: Yes


Indicates whether to analyze the return path. The default is false.

Type: Boolean

Required: No


The source from which traffic originates.

Type: RouteAnalysisEndpointOptionsSpecification object

Required: Yes


Indicates whether to include the location of middlebox appliances in the route analysis. The default is false.

Type: Boolean

Required: No

Response Syntax

HTTP/1.1 200 Content-type: application/json { "RouteAnalysis": { "Destination": { "IpAddress": "string", "TransitGatewayArn": "string", "TransitGatewayAttachmentArn": "string" }, "ForwardPath": { "CompletionStatus": { "ReasonCode": "string", "ReasonContext": { "string" : "string" }, "ResultCode": "string" }, "Path": [ { "DestinationCidrBlock": "string", "Resource": { "Definition": "string", "IsMiddlebox": boolean, "NameTag": "string", "RegisteredGatewayArn": "string", "ResourceArn": "string", "ResourceType": "string" }, "Sequence": number } ] }, "GlobalNetworkId": "string", "IncludeReturnPath": boolean, "OwnerAccountId": "string", "ReturnPath": { "CompletionStatus": { "ReasonCode": "string", "ReasonContext": { "string" : "string" }, "ResultCode": "string" }, "Path": [ { "DestinationCidrBlock": "string", "Resource": { "Definition": "string", "IsMiddlebox": boolean, "NameTag": "string", "RegisteredGatewayArn": "string", "ResourceArn": "string", "ResourceType": "string" }, "Sequence": number } ] }, "RouteAnalysisId": "string", "Source": { "IpAddress": "string", "TransitGatewayArn": "string", "TransitGatewayAttachmentArn": "string" }, "StartTimestamp": number, "Status": "string", "UseMiddleboxes": boolean } }

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.


The route analysis.

Type: RouteAnalysis object


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


You do not have sufficient access to perform this action.

HTTP Status Code: 403


There was a conflict processing the request. Updating or deleting the resource can cause an inconsistent state.

HTTP Status Code: 409


The request has failed due to an internal error.

HTTP Status Code: 500


The specified resource could not be found.

HTTP Status Code: 404


The request was denied due to request throttling.

HTTP Status Code: 429


The input fails to satisfy the constraints.

HTTP Status Code: 400

See Also

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