         | Did this page help you? Yes No Tell us about it... |
DescribeVpnConnections
Description
Gives you information about your VPN connections.
![[Important]](http://docs.amazonwebservices.com/docs-common/images/important.png) | Important |
|---|---|
We strongly recommend you use HTTPS when calling this operation because the response contains sensitive cryptographic information for configuring your customer gateway. |
You can filter the results to return information only about VPN connections that
match criteria you specify. For example, you could get information only about VPN
connections whose state is pending or available. You can
specify multiple values for the filter. A VPN connection 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 VPN connection is associated with a
particular virtual private gateway, and the gateway's state is pending or
available). The result includes information for a particular VPN
connection 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 |
|---|---|
|
|
Configuration information for the customer gateway. Type: String |
|
|
The ID of a customer gateway associated with the VPN connection. Type: String |
|
|
The state of the VPN connection. 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 VPN connection. Currently the only supported type is
Type: String Valid Values: |
|
|
ID of the VPN connection. Type: String |
|
|
The ID of a virtual private gateway associated with the VPN connection. Type: String |
For more information about Amazon Virtual Private Cloud and VPN connections, go to Adding an IPsec Hardware Virtual Private Gateway to Your VPC in the Amazon Virtual Private Cloud User Guide.
![[Note]](http://docs.amazonwebservices.com/docs-common/images/note.png) | Note |
|---|---|
You can get the customer gateway configuration information in a friendly format by using the ec2-describe-vpn-connections command instead. For more information, go to ec2-describe-vpn-connections in the Amazon Virtual Private Cloud Command Line Reference. |
Request Parameters
| Name | Description | Required |
|---|---|---|
|
|
A VPN connection ID. You can specify more than one in the request. Type: String Default: Returns information about all your VPN connections |
No |
|
|
Name of a filter. See the preceding table for a list of allowed filter names. Type: String Default: Returns information about all your VPN connections 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
DescribeVpnConnectionsResponse structure.
| Name | Description |
|---|---|
|
|
The ID of the request. Type: xsd:string |
|
|
A list of VPN connections. Each VPN connection's
information is wrapped in an Type: VpnConnectionType |
Examples
Example Request
This example gives a description of the VPN connection with ID vpn-44a8938f.
The response includes the customer gateway configuration information. Because
it's a long set of information, we haven't displayed it here. You can see an
example in the topic for CreateVpnConnection.
https://ec2.amazonaws.com/?Action=DescribeVpnConnections &VpnConnectionId.1=vpn-44a8938f &AUTHPARAMS
Example Response
<DescribeVpnConnectionsResponse xmlns="http://ec2.amazonaws.com/doc/2012-04-01/">
<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 Request
This example gives a description of any VPN connection you own associated with
the customer gateway with ID cgw-b4dc3961, and whose state is either
pending or available.
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
