POST /#Action=DescribeVpnGateways

Describes one or more of your virtual private gateways.

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: `"DescribeVpnGateways"`

Version

String

Yes

Possible values:

"2016-11-15"

Action

String

Yes

Possible values:

"DescribeVpnGateways"

Request body fields

Name Type Required Description

Name	Type	Required	Description
`VpnGatewayIds[]`	Array	No	One or more virtual private gateway IDs. Default: Describes all your virtual private gateways.
`Filters[]`	Array	No	One or more filters. `amazon-side-asn` - The Autonomous System Number (ASN) for the Amazon side of the gateway. `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> - 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 virtual private gateway. Currently the only supported type is `ipsec.1`. `vpn-gateway-id` - The ID of the virtual private gateway.
`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`.

VpnGatewayIds[]

Array

One or more virtual private gateway IDs.

Default: Describes all your virtual private gateways.

Filters[]

Array

One or more filters.

amazon-side-asn - The Autonomous System Number (ASN) for the Amazon side of the gateway.
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> - 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 virtual private gateway. Currently the only supported type is ipsec.1.
vpn-gateway-id - The ID of the virtual private gateway.

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.