describe_events ( $opt )

Returns list of event descriptions matching criteria up to the last 6 weeks.

This action returns the most recent 1,000 events from the specified NextToken.

Access

public

Parameters

Parameter

Type

Required

Description

$opt

array

Optional

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

  • ApplicationName - string - Optional - If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those associated with this application.
  • VersionLabel - string - Optional - If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this application version.
  • TemplateName - string - Optional - If specified, AWS Elastic Beanstalk restricts the returned descriptions to those that are associated with this environment configuration.
  • EnvironmentId - string - Optional - If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this environment.
  • EnvironmentName - string - Optional - If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this environment.
  • RequestId - string - Optional - If specified, AWS Elastic Beanstalk restricts the described events to include only those associated with this request ID.
  • Severity - string - Optional - If specified, limits the events returned from this call to include only those with the specified severity or higher. [Allowed values: TRACE, DEBUG, INFO, WARN, ERROR, FATAL]
  • StartTime - string - Optional - If specified, AWS Elastic Beanstalk restricts the returned descriptions to those that occur on or after this time. May be passed as a number of seconds since UNIX Epoch, or any string compatible with strtotime().
  • EndTime - string - Optional - If specified, AWS Elastic Beanstalk restricts the returned descriptions to those that occur up to, but not including, the EndTime. May be passed as a number of seconds since UNIX Epoch, or any string compatible with strtotime().
  • MaxRecords - integer - Optional - Specifies the maximum number of events that can be returned, beginning with the most recent event.
  • NextToken - string - Optional - Pagination token. If specified, the events return the next batch of results.
  • 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 events that match specific criteria.

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

$response = $bean->describe_events(array(
	'SourceType' => 'db-instance',
	'StartTime' => '1 August 2010',
	'EndTime' => '2 August 2010',
	'MaxRecords' => 100,
));

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

Describe very recent events.

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

$response = $bean->describe_events(array(
	'StartTime' => '10 minutes ago',
	'EndTime' => 'now'
));

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

Source

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

public function describe_events($opt = null)
{
    if (!$opt) $opt = array();
            
    // Optional DateTime
    if (isset($opt['StartTime']))
    {
        $opt['StartTime'] = $this->util->convert_date_to_iso8601($opt['StartTime']);
    }
    
    // Optional DateTime
    if (isset($opt['EndTime']))
    {
        $opt['EndTime'] = $this->util->convert_date_to_iso8601($opt['EndTime']);
    }

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

Copyright © 2010–2013 Amazon Web Services, LLC


Feedback