describe_key_pairs ( $opt )

The DescribeKeyPairs operation returns information about key pairs available to you. If you specify key pairs, information about those key pairs is returned. Otherwise, information for all registered key pairs is returned.

Access

public

Parameters

Parameter

Type

Required

Description

$opt

array

Optional

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

  • KeyName - string|array - Optional - The optional list of key pair names 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 KeyPairs. 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 the key pairs in your account.

$ec2 = new AmazonEC2();

$response = $ec2->describe_key_pairs();

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

Describe specific key pairs in your account.

$ec2 = new AmazonEC2();

$response = $ec2->describe_key_pairs(array(
	'KeyName' => 'my-keypair'
));

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

Describe multiple key pairs in your account.

$ec2 = new AmazonEC2();

$response = $ec2->describe_key_pairs(array(
	'KeyName' => array(
		'my-keypair',
		'my-keypair2'
	)
));

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

Filter key pairs.

$ec2 = new AmazonEC2();

$response = $ec2->describe_key_pairs(array(
	'Filter' => array(
		array('Name' => 'key-name'),
	)
));

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

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

Copyright © 2010–2013 Amazon Web Services, LLC


Feedback