This operation returns a description of the gateway volumes specified in the request. This
operation is supported only for the gateway-cached volume architecture.
The list of gateway volumes in the request must be from one gateway. In the response Amazon
Storage Gateway returns volume information sorted by volume Amazon Resource Name (ARN).
Access
Parameters
Parameter |
Type |
Required |
Description |
$opt
|
array
|
Optional
|
An associative array of parameters that can have the following keys:
VolumeARNs - string|array - Required - An array of strings, where each string represents the Amazon Resource Name (ARN) of a cached volume. All of the specified cached volumes must be from the same gateway. Use ListVolumes to get volume ARNs of a gateway. 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
Source
Method defined in services/storagegateway.class.php | Toggle source view (12 lines) | View on GitHub
public function describe_cached_iscsi_volumes($opt = null)
{
if (!$opt) $opt = array();
// List (non-map)
if (isset($opt['VolumeARNs']))
{
$opt['VolumeARNs'] = (is_array($opt['VolumeARNs']) ? $opt['VolumeARNs'] : array($opt['VolumeARNs']));
}
return $this->authenticate('DescribeCachediSCSIVolumes', $opt);
}