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

DescribeVpnConnections

Describes one or more of your VPN connections.

For more information about VPN connections, see Adding a Hardware Virtual Private Gateway 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.

  • customer-gateway-configuration - The configuration information for the customer gateway.

  • customer-gateway-id - The ID of a customer gateway associated with the VPN connection.

  • state - The state of the VPN connection (pending | available | deleting | deleted).

  • option.static-routes-only - Indicates whether the connection has static routes only. Used for devices that do not support Border Gateway Protocol (BGP).

  • route.destination-cidr-block - The destination CIDR block. This corresponds to the subnet used in a customer data center.

  • bgp-asn - The BGP Autonomous System Number (ASN) associated with a BGP device.

  • 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 VPN connection. Currently the only supported type is ipsec.1.

  • vpn-connection-id - The ID of the VPN connection.

  • vpn-gateway-id - The ID of a virtual private gateway associated with the VPN connection.

Type: array of Filter objects

Required: No

VpnConnectionId.N

One or more VPN connection IDs.

Default: Describes your VPN connections.

Type: array of Strings

Required: No

Response Elements

The following elements are returned by the service.

requestId

The ID of the request.

Type: String

vpnConnectionSet

Information about one or more VPN connections.

Type: array of VpnConnection objects

Errors

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

Examples

Example 1

This example describes the specified VPN connection. The response includes the customer gateway configuration information. Because it's a long set of information, we haven't displayed it here. To see an example of the configuration information, see the Amazon Virtual Private Cloud Network Administrator Guide.

Sample Request

Copy
https://ec2.amazonaws.com/?Action=DescribeVpnConnections &VpnConnectionId.1=vpn-44a8938f &AUTHPARAMS

Sample Response

Copy
<DescribeVpnConnectionsResponse xmlns="http://ec2.amazonaws.com/doc/2016-11-15/"> <requestId>7a62c49f-347e-4fc4-9331-6e8eEXAMPLE</requestId> <vpnConnectionSet> <item> <vpnConnectionId>vpn-44a8938f</vpnConnectionId> <state>available</state> <customerGatewayConfiguration> ...Customer gateway configuration data in escaped XML format... </customerGatewayConfiguration> <type>ipsec.1</type> <customerGatewayId>cgw-b4dc3961</customerGatewayId> <vpnGatewayId>vgw-8db04f81</vpnGatewayId> <tagSet/> </item> </vpnConnectionSet> </DescribeVpnConnectionsResponse>

Example 2

This example describes any VPN connection you own that is associated with the customer gateway with ID cgw-b4dc3961, and whose state is either pending or available.

Sample Request

Copy
https://ec2.amazonaws.com/?Action=DescribeVpnConnections &Filter.1.Name=customer-gateway-id &Filter.1.Value.1=cgw-b4dc3961 &Filter.2.Name=state &Filter.2.Value.1=pending &Filter.2.Value.2=available &AUTHPARAMS

See Also

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