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.
The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see Common Query Parameters.
One or more customer gateway IDs.
Default: Describes all your customer gateways.
Type: array of Strings
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
One or more filters.
bgp-asn- The customer gateway's Border Gateway Protocol (BGP) Autonomous System Number (ASN).
customer-gateway-id- The ID of the customer gateway.
ip-address- The IP address of the customer gateway's Internet-routable external interface.
state- The state of the customer gateway (
type- The type of customer gateway. Currently, the only supported type is
tag:key=value - The key/value combination of a tag assigned to the resource. Specify the key of the tag in the filter name and the value of the tag in the filter value. For example, for the tag Purpose=X, specify
tag:Purposefor the filter name and
Xfor the filter value.
tag-key- The key of a tag assigned to the resource. This filter is independent of the
tag-valuefilter. 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-value- The value of a tag assigned to the resource. This filter is independent of the
Type: array of Filter objects
The following elements are returned by the service.
Information about one or more customer gateways.
Type: array of CustomerGateway objects
The ID of the request.
For information about the errors that are common to all actions, see Common Errors.
This example request describes the specified customer gateway.
https://ec2.amazonaws.com/?Action=DescribeCustomerGateways &CustomerGatewayId.1=cgw-b4dc3961 &AUTHPARAMS
<DescribeCustomerGatewaysResponse xmlns="http://ec2.amazonaws.com/doc/2016-11-15/"> <requestId>7a62c49f-347e-4fc4-9331-6e8eEXAMPLE</requestId> <customerGatewaySet> <item> <customerGatewayId>cgw-b4dc3961</customerGatewayId> <state>available</state> <type>ipsec.1</type> <ipAddress>22.214.171.124</ipAddress> <bgpAsn>65534</bgpasn> <tagSet/> </item> </customerGatewaySet> </DescribeCustomerGatewaysResponse>
This example request uses filters to describe any customer gateway you own
whose IP address is
126.96.36.199, and whose state is either
https://ec2.amazonaws.com/?Action=DescribeCustomerGateways &Filter.1.Name=ip-address &Filter.1.Value.1=188.8.131.52 &Filter.2.Name=state &Filter.2.Value.1=pending &Filter.2.Value.2=available &AUTHPARAMS
For more information about using this API in one of the language-specific AWS SDKs, see the following: