DescribeCustomerGateways#

Description#

Describes one or more of your VPN customer gateways. It is possible to use one or more filters values for customer gateways.

Request Parameters#

  • CustomerGatewayId — The ID of the customer gateway.

    • Type: String

    • Required: No

  • Filter.N — One or more filters.

    • Type: List of Filter objects

    • Required: No

Supported 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 Internet-routable IP address of the customer gateway’s outside interface.

  • state — The current state of the customer gateway.

  • tag-key — The tag key. Such a filter allows you to get resources with the specified key and any value.

  • tag:<tag-key> — The key/value a pair of a tag. The tag key is passed in the filter name, while the tag value is used as the filter value.

  • type — Type of customer gateway.

Response Elements#

  • customerGatewaySet — Information about customer gateways.

  • requestId — The request ID.

    • Type: String

Examples#

c2-ec2 DescribeCustomerGateways

c2-ec2 DescribeCustomerGateways CustomerGatewayId.1 <cgw_id>

c2-ec2 DescribeCustomerGateways Filter.1.Name state Filter.1.Value.1 available

c2-ec2 DescribeCustomerGateways Filter.1.Name tag:<tag-key> Filter.1.Value <tag-value>

c2-ec2 DescribeCustomerGateways Filter.1.Name tag-key Filter.1.Value <tag-key>