Describes the status of the indicated volume or, in lieu of any specified, all volumes
belonging to the caller. Volumes that have been deleted are not described.
Access
Parameters
Parameter |
Type |
Required |
Description |
$opt
|
array
|
Optional
|
An associative array of parameters that can have the following keys:
VolumeId - string|array - Optional - The optional list of EBS volumes 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 Volumes. 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
Examples
Describe EBS volumes.
$ec2 = new AmazonEC2();
$response = $ec2->describe_volumes();
var_dump($response->isOK());
Result:
bool(true)
Filter EBS volumes.
$ec2 = new AmazonEC2();
$response = $ec2->describe_volumes(array(
'Filter' => array(
array('Name' => 'attachment.status', 'Value' => 'attached' ),
array('Name' => 'status', 'Value' => 'available'),
)
));
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_volumes($opt = null)
{
if (!$opt) $opt = array();
// Optional list (non-map)
if (isset($opt['VolumeId']))
{
$opt = array_merge($opt, CFComplexType::map(array(
'VolumeId' => (is_array($opt['VolumeId']) ? $opt['VolumeId'] : array($opt['VolumeId']))
)));
unset($opt['VolumeId']);
}
// Optional list + map
if (isset($opt['Filter']))
{
$opt = array_merge($opt, CFComplexType::map(array(
'Filter' => $opt['Filter']
)));
unset($opt['Filter']);
}
return $this->authenticate('DescribeVolumes', $opt);
}