|« PreviousNext »|
|Did this page help you? Yes | No | Tell us about it...|
Describes one or more of your VPN customer gateways.
For more information about VPN customer gateways, see Adding a Hardware Virtual Private Gateway to Your VPC in the Amazon Virtual Private Cloud User Guide.
A customer gateway ID. You can specify more than one in the request.
Default: Describes your customer gateways.
The name of a filter. See the Supported Filters section for a list of supported filter names.
A value for the filter. See the Supported Filters section for a list of supported values for each filter.
You can specify filters so that the response includes information for only certain customer gateways.
For example, you can use a filter to specify that you're interested in customer gateways in the
available state. You can specify multiple values for a filter. The response includes information for
a customer gateway only if it matches at least one of the of the filter values that you specified.
You can specify multiple filters; for example, specify customer gateways that have a specific IP
address for the Internet-routable external interface and are in the
The response includes information for a customer 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
The following are the available filters.
The customer gateway's Border Gateway Protocol (BGP) Autonomous System Number (ASN).
The ID of the customer gateway.
The IP address of the customer gateway's Internet-routable external
interface (for example,
The state of the customer gateway.
The type of customer gateway. Currently the only supported type is
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
For more information about tags, see Tagging Your Resources in the Amazon Elastic Compute Cloud User Guide.
The value of a tag assigned to the resource. This filter is independent of the
Filters the response based on a specific tag/value combination.
Example: To list just the resources that have been assigned tag Purpose=X, specify:
Example: To list just resources that have been assigned tag Purpose=X OR Purpose=Y, specify:
The following elements are returned in an
The ID of the request.
A list of customer gateways, each one wrapped in an
This example gives a description of the customer gateway with ID cgw-b4dc3961.
https://ec2.amazonaws.com/?Action=DescribeCustomerGateways &CustomerGatewayId.1=cgw-b4dc3961 &AUTHPARAMS
<DescribeCustomerGatewaysResponse xmlns="http://ec2.amazonaws.com/doc/2013-02-01/"> <requestId>7a62c49f-347e-4fc4-9331-6e8eEXAMPLE</requestId> <customerGatewaySet> <item> <customerGatewayId>cgw-b4dc3961</customerGatewayId> <state>available</state> <type>ipsec.1</type> <ipAddress>18.104.22.168</ipAddress> <bgpAsn>65534</bgpasn> <tagSet/> </item> </customerGatewaySet> </DescribeCustomerGatewaysResponse>
This example uses filters to give a description of any customer gateway you
own whose IP address is 22.214.171.124, and whose state is either
https://ec2.amazonaws.com/?Action=DescribeCustomerGateways &Filter.1.Name=ip-address &Filter.1.Value.1=126.96.36.199 &Filter.2.Name=state &Filter.2.Value.1=pending &Filter.2.Value.2=available &AUTHPARAMS