Get Route Analysis

networkmanager_get_route_analysis

R Documentation

Gets information about the specified route analysis

Description

Gets information about the specified route analysis.

Usage

networkmanager_get_route_analysis(GlobalNetworkId, RouteAnalysisId)

Arguments

GlobalNetworkId

[required] The ID of the global network.

RouteAnalysisId

[required] The ID of the route analysis.

Value

A list with the following syntax:

list(
  RouteAnalysis = list(
    GlobalNetworkId = "string",
    OwnerAccountId = "string",
    RouteAnalysisId = "string",
    StartTimestamp = as.POSIXct(
      "2015-01-01"
    ),
    Status = "RUNNING"|"COMPLETED"|"FAILED",
    Source = list(
      TransitGatewayAttachmentArn = "string",
      TransitGatewayArn = "string",
      IpAddress = "string"
    ),
    Destination = list(
      TransitGatewayAttachmentArn = "string",
      TransitGatewayArn = "string",
      IpAddress = "string"
    ),
    IncludeReturnPath = TRUE|FALSE,
    UseMiddleboxes = TRUE|FALSE,
    ForwardPath = list(
      CompletionStatus = list(
        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 = list(
          "string"
        )
      ),
      Path = list(
        list(
          Sequence = 123,
          Resource = list(
            RegisteredGatewayArn = "string",
            ResourceArn = "string",
            ResourceType = "string",
            Definition = "string",
            NameTag = "string",
            IsMiddlebox = TRUE|FALSE
          ),
          DestinationCidrBlock = "string"
        )
      )
    ),
    ReturnPath = list(
      CompletionStatus = list(
        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 = list(
          "string"
        )
      ),
      Path = list(
        list(
          Sequence = 123,
          Resource = list(
            RegisteredGatewayArn = "string",
            ResourceArn = "string",
            ResourceType = "string",
            Definition = "string",
            NameTag = "string",
            IsMiddlebox = TRUE|FALSE
          ),
          DestinationCidrBlock = "string"
        )
      )
    )
  )
)

Request syntax

svc$get_route_analysis(
  GlobalNetworkId = "string",
  RouteAnalysisId = "string"
)