list_virtual_interface_test_history ¶

def list_virtual_interface_test_history(
    self,
    *,
    config_overrides: Optional[DirectConnectClientConfig] = None,
    test_id: Optional["capo_direct_connect.types.test_id.TestId"] = None,
    virtual_interface_id: Optional[
        "capo_direct_connect.types.virtual_interface_id.VirtualInterfaceId"
    ] = None,
    bgp_peers: Optional[
        "capo_direct_connect.types.bgp_peer_id_list.BGPPeerIdList"
    ] = None,
    status: Optional[
        "capo_direct_connect.types.failure_test_history_status.FailureTestHistoryStatus"
    ] = None,
    max_results: Optional[
        "capo_direct_connect.types.max_result_set_size.MaxResultSetSize"
    ] = None,
    next_token: Optional[
        "capo_direct_connect.types.pagination_token.PaginationToken"
    ] = None,
) -> "capo_direct_connect.types.list_virtual_interface_test_history_response.ListVirtualInterfaceTestHistoryResponse":
    """<p>Lists the virtual interface failover test history.</p>

    Args:
        test_id: <p>The ID of the virtual interface failover test.</p>
        virtual_interface_id: <p>The ID of the virtual interface that was tested.</p>
        bgp_peers: <p>The BGP peers that were placed in the DOWN state during the virtual interface failover test.</p>
        status: <p>The status of the virtual interface failover test.</p>
        max_results: <p>The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned <code>nextToken</code> value.</p> <p>If <code>MaxResults</code> is given a value larger than 100, only 100 results are returned.</p>
        next_token: <p>The token for the next page of results.</p>

    Raises:
        capo_direct_connect.errors.direct_connect_client_exception.DirectConnectClientException: <p>One or more parameters are not valid.</p>
        capo_direct_connect.errors.direct_connect_server_exception.DirectConnectServerException: <p>A server-side error occurred.</p>
        capo_direct_connect.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_direct_connect.types.list_virtual_interface_test_history_request.ListVirtualInterfaceTestHistoryRequest]",
    ) -> OperationResponse[
        "capo_direct_connect.types.list_virtual_interface_test_history_response.ListVirtualInterfaceTestHistoryResponse"
    ]:
        import capo_direct_connect._operations.overture_service.list_virtual_interface_test_history

        output, http_response = (
            capo_direct_connect._operations.overture_service.list_virtual_interface_test_history.list_virtual_interface_test_history(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListVirtualInterfaceTestHistory")
    )
    input_: capo_direct_connect.types.list_virtual_interface_test_history_request.ListVirtualInterfaceTestHistoryRequest = {}
    if test_id is not None:
        input_["test_id"] = test_id
    if virtual_interface_id is not None:
        input_["virtual_interface_id"] = virtual_interface_id
    if bgp_peers is not None:
        input_["bgp_peers"] = bgp_peers
    if status is not None:
        input_["status"] = status
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output