Class DescribeVirtualInterfacesCommandProtected

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 Direct Connect location and the customer network.

Example

Use a bare-bones client and the command you need to make an API call.

import { DirectConnectClient, DescribeVirtualInterfacesCommand } from "@aws-sdk/client-direct-connect"; // ES Modules import
// const { DirectConnectClient, DescribeVirtualInterfacesCommand } = require("@aws-sdk/client-direct-connect"); // CommonJS import
const client = new DirectConnectClient(config);
const input = { // DescribeVirtualInterfacesRequest
  connectionId: "STRING_VALUE",
  virtualInterfaceId: "STRING_VALUE",
};
const command = new DescribeVirtualInterfacesCommand(input);
const response = await client.send(command);
// { // VirtualInterfaces
//   virtualInterfaces: [ // VirtualInterfaceList
//     { // VirtualInterface
//       ownerAccount: "STRING_VALUE",
//       virtualInterfaceId: "STRING_VALUE",
//       location: "STRING_VALUE",
//       connectionId: "STRING_VALUE",
//       virtualInterfaceType: "STRING_VALUE",
//       virtualInterfaceName: "STRING_VALUE",
//       vlan: Number("int"),
//       asn: Number("int"),
//       amazonSideAsn: Number("long"),
//       authKey: "STRING_VALUE",
//       amazonAddress: "STRING_VALUE",
//       customerAddress: "STRING_VALUE",
//       addressFamily: "ipv4" || "ipv6",
//       virtualInterfaceState: "confirming" || "verifying" || "pending" || "available" || "down" || "deleting" || "deleted" || "rejected" || "unknown",
//       customerRouterConfig: "STRING_VALUE",
//       mtu: Number("int"),
//       jumboFrameCapable: true || false,
//       virtualGatewayId: "STRING_VALUE",
//       directConnectGatewayId: "STRING_VALUE",
//       routeFilterPrefixes: [ // RouteFilterPrefixList
//         { // RouteFilterPrefix
//           cidr: "STRING_VALUE",
//         },
//       ],
//       bgpPeers: [ // BGPPeerList
//         { // BGPPeer
//           bgpPeerId: "STRING_VALUE",
//           asn: Number("int"),
//           authKey: "STRING_VALUE",
//           addressFamily: "ipv4" || "ipv6",
//           amazonAddress: "STRING_VALUE",
//           customerAddress: "STRING_VALUE",
//           bgpPeerState: "verifying" || "pending" || "available" || "deleting" || "deleted",
//           bgpStatus: "up" || "down" || "unknown",
//           awsDeviceV2: "STRING_VALUE",
//           awsLogicalDeviceId: "STRING_VALUE",
//         },
//       ],
//       region: "STRING_VALUE",
//       awsDeviceV2: "STRING_VALUE",
//       awsLogicalDeviceId: "STRING_VALUE",
//       tags: [ // TagList
//         { // Tag
//           key: "STRING_VALUE", // required
//           value: "STRING_VALUE",
//         },
//       ],
//       siteLinkEnabled: true || false,
//     },
//   ],
// };

Param

DescribeVirtualInterfacesCommandInput

Returns

DescribeVirtualInterfacesCommandOutput

See

• DescribeVirtualInterfacesCommandInput for command's input shape.
• DescribeVirtualInterfacesCommandOutput for command's response shape.
• config for DirectConnectClient's config shape.

Throws

DirectConnectClientException (client fault)

One or more parameters are not valid.

Throws

DirectConnectServerException (server fault)

A server-side error occurred.

Throws

DirectConnectServiceException

Base exception class for all service exceptions from DirectConnect service.