GetRouteAnalysisCommand

Suggest an Edit

Gets information about the specified route analysis.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { NetworkManagerClient, GetRouteAnalysisCommand } from "@aws-sdk/client-networkmanager"; // ES Modules import
// const { NetworkManagerClient, GetRouteAnalysisCommand } = require("@aws-sdk/client-networkmanager"); // CommonJS import
const client = new NetworkManagerClient(config);
const input = { // GetRouteAnalysisRequest
  GlobalNetworkId: "STRING_VALUE", // required
  RouteAnalysisId: "STRING_VALUE", // required
};
const command = new GetRouteAnalysisCommand(input);
const response = await client.send(command);
// { // GetRouteAnalysisResponse
//   RouteAnalysis: { // RouteAnalysis
//     GlobalNetworkId: "STRING_VALUE",
//     OwnerAccountId: "STRING_VALUE",
//     RouteAnalysisId: "STRING_VALUE",
//     StartTimestamp: new Date("TIMESTAMP"),
//     Status: "RUNNING" || "COMPLETED" || "FAILED",
//     Source: { // RouteAnalysisEndpointOptions
//       TransitGatewayAttachmentArn: "STRING_VALUE",
//       TransitGatewayArn: "STRING_VALUE",
//       IpAddress: "STRING_VALUE",
//     },
//     Destination: {
//       TransitGatewayAttachmentArn: "STRING_VALUE",
//       TransitGatewayArn: "STRING_VALUE",
//       IpAddress: "STRING_VALUE",
//     },
//     IncludeReturnPath: true || false,
//     UseMiddleboxes: true || false,
//     ForwardPath: { // RouteAnalysisPath
//       CompletionStatus: { // RouteAnalysisCompletion
//         ResultCode: "CONNECTED" || "NOT_CONNECTED",
//         ReasonCode: "TRANSIT_GATEWAY_ATTACHMENT_NOT_FOUND" || "TRANSIT_GATEWAY_ATTACHMENT_NOT_IN_TRANSIT_GATEWAY" || "CYCLIC_PATH_DETECTED" || "TRANSIT_GATEWAY_ATTACHMENT_STABLE_ROUTE_TABLE_NOT_FOUND" || "ROUTE_NOT_FOUND" || "BLACKHOLE_ROUTE_FOR_DESTINATION_FOUND" || "INACTIVE_ROUTE_FOR_DESTINATION_FOUND" || "TRANSIT_GATEWAY_ATTACHMENT_ATTACH_ARN_NO_MATCH" || "MAX_HOPS_EXCEEDED" || "POSSIBLE_MIDDLEBOX" || "NO_DESTINATION_ARN_PROVIDED",
//         ReasonContext: { // ReasonContextMap
//           "<keys>": "STRING_VALUE",
//         },
//       },
//       Path: [ // PathComponentList
//         { // PathComponent
//           Sequence: Number("int"),
//           Resource: { // NetworkResourceSummary
//             RegisteredGatewayArn: "STRING_VALUE",
//             ResourceArn: "STRING_VALUE",
//             ResourceType: "STRING_VALUE",
//             Definition: "STRING_VALUE",
//             NameTag: "STRING_VALUE",
//             IsMiddlebox: true || false,
//           },
//           DestinationCidrBlock: "STRING_VALUE",
//         },
//       ],
//     },
//     ReturnPath: {
//       CompletionStatus: {
//         ResultCode: "CONNECTED" || "NOT_CONNECTED",
//         ReasonCode: "TRANSIT_GATEWAY_ATTACHMENT_NOT_FOUND" || "TRANSIT_GATEWAY_ATTACHMENT_NOT_IN_TRANSIT_GATEWAY" || "CYCLIC_PATH_DETECTED" || "TRANSIT_GATEWAY_ATTACHMENT_STABLE_ROUTE_TABLE_NOT_FOUND" || "ROUTE_NOT_FOUND" || "BLACKHOLE_ROUTE_FOR_DESTINATION_FOUND" || "INACTIVE_ROUTE_FOR_DESTINATION_FOUND" || "TRANSIT_GATEWAY_ATTACHMENT_ATTACH_ARN_NO_MATCH" || "MAX_HOPS_EXCEEDED" || "POSSIBLE_MIDDLEBOX" || "NO_DESTINATION_ARN_PROVIDED",
//         ReasonContext: {
//           "<keys>": "STRING_VALUE",
//         },
//       },
//       Path: [
//         {
//           Sequence: Number("int"),
//           Resource: {
//             RegisteredGatewayArn: "STRING_VALUE",
//             ResourceArn: "STRING_VALUE",
//             ResourceType: "STRING_VALUE",
//             Definition: "STRING_VALUE",
//             NameTag: "STRING_VALUE",
//             IsMiddlebox: true || false,
//           },
//           DestinationCidrBlock: "STRING_VALUE",
//         },
//       ],
//     },
//   },
// };

GetRouteAnalysisCommand Input

See GetRouteAnalysisCommandInput for more details

Parameter
Type
Description
GlobalNetworkId
Required
string | undefined

The ID of the global network.

RouteAnalysisId
Required
string | undefined

The ID of the route analysis.

GetRouteAnalysisCommand Output

See GetRouteAnalysisCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
RouteAnalysis
RouteAnalysis | undefined

The route analysis.

Throws

Name
Fault
Details
AccessDeniedException
client

You do not have sufficient access to perform this action.

InternalServerException
server

The request has failed due to an internal error.

ResourceNotFoundException
client

The specified resource could not be found.

ThrottlingException
client

The request was denied due to request throttling.

ValidationException
client

The input fails to satisfy the constraints.

NetworkManagerServiceException
Base exception class for all service exceptions from NetworkManager service.