Getting Information About Your Virtual Private Gateways for DirectLink

You can get information about your virtual private gateways that you can use as a target for one or more private virtual interfaces. The virtual private gateway must be in the available state and attached to the VPC you want to access.

If you exceed the number of identical requests allowed for a configured time period, the Throttling error message is returned.

This procedure uses AWS CLI only. Information about these resources is also available from Cockpit v1. For more information, see DirectLink User Interface.

To get information about your virtual private gateways, use the describe-virtual-gateways command following this syntax:

Request sample
$ aws directconnect describe-virtual-gateways \
    --profile YOUR_PROFILE \

This command contains the following attributes that you need to specify:

  • (optional) profile: The named profile you want to use, created when configuring AWS CLI. For more information, see Installing and Configuring AWS CLI.

  • endpoint: The endpoint corresponding to the Region you want to send the request to.

The describe-virtual-gateways command returns the following elements:

  • virtualGateways: Information about one or more virtual private gateways. This element contains the following information for each virtual private gateway:

    • virtualGatewayId: The ID of the virtual private gateway.

    • virtualGatewayState: The state of the virtual private gateway (pending | available | deleting | deleted).

Result sample
    "virtualGateways": [
            "virtualGatewayId": "vgw-87654321",
            "virtualGatewayState": "available"

Related Pages

Corresponding API Method

AWS™ and Amazon Web Services™ are trademarks of Amazon Technologies, Inc or its affiliates in the United States and/or other countries.