describe-virtual-gateways¶

Description¶

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.

Synopsis¶

  describe-virtual-gateways
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options¶

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Examples¶

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

To list virtual private gateways

The following describe-virtual-gateways command lists virtual private gateways owned by your AWS account:

aws directconnect describe-virtual-gateways

Output:

{
    "virtualGateways": [
        {
            "virtualGatewayId": "vgw-aba37db6",
            "virtualGatewayState": "available"
        }
    ]
}

Output¶

virtualGateways -> (list)

The virtual private gateways.

(structure)

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.

Table of Contents

Feedback

User Guide