:doc:`DirectConnect <../../directconnect>` / Client / list_virtual_interface_test_history

***********************************
list_virtual_interface_test_history
***********************************



.. py:method:: DirectConnect.Client.list_virtual_interface_test_history(**kwargs)

  

  Lists the virtual interface failover test history.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/directconnect-2012-10-25/ListVirtualInterfaceTestHistory>`_  


  **Request Syntax**
  ::

    response = client.list_virtual_interface_test_history(
        testId='string',
        virtualInterfaceId='string',
        bgpPeers=[
            'string',
        ],
        status='string',
        maxResults=123,
        nextToken='string'
    )
    
  :type testId: string
  :param testId: 

    The ID of the virtual interface failover test.

    

  
  :type virtualInterfaceId: string
  :param virtualInterfaceId: 

    The ID of the virtual interface that was tested.

    

  
  :type bgpPeers: list
  :param bgpPeers: 

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

    

  
    - *(string) --* 

    

  :type status: string
  :param status: 

    The status of the virtual interface failover test.

    

  
  :type maxResults: integer
  :param 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 nextToken: string
  :param nextToken: 

    The token for the next page of results.

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'virtualInterfaceTestHistory': [
              {
                  'testId': 'string',
                  'virtualInterfaceId': 'string',
                  'bgpPeers': [
                      'string',
                  ],
                  'status': 'string',
                  'ownerAccount': 'string',
                  'testDurationInMinutes': 123,
                  'startTime': datetime(2015, 1, 1),
                  'endTime': datetime(2015, 1, 1)
              },
          ],
          'nextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **virtualInterfaceTestHistory** *(list) --* 

        The ID of the tested virtual interface.

        
        

        - *(dict) --* 

          Information about the virtual interface failover test.

          
          

          - **testId** *(string) --* 

            The ID of the virtual interface failover test.

            
          

          - **virtualInterfaceId** *(string) --* 

            The ID of the tested virtual interface.

            
          

          - **bgpPeers** *(list) --* 

            The BGP peers that were put in the DOWN state as part of the virtual interface failover test.

            
            

            - *(string) --* 
        
          

          - **status** *(string) --* 

            The status of the virtual interface failover test.

            
          

          - **ownerAccount** *(string) --* 

            The owner ID of the tested virtual interface.

            
          

          - **testDurationInMinutes** *(integer) --* 

            The time that the virtual interface failover test ran in minutes.

            
          

          - **startTime** *(datetime) --* 

            The time that the virtual interface moves to the DOWN state.

            
          

          - **endTime** *(datetime) --* 

            The time that the virtual interface moves out of the DOWN state.

            
      
    
      

      - **nextToken** *(string) --* 

        The token to use to retrieve the next page of results. This value is ``null`` when there are no more results to return.

        
  
  **Exceptions**
  
  *   :py:class:`DirectConnect.Client.exceptions.DirectConnectServerException`

  
  *   :py:class:`DirectConnect.Client.exceptions.DirectConnectClientException`

  