Skip to content

Lists the routes for the specified virtual interface

Description

Lists the routes for the specified virtual interface.

Use the routeDirection filter to control which routes are returned:

  • accepted: routes received from the customer network over the virtual interface.
  • advertised: routes advertised to the customer network over the virtual interface.

Usage

directconnect_list_virtual_interface_routes(virtualInterfaceId, filters,
  maxResults, nextToken)

Arguments

  • virtualInterfaceId

    The ID of the virtual interface.

  • filters

    The filters to apply to the routes returned.

  • maxResults

    The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

    If MaxResults is given a value larger than 100, only 100 results are returned.

  • nextToken

    The token for the next page of results.

Value

A list with the following syntax:

list(
  virtualInterfaceId = "string",
  routes = list(
    list(
      cidr = "string",
      routeDirection = "accepted"|"advertised",
      addressFamily = "ipv4"|"ipv6",
      asPath = list(
        list(
          pathType = "seq"|"set",
          path = list(
            123
          )
        )
      ),
      communities = list(
        "string"
      ),
      awsLogicalDeviceId = "string",
      routeInstalledAt = as.POSIXct(
        "2015-01-01"
      )
    )
  ),
  nextToken = "string"
)

Request syntax

svc$list_virtual_interface_routes(
  virtualInterfaceId = "string",
  filters = list(
    routeDirection = "accepted"|"advertised",
    addressFamily = "ipv4"|"ipv6",
    cidrs = list(
      "string"
    ),
    asPath = list(
      123
    ),
    communities = list(
      "string"
    )
  ),
  maxResults = 123,
  nextToken = "string"
)