retrieve_environment_info ( $info_type, $opt )

Retrieves the compiled information from a RequestEnvironmentInfo request.

Related Topics

  • RequestEnvironmentInfo

Access

public

Parameters

Parameter

Type

Required

Description

$info_type

string

Required

The type of information to retrieve. [Allowed values: tail]

$opt

array

Optional

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

  • EnvironmentId - string - Optional - The ID of the data’s environment. If no such environment is found, returns an InvalidParameterValue error. Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.
  • EnvironmentName - string - Optional - The name of the data’s environment. If no such environment is found, returns an InvalidParameterValue error. Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.
  • 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

Request and retrieve the information for a specific environment.

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

$info_request = $bean->request_environment_info('tail', array(
	'EnvironmentName' => 'my-environment'
));

if ($info_request->isOK())
{
	sleep(20);

	$response = $bean->retrieve_environment_info('tail', array(
		'EnvironmentName' => 'my-environment'
	));

}

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

Related Methods

Source

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

public function retrieve_environment_info($info_type, $opt = null)
{
    if (!$opt) $opt = array();
    $opt['InfoType'] = $info_type;
    
    return $this->authenticate('RetrieveEnvironmentInfo', $opt);
}

Copyright © 2010–2013 Amazon Web Services, LLC


Feedback