describeVirtualInterfaces method

Future<VirtualInterfaces> describeVirtualInterfaces({
  1. String? connectionId,
  2. String? virtualInterfaceId,
})

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.

May throw DirectConnectServerException. May throw DirectConnectClientException.

Parameter connectionId : The ID of the connection.

Parameter virtualInterfaceId : The ID of the virtual interface.

Implementation

Future<VirtualInterfaces> describeVirtualInterfaces({
  String? connectionId,
  String? virtualInterfaceId,
}) async {
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.1',
    'X-Amz-Target': 'OvertureService.DescribeVirtualInterfaces'
  };
  final jsonResponse = await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      if (connectionId != null) 'connectionId': connectionId,
      if (virtualInterfaceId != null)
        'virtualInterfaceId': virtualInterfaceId,
    },
  );

  return VirtualInterfaces.fromJson(jsonResponse.body);
}