Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . networkmanager ]

start-route-analysis

Description

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

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  start-route-analysis
--global-network-id <value>
--source <value>
--destination <value>
[--include-return-path | --no-include-return-path]
[--use-middleboxes | --no-use-middleboxes]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--global-network-id (string)

The ID of the global network.

--source (structure)

The source from which traffic originates.

TransitGatewayAttachmentArn -> (string)

The ARN of the transit gateway attachment.

IpAddress -> (string)

The IP address.

Shorthand Syntax:

TransitGatewayAttachmentArn=string,IpAddress=string

JSON Syntax:

{
  "TransitGatewayAttachmentArn": "string",
  "IpAddress": "string"
}

--destination (structure)

The destination.

TransitGatewayAttachmentArn -> (string)

The ARN of the transit gateway attachment.

IpAddress -> (string)

The IP address.

Shorthand Syntax:

TransitGatewayAttachmentArn=string,IpAddress=string

JSON Syntax:

{
  "TransitGatewayAttachmentArn": "string",
  "IpAddress": "string"
}

--include-return-path | --no-include-return-path (boolean)

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

--use-middleboxes | --no-use-middleboxes (boolean)

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

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

RouteAnalysis -> (structure)

The route analysis.

GlobalNetworkId -> (string)

The ID of the global network.

OwnerAccountId -> (string)

The ID of the AWS account that created the route analysis.

RouteAnalysisId -> (string)

The ID of the route analysis.

StartTimestamp -> (timestamp)

The time that the analysis started.

Status -> (string)

The status of the route analysis.

Source -> (structure)

The source.

TransitGatewayAttachmentArn -> (string)

The ARN of the transit gateway attachment.

TransitGatewayArn -> (string)

The ARN of the transit gateway.

IpAddress -> (string)

The IP address.

Destination -> (structure)

The destination.

TransitGatewayAttachmentArn -> (string)

The ARN of the transit gateway attachment.

TransitGatewayArn -> (string)

The ARN of the transit gateway.

IpAddress -> (string)

The IP address.

IncludeReturnPath -> (boolean)

Indicates whether to analyze the return path. The return path is not analyzed if the forward path analysis does not succeed.

UseMiddleboxes -> (boolean)

Indicates whether to include the location of middlebox appliances in the route analysis.

ForwardPath -> (structure)

The forward path.

CompletionStatus -> (structure)

The status of the analysis at completion.

ResultCode -> (string)

The result of the analysis. If the status is NOT_CONNECTED , check the reason code.

ReasonCode -> (string)

The reason code. Available only if a connection is not found.

  • BLACKHOLE_ROUTE_FOR_DESTINATION_FOUND - Found a black hole route with the destination CIDR block.
  • CYCLIC_PATH_DETECTED - Found the same resource multiple times while traversing the path.
  • INACTIVE_ROUTE_FOR_DESTINATION_FOUND - Found an inactive route with the destination CIDR block.
  • MAX_HOPS_EXCEEDED - Analysis exceeded 64 hops without finding the destination.
  • ROUTE_NOT_FOUND - Cannot find a route table with the destination CIDR block.
  • TGW_ATTACH_ARN_NO_MATCH - Found an attachment, but not with the correct destination ARN.
  • TGW_ATTACH_NOT_FOUND - Cannot find an attachment.
  • TGW_ATTACH_NOT_IN_TGW - Found an attachment, but not to the correct transit gateway.
  • TGW_ATTACH_STABLE_ROUTE_TABLE_NOT_FOUND - The state of the route table association is not associated.

ReasonContext -> (map)

Additional information about the path. Available only if a connection is not found.

key -> (string)

value -> (string)

Path -> (list)

The route analysis path.

(structure)

Describes a path component.

Sequence -> (integer)

The sequence number in the path. The destination is 0.

Resource -> (structure)

The resource.

RegisteredGatewayArn -> (string)

The ARN of the gateway.

ResourceArn -> (string)

The ARN of the resource.

ResourceType -> (string)

The resource type.

Definition -> (string)

Information about the resource, in JSON format. Network Manager gets this information by describing the resource using its Describe API call.

NameTag -> (string)

The value for the Name tag.

IsMiddlebox -> (boolean)

Indicates whether this is a middlebox appliance.

DestinationCidrBlock -> (string)

The destination CIDR block in the route table.

ReturnPath -> (structure)

The return path.

CompletionStatus -> (structure)

The status of the analysis at completion.

ResultCode -> (string)

The result of the analysis. If the status is NOT_CONNECTED , check the reason code.

ReasonCode -> (string)

The reason code. Available only if a connection is not found.

  • BLACKHOLE_ROUTE_FOR_DESTINATION_FOUND - Found a black hole route with the destination CIDR block.
  • CYCLIC_PATH_DETECTED - Found the same resource multiple times while traversing the path.
  • INACTIVE_ROUTE_FOR_DESTINATION_FOUND - Found an inactive route with the destination CIDR block.
  • MAX_HOPS_EXCEEDED - Analysis exceeded 64 hops without finding the destination.
  • ROUTE_NOT_FOUND - Cannot find a route table with the destination CIDR block.
  • TGW_ATTACH_ARN_NO_MATCH - Found an attachment, but not with the correct destination ARN.
  • TGW_ATTACH_NOT_FOUND - Cannot find an attachment.
  • TGW_ATTACH_NOT_IN_TGW - Found an attachment, but not to the correct transit gateway.
  • TGW_ATTACH_STABLE_ROUTE_TABLE_NOT_FOUND - The state of the route table association is not associated.

ReasonContext -> (map)

Additional information about the path. Available only if a connection is not found.

key -> (string)

value -> (string)

Path -> (list)

The route analysis path.

(structure)

Describes a path component.

Sequence -> (integer)

The sequence number in the path. The destination is 0.

Resource -> (structure)

The resource.

RegisteredGatewayArn -> (string)

The ARN of the gateway.

ResourceArn -> (string)

The ARN of the resource.

ResourceType -> (string)

The resource type.

Definition -> (string)

Information about the resource, in JSON format. Network Manager gets this information by describing the resource using its Describe API call.

NameTag -> (string)

The value for the Name tag.

IsMiddlebox -> (boolean)

Indicates whether this is a middlebox appliance.

DestinationCidrBlock -> (string)

The destination CIDR block in the route table.