describe_internet_gateways ( $opt )

Gives you information about your Internet gateways. You can filter the results to return information only about Internet gateways that match criteria you specify. For example, you could get information only about gateways with particular tags. The Internet gateway must match at least one of the specified values for it to be included in the results.

You can specify multiple filters (e.g., the Internet gateway is attached to a particular VPC and is tagged with a particular value). The result includes information for a particular Internet gateway only if the gateway matches all your filters. If there’s no match, no special message is returned; the response is simply empty.

You can use wildcards with the filter values: an asterisk matches zero or more characters, and ? 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 *amazon?\.

Access

public

Parameters

Parameter

Type

Required

Description

$opt

array

Optional

An associative array of parameters that can have the following keys:

  • InternetGatewayId - string|array - Optional - One or more Internet gateway IDs. Pass a string for a single value, or an indexed array for multiple values.
  • Filter - array - Optional - A list of filters used to match properties for Internet Gateways. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.
    • x - array - Optional - This represents a simple array index.
      • Name - string - Optional - Specifies the name of the filter.
      • Value - string|array - Optional - Contains one or more values for the filter. Pass a string for a single value, or an indexed array for multiple values.
  • curlopts - array - Optional - A set of values to pass directly into curl_setopt(), where the key is a pre-defined CURLOPT_* constant.
  • returnCurlHandle - boolean - Optional - A private toggle specifying that the cURL handle be returned rather than actually completing the request. This toggle is useful for manually managed batch requests.

Returns

Type

Description

CFResponse

A CFResponse object containing a parsed HTTP response.

Examples

Describe all VPC internet gateways.

$ec2 = new AmazonEC2();

$response = $ec2->describe_internet_gateways();

var_dump($response->isOK());
Result:
bool(true)

Describe a specific VPC internet gateway.

$ec2 = new AmazonEC2();

$response = $ec2->describe_internet_gateways(array(
	'InternetGatewayId' => 'igw-be7cfdd7'
));

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

public function describe_internet_gateways($opt = null)
{
    if (!$opt) $opt = array();
            
    // Optional list (non-map)
    if (isset($opt['InternetGatewayId']))
    {
        $opt = array_merge($opt, CFComplexType::map(array(
            'InternetGatewayId' => (is_array($opt['InternetGatewayId']) ? $opt['InternetGatewayId'] : array($opt['InternetGatewayId']))
        )));
        unset($opt['InternetGatewayId']);
    }
    
    // Optional list + map
    if (isset($opt['Filter']))
    {
        $opt = array_merge($opt, CFComplexType::map(array(
            'Filter' => $opt['Filter']
        )));
        unset($opt['Filter']);
    }

    return $this->authenticate('DescribeInternetGateways', $opt);
}

Copyright © 2010–2013 Amazon Web Services, LLC


Feedback