Gives you information about your customer gateways. You can filter the results to return information only about customer gateways that match criteria you specify. For example, you could ask to get information about a particular customer gateway (or all) only if the gateway’s state is pending or available. 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. The following table shows the available filters.
Access
public
Parameters
Parameter |
Type |
Required |
Description |
---|---|---|---|
|
Optional |
An associative array of parameters that can have the following keys:
|
Returns
Type |
Description |
---|---|
A |
Examples
Describe all VPC customer gateways.
$ec2 = new AmazonEC2(); $response = $ec2->describe_customer_gateways(); var_dump($response->isOK());Result:
bool(true)
Filter customer VPC gateways.
$ec2 = new AmazonEC2(); $response = $ec2->describe_customer_gateways(array( 'Filter' => array( array('Name' => 'state', 'Value' => 'available'), array('Name' => 'type', 'Value' => 'ipsec.1'), ), )); var_dump($response->isOK());Result:
bool(true)
Related Methods
Source
Method defined in services/ec2.class.php | Toggle source view (24 lines) | View on GitHub