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

Class: Aws::CloudWatchLogs::Types::FilterLogEventsRequest

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 FilterLogEventsRequest data as a hash:

{
  log_group_name: "LogGroupName", # required
  log_stream_names: ["LogStreamName"],
  start_time: 1,
  end_time: 1,
  filter_pattern: "FilterPattern",
  next_token: "NextToken",
  limit: 1,
  interleaved: 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 returned.

Returns:

  • (Integer)


961
962
963
964
965
966
967
968
969
970
971
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/types.rb', line 961

class FilterLogEventsRequest < Struct.new(
  :log_group_name,
  :log_stream_names,
  :start_time,
  :end_time,
  :filter_pattern,
  :next_token,
  :limit,
  :interleaved)
  include Aws::Structure
end

#filter_patternString

The filter pattern to use. If not provided, all the events are matched.

Returns:

  • (String)


961
962
963
964
965
966
967
968
969
970
971
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/types.rb', line 961

class FilterLogEventsRequest < Struct.new(
  :log_group_name,
  :log_stream_names,
  :start_time,
  :end_time,
  :filter_pattern,
  :next_token,
  :limit,
  :interleaved)
  include Aws::Structure
end

#interleavedBoolean

If the value is true, the operation makes a best effort to provide responses that contain events from multiple log streams within the log group, interleaved in a single response. If the value is false, all the matched log events in the first log stream are searched first, then those in the next log stream, and so on. The default is false.

Returns:

  • (Boolean)


961
962
963
964
965
966
967
968
969
970
971
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/types.rb', line 961

class FilterLogEventsRequest < Struct.new(
  :log_group_name,
  :log_stream_names,
  :start_time,
  :end_time,
  :filter_pattern,
  :next_token,
  :limit,
  :interleaved)
  include Aws::Structure
end

#limitInteger

The maximum number of events to return. The default is 10,000 events.

Returns:

  • (Integer)


961
962
963
964
965
966
967
968
969
970
971
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/types.rb', line 961

class FilterLogEventsRequest < Struct.new(
  :log_group_name,
  :log_stream_names,
  :start_time,
  :end_time,
  :filter_pattern,
  :next_token,
  :limit,
  :interleaved)
  include Aws::Structure
end

#log_group_nameString

The name of the log group.

Returns:

  • (String)


961
962
963
964
965
966
967
968
969
970
971
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/types.rb', line 961

class FilterLogEventsRequest < Struct.new(
  :log_group_name,
  :log_stream_names,
  :start_time,
  :end_time,
  :filter_pattern,
  :next_token,
  :limit,
  :interleaved)
  include Aws::Structure
end

#log_stream_namesArray<String>

Optional list of log stream names.

Returns:

  • (Array<String>)


961
962
963
964
965
966
967
968
969
970
971
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/types.rb', line 961

class FilterLogEventsRequest < Struct.new(
  :log_group_name,
  :log_stream_names,
  :start_time,
  :end_time,
  :filter_pattern,
  :next_token,
  :limit,
  :interleaved)
  include Aws::Structure
end

#next_tokenString

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

Returns:

  • (String)


961
962
963
964
965
966
967
968
969
970
971
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/types.rb', line 961

class FilterLogEventsRequest < Struct.new(
  :log_group_name,
  :log_stream_names,
  :start_time,
  :end_time,
  :filter_pattern,
  :next_token,
  :limit,
  :interleaved)
  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 before this time are not returned.

Returns:

  • (Integer)


961
962
963
964
965
966
967
968
969
970
971
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/types.rb', line 961

class FilterLogEventsRequest < Struct.new(
  :log_group_name,
  :log_stream_names,
  :start_time,
  :end_time,
  :filter_pattern,
  :next_token,
  :limit,
  :interleaved)
  include Aws::Structure
end