stop_bgp_failover_test

DirectConnect.Client.stop_bgp_failover_test(**kwargs)

Stops the virtual interface failover test.

See also: AWS API Documentation

Request Syntax

response = client.stop_bgp_failover_test(
    virtualInterfaceId='string'
)

Parameters

virtualInterfaceId (string) --

[REQUIRED]

The ID of the virtual interface you no longer want to test.

Return type

dict

Returns

Response Syntax

{
    'virtualInterfaceTest': {
        'testId': 'string',
        'virtualInterfaceId': 'string',
        'bgpPeers': [
            'string',
        ],
        'status': 'string',
        'ownerAccount': 'string',
        'testDurationInMinutes': 123,
        'startTime': datetime(2015, 1, 1),
        'endTime': datetime(2015, 1, 1)
    }
}

Response Structure

• (dict) --
  • virtualInterfaceTest (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.

Exceptions

• DirectConnect.Client.exceptions.DirectConnectServerException
• DirectConnect.Client.exceptions.DirectConnectClientException