Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

DescribeVirtualInterfaces

Displays all virtual interfaces for an AWS 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 AWS Direct Connect location and the customer network.

If you're using an asn, the response includes ASN value in both the asn and asnLong fields.
If you're using asnLong, the response returns a value of 0 (zero) for the asn attribute because it exceeds the highest ASN value of 2,147,483,647 that it can support

Request Syntax


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

connectionId

The ID of the connection.

Type: String

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",
   "virtualInterfaces": [ 
      { 
         "addressFamily": "string",
         "amazonAddress": "string",
         "amazonSideAsn": number,
         "asn": number,
         "asnLong": number,
         "authKey": "string",
         "awsDeviceV2": "string",
         "awsLogicalDeviceId": "string",
         "bgpPeers": [ 
            { 
               "addressFamily": "string",
               "amazonAddress": "string",
               "asn": number,
               "asnLong": 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.

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

virtualInterfaces

The virtual interfaces

Type: Array of VirtualInterface objects

Errors

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

DirectConnectClientException

One or more parameters are not valid.

HTTP Status Code: 400

DirectConnectServerException

A server-side error occurred.

HTTP Status Code: 400