describe_network_interfaces ( $opt )

Access

public

Parameters

Parameter

Type

Required

Description

$opt

array

Optional

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

  • NetworkInterfaceId - string|array - Optional - Pass a string for a single value, or an indexed array for multiple values.
  • Filter - array - Optional - A filter used to limit results when describing tags. Multiple values can be specified per filter. A tag must match at least one of the specified values for it to be returned from an operation. Wildcards can be included in filter values; * specifies that zero or more characters must match, and ? specifies that exactly one character must match. Use a backslash to escape special characters. For example, a filter value of \*amazon\?\\ specifies the literal string *amazon?\.
    • 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

List the network interfaces.

$ec2 = new AmazonEC2();

$response = $ec2->describe_network_interfaces();

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

Source

Method defined in services/ec2.class.php | Toggle source view (24 lines) | View on GitHub

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

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

Copyright © 2010–2013 Amazon Web Services, LLC


Feedback