Menu
Amazon Elastic Compute Cloud
API Reference (API Version 2016-11-15)

DescribeVpnGateways

Describes one or more of your virtual private gateways.

For more information about virtual private gateways, see Adding an IPsec Hardware VPN to Your VPC in the Amazon Virtual Private Cloud User Guide.

Request Parameters

The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see Common Query Parameters.

DryRun

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Type: Boolean

Required: No

Filter.N

One or more filters.

  • attachment.state - The current state of the attachment between the gateway and the VPC (attaching | attached | detaching | detached).

  • attachment.vpc-id - The ID of an attached VPC.

  • availability-zone - The Availability Zone for the virtual private gateway (if applicable).

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

  • tag:key=value - The key/value combination of a tag assigned to the resource. Specify the key of the tag in the filter name and the value of the tag in the filter value. For example, for the tag Purpose=X, specify tag:Purpose for the filter name and X for the filter value.

  • tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter "tag-key=Purpose" and the filter "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • type - The type of virtual private gateway. Currently the only supported type is ipsec.1.

  • vpn-gateway-id - The ID of the virtual private gateway.

Type: Array of Filter objects

Required: No

VpnGatewayId.N

One or more virtual private gateway IDs.

Default: Describes all your virtual private gateways.

Type: Array of strings

Required: No

Response Elements

The following elements are returned by the service.

requestId

The ID of the request.

Type: String

vpnGatewaySet

Information about one or more virtual private gateways.

Type: Array of VpnGateway objects

Errors

For information about the errors that are common to all actions, see Common Errors.

Examples

Example 1

This example describes the specified virtual private gateway.

Sample Request

Copy
https://ec2.amazonaws.com/?Action=DescribeVpnGateways &VpnGatewayId.1=vgw-8db04f81 &AUTHPARAMS

Sample Response

Copy
<DescribeVpnGatewaysResponse xmlns="http://ec2.amazonaws.com/doc/2016-11-15/"> <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 2

This example uses filters to describe any virtual private gateway you own whose state is either pending or available.

Sample Request

Copy
https://ec2.amazonaws.com/?Action=DescribeVpnGateways &Filter.1.Name=state &Filter.1.Value.1=pending &Filter.1.Value.2=available &AUTHPARAMS

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: