         | Did this page help you? Yes No Tell us about it... |
DescribeCustomerGateways
Description
Gives you information about your VPN customer gateways. You can filter the results
to return information only about customer gateways that match criteria you specify.
For example, you could get information only about gateways whose state is
pending or available. The customer gateway 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 customer gateway has a particular IP
address for the Internet-routable external interface, and the gateway's state is
pending or available). The result includes information
for a particular customer gateway only if the gateway 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 |
|---|---|
|
|
The customer gateway's Border Gateway Protocol (BGP) Autonomous System Number (ASN). Type: String |
|
|
ID of the customer gateway. Type: String |
|
|
The IP address of the customer gateway's Internet-routable external interface (e.g., 12.1.2.3). Type: String |
|
|
The state of the customer gateway. Type: String Valid Values: |
|
|
The type of customer gateway. Currently the only supported type is
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:
|
For more information about Amazon Virtual Private Cloud and VPN customer gateways, go to Adding an IPsec Hardware Virtual Private Gateway to Your VPC in the Amazon Virtual Private Cloud User Guide.
Request Parameters
| Name | Description | Required |
|---|---|---|
|
|
A customer gateway ID. You can specify more than one in the request. Type: String Default: Returns information about all your customer gateways |
No |
|
|
Name of a filter. See the preceding table for a list of allowed filter names. Type: String Default: Returns information about all your customer gateways 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
DescribeCustomerGatewaysResponse structure.
| Name | Description |
|---|---|
|
|
The ID of the request. Type: xsd:string |
|
|
A list of customer gateways. Each customer gateway's
information is wrapped in an Type: CustomerGatewayType |
Examples
Example Request
This example gives a description of the customer gateway with ID cgw-b4dc3961.
https://ec2.amazonaws.com/?Action=DescribeCustomerGateways &CustomerGatewayId.1=cgw-b4dc3961 &AUTHPARAMS
Example Response
<DescribeCustomerGatewaysResponse xmlns="http://ec2.amazonaws.com/doc/2012-04-01/">
<requestId>7a62c49f-347e-4fc4-9331-6e8eEXAMPLE</requestId>
<customerGatewaySet>
<item>
<customerGatewayId>cgw-b4dc3961</customerGatewayId>
<state>available</state>
<type>ipsec.1</type>
<ipAddress>12.1.2.3</ipAddress>
<bgpAsn>65534</bgpasn>
<tagSet/>
</item>
</customerGatewaySet>
</DescribeCustomerGatewaysResponse>Example Request
This example uses filters to give a description of any customer gateway you
own whose IP address is 12.1.2.3, and whose state is either pending
or available.
https://ec2.amazonaws.com/?Action=DescribeCustomerGateways &Filter.1.Name=ip-address &Filter.1.Value.1=12.1.2.3 &Filter.2.Name=state &Filter.2.Value.1=pending &Filter.2.Value.2=available &AUTHPARAMS
