AWS Direct Connect

Lists the virtual interface failover test history.

See also: AWS API Documentation

Request Syntax

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.

Starts the virtual interface failover test that verifies your configuration meets your resiliency requirements by placing the BGP peering session in the DOWN state. You can then send traffic to verify that there are no outages.

You can run the test on public, private, transit, and hosted virtual interfaces.

You can use ListVirtualInterfaceTestHistory to view the virtual interface test history.

If you need to stop the test before the test interval completes, use StopBgpFailoverTest.

See also: AWS API Documentation

Request Syntax

client.start_bgp_failover_test(
    virtualInterfaceId='string',
    bgpPeers=[
        'string',
    ],
    testDurationInMinutes=123
)

type virtualInterfaceId:

string

param virtualInterfaceId:

[REQUIRED]

The ID of the virtual interface you want to test.

type bgpPeers:

list

param bgpPeers:

The BGP peers to place in the DOWN state.

• (string) --

type testDurationInMinutes:

integer

param testDurationInMinutes:

The time in minutes that the virtual interface failover test will last.

Maximum value: 180 minutes (3 hours).

Default: 180 minutes (3 hours).

rtype:

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.

Stops the virtual interface failover test.

See also: AWS API Documentation

Request Syntax

client.stop_bgp_failover_test(
    virtualInterfaceId='string'
)

type virtualInterfaceId:

string

param virtualInterfaceId:

[REQUIRED]

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

rtype:

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.