You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::ElasticBeanstalk::Types::DescribeEventsMessage

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing DescribeEventsMessage as input to an Aws::Client method, you can use a vanilla Hash:

{
  application_name: "ApplicationName",
  version_label: "VersionLabel",
  template_name: "ConfigurationTemplateName",
  environment_id: "EnvironmentId",
  environment_name: "EnvironmentName",
  platform_arn: "PlatformArn",
  request_id: "RequestId",
  severity: "TRACE", # accepts TRACE, DEBUG, INFO, WARN, ERROR, FATAL
  start_time: Time.now,
  end_time: Time.now,
  max_records: 1,
  next_token: "Token",
}

Request to retrieve a list of events for an environment.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#application_name ⇒ String

If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those associated with this application.

Returns:

  • (String) —

    If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those associated with this application.

#end_time ⇒ Time

If specified, AWS Elastic Beanstalk restricts the returned descriptions to those that occur up to, but not including, the EndTime.

Returns:

  • (Time) —

    If specified, AWS Elastic Beanstalk restricts the returned descriptions to those that occur up to, but not including, the EndTime.

#environment_id ⇒ String

If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this environment.

Returns:

  • (String) —

    If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this environment.

#environment_name ⇒ String

If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this environment.

Returns:

  • (String) —

    If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this environment.

#max_records ⇒ Integer

Specifies the maximum number of events that can be returned, beginning with the most recent event.

Returns:

  • (Integer) —

    Specifies the maximum number of events that can be returned, beginning with the most recent event.

#next_token ⇒ String

Pagination token. If specified, the events return the next batch of results.

Returns:

  • (String) —

    Pagination token.

#platform_arn ⇒ String

The ARN of a custom platform version. If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this custom platform version.

Returns:

  • (String) —

    The ARN of a custom platform version.

#request_id ⇒ String

If specified, AWS Elastic Beanstalk restricts the described events to include only those associated with this request ID.

Returns:

  • (String) —

    If specified, AWS Elastic Beanstalk restricts the described events to include only those associated with this request ID.

#severity ⇒ String

If specified, limits the events returned from this call to include only those with the specified severity or higher.

Possible values:

  • TRACE
  • DEBUG
  • INFO
  • WARN
  • ERROR
  • FATAL

Returns:

  • (String) —

    If specified, limits the events returned from this call to include only those with the specified severity or higher.

#start_time ⇒ Time

If specified, AWS Elastic Beanstalk restricts the returned descriptions to those that occur on or after this time.

Returns:

  • (Time) —

    If specified, AWS Elastic Beanstalk restricts the returned descriptions to those that occur on or after this time.

#template_name ⇒ String

If specified, AWS Elastic Beanstalk restricts the returned descriptions to those that are associated with this environment configuration.

Returns:

  • (String) —

    If specified, AWS Elastic Beanstalk restricts the returned descriptions to those that are associated with this environment configuration.

#version_label ⇒ String

If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this application version.

Returns:

  • (String) —

    If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this application version.