describe_instances ( $opt )

The DescribeInstances operation returns information about instances that you own.

If you specify one or more instance IDs, Amazon EC2 returns information for those instances. If you do not specify instance IDs, Amazon EC2 returns information for all relevant instances. If you specify an invalid instance ID, a fault is returned. If you specify an instance that you do not own, it will not be included in the returned results.

Recently terminated instances might appear in the returned results. This interval is usually less than one hour.

Access

public

Parameters

Parameter

Type

Required

Description

$opt

array

Optional

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

  • InstanceId - string|array - Optional - An optional list of the instances to describe. 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 Instances. 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 instances.

$ec2 = new AmazonEC2();

$response = $ec2->describe_instances();

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

Filter instances.

$ec2 = new AmazonEC2();

$response = $ec2->describe_instances(array(
	'Filter' => array(
		array('Name' => 'architecture', 'Value' => 'x86_64'),
		array('Name' => 'root-device-type', 'Value' => 'ebs'),
		array('Name' => 'virtualization-type', 'Value' => 'paravirtual'),
	)
));

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_instances($opt = null)
{
    if (!$opt) $opt = array();
            
    // Optional list (non-map)
    if (isset($opt['InstanceId']))
    {
        $opt = array_merge($opt, CFComplexType::map(array(
            'InstanceId' => (is_array($opt['InstanceId']) ? $opt['InstanceId'] : array($opt['InstanceId']))
        )));
        unset($opt['InstanceId']);
    }
    
    // Optional list + map
    if (isset($opt['Filter']))
    {
        $opt = array_merge($opt, CFComplexType::map(array(
            'Filter' => $opt['Filter']
        )));
        unset($opt['Filter']);
    }

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

Copyright © 2010–2013 Amazon Web Services, LLC


Feedback