Amazon Elastic Compute Cloud
API Reference (API Version 2013-02-01)
AWS Documentation » Amazon EC2 » API Reference » Actions » DescribeVpnGateways
« PreviousNext »
View the PDF for this guide.Go to the AWS Discussion Forum for this product.Did this page help you?  Yes | No |  Tell us about it...

DescribeVpnGateways

Description

Describes one or more of your virtual private gateways.

For more information about virtual private gateways, see Adding an IPsec Hardware Virtual Private Gateway to Your VPC in the Amazon Virtual Private Cloud User Guide.

Request Parameters

VpnGatewayId.n

A virtual private gateway ID. You can specify more than one in the request.

Type: String

Default: Describes your virtual private gateways.

Required: No

Filter.n.Name

The name of a filter. See the Supported Filters section for a list of supported filter names.

Type: String

Default: None

Required: No

Filter.n.Value.m

A value for the filter. See the Supported Filters section for a list of supported values for each filter.

Type: String

Default: None

Required: No

Supported Filters

You can specify filters so that the response includes information for only certain virtual private gateways. For example, you can use a filter to specify that you're interested in the virtual private gateways in the pending or available state. You can specify multiple values for a filter. The response includes information for a virtual private gateway only if it matches at least one of the filter values that you specified.

You can specify multiple filters; for example, specify virtual private gateways that are in a specific Availability Zone and are in the pending or available state. The response includes information for a virtual private gateway only if it matches all the filters that you specified. If there's no match, no special message is returned, the response is simply empty.

You can use wildcards in a filter value. An asterisk (*) matches zero or more characters, and a question mark (?) 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 are the available filters.

attachment.state

The current state of the attachment between the gateway and the VPC.

Type: String

Valid values: attaching | attached | detaching | detached

attachment.vpc-id

The ID of an attached VPC.

Type: String

availability-zone

The Availability Zone for the virtual private gateway.

Type: String

state

The state of the virtual private gateway.

Type: String

Valid values: pending | available | deleting | deleted

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 filter.

For more information about tags, see Tagging Your Resources in the Amazon Elastic Compute Cloud User Guide.

Type: String

tag-value

The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

Type: String

tag:key

Filters the response based on a specific tag/value combination.

Example: To list just the resources that have been assigned tag Purpose=X, specify:

Filter.1.Name=tag:Purpose

Filter.1.Value.1=X

Example: To list just resources that have been assigned tag Purpose=X OR Purpose=Y, specify:

Filter.1.Name=tag:Purpose

Filter.1.Value.1=X

Filter.1.Value.2=Y

type

The type of virtual private gateway. Currently the only supported type is ipsec.1.

Type: String

Valid values: ipsec.1

vpn-gateway-id

The ID of the virtual private gateway.

Type: String

Response Elements

The following elements are returned in a DescribeVpnGatewaysResponse element.

requestId

The ID of the request.

Type: xsd:string

vpnGatewaySet

A list of virtual private gateways. Each virtual private gateway is wrapped in an item element.

Type: VpnGatewayType

Examples

Example Request

This example gives a description of the virtual private gateway with ID vgw-8db04f81.

https://ec2.amazonaws.com/?Action=DescribeVpnGateways
&VpnGatewayId.1=vgw-8db04f81
&AUTHPARAMS

Example Response

<DescribeVpnGatewaysResponse xmlns="http://ec2.amazonaws.com/doc/2013-02-01/">
  <requestId>7a62c49f-347e-4fc4-9331-6e8eEXAMPLE</requestId>
  <vpnGatewaySet>	
    <item>
      <vpnGatewayId>vgw-8db04f81</vpnGatewayId>
      <state>available</state>
      <type>ipsec.1</type>
      <availabilityZone>us-east-1a</availabilityZone> 
      <attachments>
        <item>
          <vpcId>vpc-1a2b3c4d<vpcId>
          <state>attached</state>
        </item>
      </attachments>
      <tagSet/>
    </item>
  </vpnGatewaySet>
</DescribeVpnGatewaysResponse>

Example Request

This example uses filters to give a description of any virtual private gateway you own that is in the us-east-1a Availability Zone, and whose state is either pending or available.

https://ec2.amazonaws.com/?Action=DescribeVpnGateways
&Filter.1.Name=availability-zone
&Filter.1.Value.1=us-east-1a
&Filter.2.Name=state
&Filter.2.Value.1=pending
&Filter.2.Value.2=available
&AUTHPARAMS
Document Conventions« PreviousNext »
Terms of UseDid this page help you?  Yes | No |  Tell us about it...