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

Class: Aws::CloudWatchLogs::Types::GetLogEventsRequest

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

Overview

Note:

When making an API call, you may pass GetLogEventsRequest data as a hash:

{
  log_group_name: "LogGroupName", # required
  log_stream_name: "LogStreamName", # required
  start_time: 1,
  end_time: 1,
  next_token: "NextToken",
  limit: 1,
  start_from_head: false,
}

Instance Attribute Summary collapse

Instance Attribute Details

#end_timeInteger

The end of the time range, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a time stamp later than this time are not included.

Returns:

  • (Integer)


1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/types.rb', line 1083

class GetLogEventsRequest < Struct.new(
  :log_group_name,
  :log_stream_name,
  :start_time,
  :end_time,
  :next_token,
  :limit,
  :start_from_head)
  include Aws::Structure
end

#limitInteger

The maximum number of log events returned. If you don't specify a value, the maximum is as many log events as can fit in a response size of 1 MB, up to 10,000 log events.

Returns:

  • (Integer)


1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/types.rb', line 1083

class GetLogEventsRequest < Struct.new(
  :log_group_name,
  :log_stream_name,
  :start_time,
  :end_time,
  :next_token,
  :limit,
  :start_from_head)
  include Aws::Structure
end

#log_group_nameString

The name of the log group.

Returns:

  • (String)


1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/types.rb', line 1083

class GetLogEventsRequest < Struct.new(
  :log_group_name,
  :log_stream_name,
  :start_time,
  :end_time,
  :next_token,
  :limit,
  :start_from_head)
  include Aws::Structure
end

#log_stream_nameString

The name of the log stream.

Returns:

  • (String)


1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/types.rb', line 1083

class GetLogEventsRequest < Struct.new(
  :log_group_name,
  :log_stream_name,
  :start_time,
  :end_time,
  :next_token,
  :limit,
  :start_from_head)
  include Aws::Structure
end

#next_tokenString

The token for the next set of items to return. (You received this token from a previous call.)

Returns:

  • (String)


1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/types.rb', line 1083

class GetLogEventsRequest < Struct.new(
  :log_group_name,
  :log_stream_name,
  :start_time,
  :end_time,
  :next_token,
  :limit,
  :start_from_head)
  include Aws::Structure
end

#start_from_headBoolean

If the value is true, the earliest log events are returned first. If the value is false, the latest log events are returned first. The default value is false.

Returns:

  • (Boolean)


1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/types.rb', line 1083

class GetLogEventsRequest < Struct.new(
  :log_group_name,
  :log_stream_name,
  :start_time,
  :end_time,
  :next_token,
  :limit,
  :start_from_head)
  include Aws::Structure
end

#start_timeInteger

The start of the time range, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a time stamp earlier than this time are not included.

Returns:

  • (Integer)


1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/types.rb', line 1083

class GetLogEventsRequest < Struct.new(
  :log_group_name,
  :log_stream_name,
  :start_time,
  :end_time,
  :next_token,
  :limit,
  :start_from_head)
  include Aws::Structure
end