DescribeCustomerGateways

GET /?Action=DescribeCustomerGateways
Description

Describes one or more of your customer gateways.
You can use the Filter.N parameter to filter the customer gateways on the following properties:

  • state: The state of the customer gateway (pending | available | deleting | deleted).

  • customer-gateway-id: The ID of the customer gateway.

  • ip-address: The public IPv4 address of the customer gateway.

  • bgp-asn: The ASN number.

  • type: The type of communication tunnel to the gateway.

  • tag-key: The key of a tag associated with the resource.

  • tag-value: The value of a tag associated with the resource.

  • tag:XXXX: The value of a tag associated with the resource, where XXXX is the key of the tag.

Note

  • If you provide an invalid customer gateway ID, a response 400 is returned without any information about customer gateways for which you provided a valid ID.

  • If you exceed the number of identical requests allowed for a configured time period, the RequestLimitExceeded error message is returned.
Body parameter

Required: false
Name: DescribeCustomerGatewaysRequest

Name Description Required Schema Default Example

CustomerGatewayId.N

One or more customer gateways IDs.

false

string

Filter.N

One or more filters. Example:
osc-cli fcu DescribeCustomerGateways \
  --Filter.1.Name "tag:KEYOFTHETAG" \
  --Filter.1.Value.1 "VALUEOFTHETAG"

false

Filter
Responses
HTTP Code 200
HTTP Code Description Schema

200

DescribeCustomerGatewayResult

Response 200

Response 200

Name Description Required Schema Default Example

customerGatewaySet.N

Information about one or more customer gateways.

false

CustomerGateway

requestId

The ID of the request.

false

string