DescribeVpnConnections
GET /?Action=DescribeVpnConnections
Description
Describes one or more VPN connections.
You can use the Filter.N
parameter to filter the VPN connections on the following properties:
-
bgp-asn
: The Border Gateway Protocol (BGP) Autonomous System Number (ASN) of the connection. -
customer-gateway-configuration
: The XML configuration of the customer gateway connection. -
customer-gateway-id
: The ID of the customer gateway. -
option.static-routes-only
: Whether the connection has static routes only. -
route.destination-cidr-block
: The destination CIDR block. -
state
: The state of the connection (pending
|available
|deleting
|deleted
). -
type
: The type of connection (onlyipsec.1
is supported). -
vpn-gateway-id
: The ID of the virtual private gateway. -
vpn-connection-id
: The ID of the VPN connection. -
tag-key
: The key of a tag associated with the resource. -
tag-value
: The value of a tag associated with the resource. -
tag:XXXX
: The value of a tag associated with the resource, whereXXXX
is the key of the tag.
Note
|
If you exceed the number of identical requests allowed for a configured time period, the |
Body parameter
Required: false
Name: DescribeVpnConnectionsRequest
Name | Description | Required | Schema | Default | Example |
---|---|---|---|---|---|
DryRun |
If set to |
false |
boolean |
||
Filter.N |
One or more filters. Example: |
false |
|||
VpnConnectionId.N |
One or more VPN connections IDs. |
false |
string |
Responses
HTTP Code 200
HTTP Code | Description | Schema |
---|---|---|
200 |
DescribeVpnConnectionsResult |
Response 200
Name | Description | Required | Schema | Default | Example |
---|---|---|---|---|---|
requestId |
The ID of the request. |
false |
string |
||
vpnConnectionSet.N |
Information about one or more VPN connections. |
false |