POST /#Action=DescribeVpnConnections

Describes one or more of your VPN connections.

For more information, see Amazon Web Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN User Guide.

Servers

https://ec2.{region}.amazonaws.com
https://ec2.amazonaws.com
https://ec2.{region}.amazonaws.com.cn

Request headers

Name	Type	Required	Description
`X-Amz-Content-Sha256`	String	No
`X-Amz-Credential`	String	No
`Content-Type`	String	Yes	The media type of the request body. Default value: "text/xml"
`X-Amz-Date`	String	No
`X-Amz-Algorithm`	String	No
`X-Amz-SignedHeaders`	String	No
`X-Amz-Security-Token`	String	No
`X-Amz-Signature`	String	No

Query parameters

Name Type Required Description

Name	Type	Required	Description
`Version`	String	Yes	Possible values: `"2016-11-15"`
`Action`	String	Yes	Possible values: `"DescribeVpnConnections"`

Version

String

Yes

Possible values:

"2016-11-15"

Action

String

Yes

Possible values:

"DescribeVpnConnections"

Request body fields

Name Type Required Description

Name	Type	Required	Description
`VpnConnectionIds[]`	Array	No	One or more VPN connection IDs. Default: Describes your VPN connections.
`Filters[]`	Array	No	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> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key `Owner` and the value `TeamA`, specify `tag:Owner` for the filter name and `TeamA` for the filter value. `tag-key` - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value. `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. `transit-gateway-id` - The ID of a transit gateway associated with the VPN connection.
`DryRun`	Boolean	No	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`.

VpnConnectionIds[]

Array

One or more VPN connection IDs.

Default: Describes your VPN connections.

Filters[]

Array

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> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
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.
transit-gateway-id - The ID of a transit gateway associated with the VPN connection.

DryRun

Boolean

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.

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.