listVirtualInterfaceTestHistory method

Future<ListVirtualInterfaceTestHistoryResponse> listVirtualInterfaceTestHistory({ List<String>? bgpPeers, int? maxResults, String? nextToken, String? status, String? testId, String? virtualInterfaceId, })

Lists the virtual interface failover test history.

May throw DirectConnectServerException. May throw DirectConnectClientException.

Parameter bgpPeers : The BGP peers that were placed in the DOWN state during the virtual interface failover test.

Parameter 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.

Parameter nextToken : The token for the next page of results.

Parameter status : The status of the virtual interface failover test.

Parameter testId : The ID of the virtual interface failover test.

Parameter virtualInterfaceId : The ID of the virtual interface that was tested.

Implementation

Future<ListVirtualInterfaceTestHistoryResponse>
    listVirtualInterfaceTestHistory({
  List<String>? bgpPeers,
  int? maxResults,
  String? nextToken,
  String? status,
  String? testId,
  String? virtualInterfaceId,
}) async {
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.1',
    'X-Amz-Target': 'OvertureService.ListVirtualInterfaceTestHistory'
  };
  final jsonResponse = await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      if (bgpPeers != null) 'bgpPeers': bgpPeers,
      if (maxResults != null) 'maxResults': maxResults,
      if (nextToken != null) 'nextToken': nextToken,
      if (status != null) 'status': status,
      if (testId != null) 'testId': testId,
      if (virtualInterfaceId != null)
        'virtualInterfaceId': virtualInterfaceId,
    },
  );

  return ListVirtualInterfaceTestHistoryResponse.fromJson(jsonResponse.body);
}