         | Did this page help you? Yes No Tell us about it... |
DescribeVpnGateways
Description
Gives you information about your virtual private gateways. You can filter the results to
return information only about virtual private gateways that match criteria you specify. For
example, you could get information only about virtual private gateways whose state is
pending or available. You can specify multiple values
for the filter. A virtual private gateway must match at least one of the specified values for it
to be included in the results.
You can specify multiple filters (e.g., the virtual private gateway is in a particular
Availability Zone and the gateway's state is pending or
available). The result includes information for a particular virtual private gateway
only if it matches all your filters. If there's no
match, no special message is returned; the response is simply empty.
You can use wildcards with the filter values: * matches zero or more characters, and ? matches exactly one character. You can escape special characters using a backslash before the character. For example, a value of \*amazon\?\\ searches for the literal string *amazon?\.
The following table shows the available filters.
| Filter Name | Description |
|---|---|
|
|
Current state of the attachment between the gateway and the VPC. Type: String Valid Values: |
|
|
ID of an attached VPC. Type: String |
|
|
The Availability Zone the virtual private gateway is in. Type: String |
|
|
The state of the virtual private gateway. Type: String Valid Values: |
|
|
Key of a tag assigned to the resource. This filter is independent of the For more information about tags, go to Using Tags in the Amazon Elastic Compute Cloud User Guide. Type: String |
|
|
Value of a tag assigned to the resource. This filter is independent of the Type: String |
|
|
Filters the results based on a specific tag/value combination. Example: To list just the resources assigned tag Purpose=X, then specify:
Example: To list just resources assigned tag Purpose=X OR Purpose=Y, then specify:
|
|
|
The type of virtual private gateway. Currently the only supported type is
Type: String Valid Values: |
|
|
ID of the virtual private gateway. Type: String |
For more information about Amazon Virtual Private Cloud and virtual private gateways, go to Adding an IPsec Hardware Virtual Private Gateway to Your VPC in the Amazon Virtual Private Cloud User Guide.
Request Parameters
| Name | Description | Required |
|---|---|---|
|
|
A virtual private gateway ID. You can specify more than one in the request. Type: String Default: Returns information about all your virtual private gateways. |
No |
|
|
Name of a filter. See the preceding table for a list of allowed filter names. Type: String Default: Returns information about all your virtual private gateways or those you specify by ID. |
No |
|
|
A value for the filter. See the preceding table for a list of allowed values for each filter. Type: String Default: None |
No |
Response Elements
The elements in the following table are wrapped in an
DescribeVpnGatewaysResponsestructure.
| Name | Description |
|---|---|
|
|
The ID of the request. Type: xsd:string |
|
|
A list of virtual private gateways. Each virtual private gateway's information is
wrapped in an Type: VpnGatewayType |
Examples
Example Request
This example gives a description of the virtual private gateway with ID vgw-8db04f81.
https://ec2.amazonaws.com/?Action=DescribeVpnGateways &VpnGatewayId.1=vgw-8db04f81 &AUTHPARAMS
Example Response
<DescribeVpnGatewaysResponse xmlns="http://ec2.amazonaws.com/doc/2012-04-01/">
<requestId>7a62c49f-347e-4fc4-9331-6e8eEXAMPLE</requestId>
<vpnGatewaySet>
<item>
<vpnGatewayId>vgw-8db04f81</vpnGatewayId>
<state>available</state>
<type>ipsec.1</type>
<availabilityZone>us-east-1a</availabilityZone>
<attachments>
<item>
<vpcId>vpc-1a2b3c4d<vpcId>
<state>attached</state>
</item>
</attachments>
<tagSet/>
</item>
</vpnGatewaySet>
</DescribeVpnGatewaysResponse>Example Request
This example uses filters to give a description of any virtual private gateway you own
that is in the us-east-1a Availability Zone, and whose state is either
pending or available.
https://ec2.amazonaws.com/?Action=DescribeVpnGateways &Filter.1.Name=availability-zone &Filter.1.Value.1=us-east-1a &Filter.2.Name=state &Filter.2.Value.1=pending &Filter.2.Value.2=available &AUTHPARAMS
