describe_applications ( $opt )

Returns the descriptions of existing applications.

Access

public

Parameters

Parameter

Type

Required

Description

$opt

array

Optional

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

  • ApplicationNames - string|array - Optional - If specified, AWS Elastic Beanstalk restricts the returned descriptions to only include those with the specified names. 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 existing applications.

// Instantiate the class
$bean = new AmazonElasticBeanstalk();

$response = $bean->describe_applications();

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

Describe a specific application.

// Instantiate the class
$bean = new AmazonElasticBeanstalk();

$response = $bean->describe_applications(array(
	'ApplicationNames' => 'my-application'
));

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

Related Methods

Source

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

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

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

Copyright © 2010–2013 Amazon Web Services, LLC


Feedback