AWS CLI Command Reference

[ aws . directconnect ]

list-virtual-interface-routes

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.

See also: AWS API Documentation

Synopsis

  list-virtual-interface-routes
[--virtual-interface-id <value>]
[--filters <value>]
[--max-results <value>]
[--next-token <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
[--cli-error-format <value>]

Options

--virtual-interface-id (string)

The ID of the virtual interface.

--filters (structure)

The filters to apply to the routes returned.

routeDirection -> (string)

The direction of the routes to return.

The valid values are accepted (routes received from the customer network) and advertised (routes advertised to the customer network).

Possible values:

  • accepted
  • advertised

addressFamily -> (string)

The address family of the routes to return.

The valid values are ipv4 and ipv6 .

Possible values:

  • ipv4
  • ipv6

cidrs -> (list)

The CIDRs (prefixes) used to filter the routes. You can specify up to 10 CIDRs.

Constraints:

  • min: 1
  • max: 10

(string)

asPath -> (list)

The autonomous system (AS) numbers used to filter the routes by their AS path.

(long)

communities -> (list)

The BGP communities used to filter the routes.

(string)

Shorthand Syntax:

routeDirection=string,addressFamily=string,cidrs=string,string,asPath=long,long,communities=string,string

JSON Syntax:

{
  "routeDirection": "accepted"|"advertised",
  "addressFamily": "ipv4"|"ipv6",
  "cidrs": ["string", ...],
  "asPath": [long, ...],
  "communities": ["string", ...]
}

--max-results (integer)

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.

--next-token (string)

The token for the next page of results.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table
  • yaml
  • yaml-stream
  • off

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

--cli-error-format (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

  • legacy
  • json
  • yaml
  • text
  • table
  • enhanced

Output

virtualInterfaceId -> (string)

The ID of the virtual interface.

routes -> (list)

The routes for the virtual interface.

(structure)

Information about a route for a virtual interface.

cidr -> (string)

The CIDR (prefix) of the route.

routeDirection -> (string)

The direction of the route.

The valid values are accepted (received from the customer network) and advertised (advertised to the customer network).

Possible values:

  • accepted
  • advertised

addressFamily -> (string)

The address family of the route.

The valid values are ipv4 and ipv6 .

Possible values:

  • ipv4
  • ipv6

asPath -> (list)

The autonomous system (AS) path of the route.

(structure)

A segment of an autonomous system (AS) path.

pathType -> (string)

The type of the AS path segment.

The valid values are seq (an ordered AS_SEQUENCE ) and set (an unordered AS_SET ).

Possible values:

  • seq
  • set

path -> (list)

The autonomous system (AS) numbers in the segment.

(long)

communities -> (list)

The BGP communities associated with the route.

(string)

awsLogicalDeviceId -> (string)

The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.

routeInstalledAt -> (timestamp)

The time when the route was installed. The value is displayed in UTC format.

nextToken -> (string)

The token to use to retrieve the next page of results. This value is null when there are no more results to return.
© Copyright 2026, Amazon Web Services. Created using Sphinx.