Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

DescribeVirtualInterfaces

Displays all virtual interfaces for an Amazon Web Services account. Virtual interfaces deleted fewer than 15 minutes before you make the request are also returned. If you specify a connection ID, only the virtual interfaces associated with the connection are returned. If you specify a virtual interface ID, then only a single virtual interface is returned.

A virtual interface (VLAN) transmits the traffic between the Amazon Direct Connect location and the customer network.

Request Syntax

{
   "connectionId": "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.

Response Syntax

{
   "virtualInterfaces": [ 
      { 
         "addressFamily": "string",
         "amazonAddress": "string",
         "amazonSideAsn": number,
         "asn": number,
         "authKey": "string",
         "awsDeviceV2": "string",
         "awsLogicalDeviceId": "string",
         "bgpPeers": [ 
            { 
               "addressFamily": "string",
               "amazonAddress": "string",
               "asn": number,
               "authKey": "string",
               "awsDeviceV2": "string",
               "awsLogicalDeviceId": "string",
               "bgpPeerId": "string",
               "bgpPeerState": "string",
               "bgpStatus": "string",
               "customerAddress": "string"
            }
         ],
         "connectionId": "string",
         "customerAddress": "string",
         "customerRouterConfig": "string",
         "directConnectGatewayId": "string",
         "jumboFrameCapable": boolean,
         "location": "string",
         "mtu": number,
         "ownerAccount": "string",
         "region": "string",
         "routeFilterPrefixes": [ 
            { 
               "cidr": "string"
            }
         ],
         "siteLinkEnabled": boolean,
         "tags": [ 
            { 
               "key": "string",
               "value": "string"
            }
         ],
         "virtualGatewayId": "string",
         "virtualInterfaceId": "string",
         "virtualInterfaceName": "string",
         "virtualInterfaceState": "string",
         "virtualInterfaceType": "string",
         "vlan": number
      }
   ]
}

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.

Errors

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

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: