delete_virtual_interface

DirectConnect.Client.delete_virtual_interface(**kwargs)

Deletes a virtual interface.

See also: AWS API Documentation

Request Syntax

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

Parameters

virtualInterfaceId (string) --

[REQUIRED]

The ID of the virtual interface.

Return type

dict

Returns

Response Syntax

{
    'virtualInterfaceState': 'confirming'|'verifying'|'pending'|'available'|'down'|'deleting'|'deleted'|'rejected'|'unknown'
}

Response Structure

• (dict) --
  • virtualInterfaceState (string) --

    The state of the virtual interface. The following are the possible values:

    • confirming : The creation of the virtual interface is pending confirmation from the virtual interface owner. If the owner of the virtual interface is different from the owner of the connection on which it is provisioned, then the virtual interface will remain in this state until it is confirmed by the virtual interface owner.
    • verifying : This state only applies to public virtual interfaces. Each public virtual interface needs validation before the virtual interface can be created.
    • pending : A virtual interface is in this state from the time that it is created until the virtual interface is ready to forward traffic.
    • available : A virtual interface that is able to forward traffic.
    • down : A virtual interface that is BGP down.
    • deleting : A virtual interface is in this state immediately after calling DeleteVirtualInterface until it can no longer forward traffic.
    • deleted : A virtual interface that cannot forward traffic.
    • rejected : The virtual interface owner has declined creation of the virtual interface. If a virtual interface in the Confirming state is deleted by the virtual interface owner, the virtual interface enters the Rejected state.
    • unknown : The state of the virtual interface is not available.

Exceptions

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