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

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb

Overview

Note:

When making an API call, you may pass DescribeEventsMessage data as a 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.

Instance Attribute Summary collapse

Instance Attribute Details

#application_nameString

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

Returns:

  • (String)


2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 2170

class DescribeEventsMessage < Struct.new(
  :application_name,
  :version_label,
  :template_name,
  :environment_id,
  :environment_name,
  :platform_arn,
  :request_id,
  :severity,
  :start_time,
  :end_time,
  :max_records,
  :next_token)
  include Aws::Structure
end

#end_timeTime

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

Returns:

  • (Time)


2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 2170

class DescribeEventsMessage < Struct.new(
  :application_name,
  :version_label,
  :template_name,
  :environment_id,
  :environment_name,
  :platform_arn,
  :request_id,
  :severity,
  :start_time,
  :end_time,
  :max_records,
  :next_token)
  include Aws::Structure
end

#environment_idString

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

Returns:

  • (String)


2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 2170

class DescribeEventsMessage < Struct.new(
  :application_name,
  :version_label,
  :template_name,
  :environment_id,
  :environment_name,
  :platform_arn,
  :request_id,
  :severity,
  :start_time,
  :end_time,
  :max_records,
  :next_token)
  include Aws::Structure
end

#environment_nameString

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

Returns:

  • (String)


2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 2170

class DescribeEventsMessage < Struct.new(
  :application_name,
  :version_label,
  :template_name,
  :environment_id,
  :environment_name,
  :platform_arn,
  :request_id,
  :severity,
  :start_time,
  :end_time,
  :max_records,
  :next_token)
  include Aws::Structure
end

#max_recordsInteger

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

Returns:

  • (Integer)


2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 2170

class DescribeEventsMessage < Struct.new(
  :application_name,
  :version_label,
  :template_name,
  :environment_id,
  :environment_name,
  :platform_arn,
  :request_id,
  :severity,
  :start_time,
  :end_time,
  :max_records,
  :next_token)
  include Aws::Structure
end

#next_tokenString

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

Returns:

  • (String)


2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 2170

class DescribeEventsMessage < Struct.new(
  :application_name,
  :version_label,
  :template_name,
  :environment_id,
  :environment_name,
  :platform_arn,
  :request_id,
  :severity,
  :start_time,
  :end_time,
  :max_records,
  :next_token)
  include Aws::Structure
end

#platform_arnString

The ARN of the version of the custom platform.

Returns:

  • (String)


2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 2170

class DescribeEventsMessage < Struct.new(
  :application_name,
  :version_label,
  :template_name,
  :environment_id,
  :environment_name,
  :platform_arn,
  :request_id,
  :severity,
  :start_time,
  :end_time,
  :max_records,
  :next_token)
  include Aws::Structure
end

#request_idString

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

Returns:

  • (String)


2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 2170

class DescribeEventsMessage < Struct.new(
  :application_name,
  :version_label,
  :template_name,
  :environment_id,
  :environment_name,
  :platform_arn,
  :request_id,
  :severity,
  :start_time,
  :end_time,
  :max_records,
  :next_token)
  include Aws::Structure
end

#severityString

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

Returns:

  • (String)


2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 2170

class DescribeEventsMessage < Struct.new(
  :application_name,
  :version_label,
  :template_name,
  :environment_id,
  :environment_name,
  :platform_arn,
  :request_id,
  :severity,
  :start_time,
  :end_time,
  :max_records,
  :next_token)
  include Aws::Structure
end

#start_timeTime

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

Returns:

  • (Time)


2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 2170

class DescribeEventsMessage < Struct.new(
  :application_name,
  :version_label,
  :template_name,
  :environment_id,
  :environment_name,
  :platform_arn,
  :request_id,
  :severity,
  :start_time,
  :end_time,
  :max_records,
  :next_token)
  include Aws::Structure
end

#template_nameString

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

Returns:

  • (String)


2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 2170

class DescribeEventsMessage < Struct.new(
  :application_name,
  :version_label,
  :template_name,
  :environment_id,
  :environment_name,
  :platform_arn,
  :request_id,
  :severity,
  :start_time,
  :end_time,
  :max_records,
  :next_token)
  include Aws::Structure
end

#version_labelString

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

Returns:

  • (String)


2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 2170

class DescribeEventsMessage < Struct.new(
  :application_name,
  :version_label,
  :template_name,
  :environment_id,
  :environment_name,
  :platform_arn,
  :request_id,
  :severity,
  :start_time,
  :end_time,
  :max_records,
  :next_token)
  include Aws::Structure
end