Getting Information About Your Private Virtual Interfaces

You can get information about one or more of your private virtual interfaces.

You can use the connection-id parameter to describe only virtual interfaces associated with a specified DirectLink connection, or the virtual-interface-id parameter to describe a specified virtual interface.

If you exceed the number of identical requests allowed for a configured time period, the Throttling error message is returned.

This procedure uses AWS CLI only. Information about these resources is also available from Cockpit v1. For more information, see DirectLink User Interface.

To get information about one or more of your private virtual interfaces, use the describe-virtual-interfaces command following this syntax:

Request sample
$ aws directconnect describe-virtual-interfaces \
    --profile YOUR_PROFILE \
    --connection-id dxcon-12345678 \
    [--virtual-interface-id NOT_SPECIFIED] \

This command contains the following attributes that you need to specify:

  • (optional) profile: The named profile you want to use, created when configuring AWS CLI. For more information, see Installing and Configuring AWS CLI.

  • (optional) connection-id: The ID of a connection.

  • (optional) virtual-interface-id: The ID of a private virtual interface.

  • endpoint: The endpoint corresponding to the Region you want to send the request to.

The describe-virtual-interfaces command returns the following elements:

  • virtualInterfaces: Information about one or more private virtual interfaces. This element contains the following information:

    • virtualInterfaceState: The state of the virtual interface. For more information, see About DirectLink.

    • asn: The autonomous system number (ASN) for the Border Gateway Protocol (BGP) configuration on the customer side of the virtual interface.

    • vlan: The VLAN number associated with the virtual interface.

    • customerAddress: The IP on the customer side of the virtual interface.

    • ownerAccount: The account ID of the owner of the virtual interface.

    • connectionId: The ID of the connection.

    • virtualGatewayId: The target virtual private gateway.

    • authKey: The BGP authentication key.

    • location: The datacenter where the virtual interface is located.

    • amazonAddress: The IP on the OUTSCALE side of the virtual interface.

    • virtualInterfaceType: The type of the virtual interface (always private).

    • virtualInterfaceName: The name of the virtual interface.

Result sample
    "virtualInterfaces": [
            "virtualInterfaceState": "available",
            "asn": 65000,
            "vlan": 101,
            "customerAddress": "",
            "ownerAccount": "12345678",
            "connectionId": "dxcon-aa00bb11cc22",
            "virtualGatewayId": "vgw-dd33ee44ff55",
            "virtualInterfaceId": "dxvif-gg66hh77ii88",
            "authKey": "asdf65sample",
            "location": "PAR1",
            "amazonAddress": "",
            "virtualInterfaceType": "private",
            "virtualInterfaceName": "PrivateVirtualInterface"

Related Pages

Corresponding API Method

AWS™ and Amazon Web Services™ are trademarks of Amazon Technologies, Inc or its affiliates in the United States and/or other countries.