describe_security_groups ( $opt )

The DescribeSecurityGroups operation returns information about security groups that you own.

If you specify security group names, information about those security group is returned. Otherwise, information for all security group is returned. If you specify a group that does not exist, a fault is returned.

Access

public

Parameters

Parameter

Type

Required

Description

$opt

array

Optional

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

  • GroupName - string|array - Optional - The optional list of Amazon EC2 security groups to describe. Pass a string for a single value, or an indexed array for multiple values.
  • GroupId - string|array - Optional - 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 SecurityGroups. 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 security groups.

$ec2 = new AmazonEC2();

$response = $ec2->describe_security_groups();

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

Describe security groups with a given group name.

$ec2 = new AmazonEC2();

$response = $ec2->describe_security_groups(array(
	'GroupName' => 'default'
));

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

Describe security groups with multiple group names.

$ec2 = new AmazonEC2();

$response = $ec2->describe_security_groups(array(
	'GroupName' => array(
		'default',
		'foo-test'
	)
));

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

Filter security groups.

$ec2 = new AmazonEC2();

$response = $ec2->describe_security_groups(array(
	'Filter' => array(
		array('Name' => 'owner-id')
	)
));

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

Related Methods

Source

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

public function describe_security_groups($opt = null)
{
    if (!$opt) $opt = array();
            
    // Optional list (non-map)
    if (isset($opt['GroupName']))
    {
        $opt = array_merge($opt, CFComplexType::map(array(
            'GroupName' => (is_array($opt['GroupName']) ? $opt['GroupName'] : array($opt['GroupName']))
        )));
        unset($opt['GroupName']);
    }
    
    // Optional list (non-map)
    if (isset($opt['GroupId']))
    {
        $opt = array_merge($opt, CFComplexType::map(array(
            'GroupId' => (is_array($opt['GroupId']) ? $opt['GroupId'] : array($opt['GroupId']))
        )));
        unset($opt['GroupId']);
    }
    
    // Optional list + map
    if (isset($opt['Filter']))
    {
        $opt = array_merge($opt, CFComplexType::map(array(
            'Filter' => $opt['Filter']
        )));
        unset($opt['Filter']);
    }

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

Copyright © 2010–2013 Amazon Web Services, LLC


Feedback