DirectConnect / Client / describe_virtual_gateways



Lists the virtual private gateways owned by the Amazon Web Services account.

You can create one or more Direct Connect private virtual interfaces linked to a virtual private gateway.

See also: AWS API Documentation

Request Syntax

response = client.describe_virtual_gateways()
Return type:



Response Syntax

    'virtualGateways': [
            'virtualGatewayId': 'string',
            'virtualGatewayState': 'string'

Response Structure

  • (dict) –

    • virtualGateways (list) –

      The virtual private gateways.

      • (dict) –

        Information about a virtual private gateway for a private virtual interface.

        • virtualGatewayId (string) –

          The ID of the virtual private gateway.

        • virtualGatewayState (string) –

          The state of the virtual private gateway. The following are the possible values:

          • pending: Initial state after creating the virtual private gateway.

          • available: Ready for use by a private virtual interface.

          • deleting: Initial state after deleting the virtual private gateway.

          • deleted: The virtual private gateway is deleted. The private virtual interface is unable to send traffic over this gateway.


  • DirectConnect.Client.exceptions.DirectConnectServerException

  • DirectConnect.Client.exceptions.DirectConnectClientException