The DescribeRegions operation describes regions zones that are currently available to the
account.
Access
Parameters
Parameter |
Type |
Required |
Description |
$opt
|
array
|
Optional
|
An associative array of parameters that can have the following keys:
RegionName - string|array - Optional - The optional list of regions 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 Regions. 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 available regions.
$ec2 = new AmazonEC2();
$response = $ec2->describe_regions();
var_dump($response->isOK());
Result:
bool(true)
Describe a specific region.
$ec2 = new AmazonEC2();
$response = $ec2->describe_regions(array(
'RegionName' => 'us-west-1'
));
var_dump($response->isOK());
Result:
bool(true)
Describe multiple regions.
$ec2 = new AmazonEC2();
$response = $ec2->describe_regions(array(
'RegionName' => array(
'us-west-1',
'us-east-1',
'eu-west-1',
'ap-southeast-1'
)
));
var_dump($response->isOK());
Result:
bool(true)
Filter available regions.
$ec2 = new AmazonEC2();
$response = $ec2->describe_regions(array(
'Filter' => array(
array('Name' => 'endpoint', 'Value' => 'ec2.us-east-1.amazonaws.com')
)
));
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_regions($opt = null)
{
if (!$opt) $opt = array();
// Optional list (non-map)
if (isset($opt['RegionName']))
{
$opt = array_merge($opt, CFComplexType::map(array(
'RegionName' => (is_array($opt['RegionName']) ? $opt['RegionName'] : array($opt['RegionName']))
)));
unset($opt['RegionName']);
}
// Optional list + map
if (isset($opt['Filter']))
{
$opt = array_merge($opt, CFComplexType::map(array(
'Filter' => $opt['Filter']
)));
unset($opt['Filter']);
}
return $this->authenticate('DescribeRegions', $opt);
}