describe_instance_attribute ( $instance_id, $attribute, $opt )

Returns information about an attribute of an instance. Only one attribute can be specified per call.

Access

public

Parameters

Parameter

Type

Required

Description

$instance_id

string

Required

The ID of the instance whose instance attribute is being described.

$attribute

string

Required

The name of the attribute to describe. Available attribute names: instanceType, kernel, ramdisk, userData, disableApiTermination, instanceInitiatedShutdownBehavior, rootDeviceName, blockDeviceMapping [Allowed values: instanceType, kernel, ramdisk, userData, disableApiTermination, instanceInitiatedShutdownBehavior, rootDeviceName, blockDeviceMapping, productCodes, sourceDestCheck, groupSet, ebsOptimized]

$opt

array

Optional

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

  • 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 the attributes of a given instance.

// Instantiate the class
$ec2 = new AmazonEC2();

$response = $ec2->describe_instance_attribute('i-1f549375', 'instanceType');

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

Related Methods

Source

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

public function describe_instance_attribute($instance_id, $attribute, $opt = null)
{
    if (!$opt) $opt = array();
    $opt['InstanceId'] = $instance_id;
    $opt['Attribute'] = $attribute;
    
    return $this->authenticate('DescribeInstanceAttribute', $opt);
}

Copyright © 2010–2013 Amazon Web Services, LLC


Feedback