Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

ListVirtualInterfaceRoutes

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.

Request Syntax


{
   "filters": { 
      "addressFamily": "string",
      "asPath": [ number ],
      "cidrs": [ "string" ],
      "communities": [ "string" ],
      "routeDirection": "string"
   },
   "maxResults": number,
   "nextToken": "string",
   "virtualInterfaceId": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

filters

The filters to apply to the routes returned.

Type: RouteFilters object

Required: No

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.

Type: Integer

Required: No

nextToken

The token for the next page of results.

Type: String

Required: No

virtualInterfaceId

The ID of the virtual interface.

Type: String

Required: No

Response Syntax


{
   "nextToken": "string",
   "routes": [ 
      { 
         "addressFamily": "string",
         "asPath": [ 
            { 
               "path": [ number ],
               "pathType": "string"
            }
         ],
         "awsLogicalDeviceId": "string",
         "cidr": "string",
         "communities": [ "string" ],
         "routeDirection": "string",
         "routeInstalledAt": number
      }
   ],
   "virtualInterfaceId": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

nextToken

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

Type: String

routes

The routes for the virtual interface.

Type: Array of Route objects

virtualInterfaceId

The ID of the virtual interface.

Type: String

Errors

For information about the errors that are common to all actions, see Common Error Types.

DirectConnectClientException

One or more parameters are not valid.

HTTP Status Code: 400

DirectConnectServerException

A server-side error occurred.

HTTP Status Code: 400