:doc:`DirectConnect <../../directconnect>` / Client / describe_virtual_gateways

*************************
describe_virtual_gateways
*************************



.. py:method:: DirectConnect.Client.describe_virtual_gateways()

  

  .. note::

    

    Deprecated. Use ``DescribeVpnGateways`` instead. See `DescribeVPNGateways <https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeVpnGateways.html>`__ in the *Amazon Elastic Compute Cloud API Reference*.

    

   

  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 <https://docs.aws.amazon.com/goto/WebAPI/directconnect-2012-10-25/DescribeVirtualGateways>`_  


  **Request Syntax**

  ::

    response = client.describe_virtual_gateways()
  :rtype: dict
  :returns: 
    
    **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.
            

            
      
    
  
  **Exceptions**
  
  *   :py:class:`DirectConnect.Client.exceptions.DirectConnectServerException`

  
  *   :py:class:`DirectConnect.Client.exceptions.DirectConnectClientException`

  