DirectConnect / Client / list_virtual_interface_test_history

list_virtual_interface_test_history#

DirectConnect.Client.list_virtual_interface_test_history(**kwargs)#

Lists the virtual interface failover test history.

See also: AWS API Documentation

Request Syntax

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

  • testId (string) – The ID of the virtual interface failover test.

  • virtualInterfaceId (string) – The ID of the virtual interface that was tested.

  • bgpPeers (list) –

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

    • (string) –

  • status (string) – The status of the virtual interface failover test.

  • maxResults (integer) –

    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.

  • nextToken (string) – The token for the next page of results.

Return type:

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

  • DirectConnect.Client.exceptions.DirectConnectServerException

  • DirectConnect.Client.exceptions.DirectConnectClientException