describe_vpcs ( $opt )

Gives you information about your VPCs. You can filter the results to return information only about VPCs that match criteria you specify.

For example, you could ask to get information about a particular VPC or VPCs (or all your VPCs) only if the VPC’s state is available. You can specify multiple filters (e.g., the VPC uses one of several sets of DHCP options, and the VPC’s state is available). The result includes information for a particular VPC only if the VPC matches all your filters.

If there’s no match, no special message is returned; the response is simply empty. The following table shows the available filters.

Access

public

Parameters

Parameter

Type

Required

Description

$opt

array

Optional

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

  • VpcId - string|array - Optional - The ID of a VPC you want information about. 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 VPCs. 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 VPCs.

$ec2 = new AmazonEC2();

$response = $ec2->describe_vpcs();

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

Filter VPCs by available state.

$ec2 = new AmazonEC2();

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

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

Copyright © 2010–2013 Amazon Web Services, LLC


Feedback