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
• Struct
• Aws::CloudWatchLogs::Types::FilterLogEventsRequest

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,
}

See Also:

• AWS API Documentation

Instance Attribute Summary

• #end_time ⇒ Integer

  The end of the time range, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.

• #filter_pattern ⇒ String

  The filter pattern to use.

• #interleaved ⇒ Boolean

  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.

• #limit ⇒ Integer

  The maximum number of events to return.

• #log_group_name ⇒ String

  The name of the log group.

• #log_stream_names ⇒ Array<String>

  Optional list of log stream names.

• #next_token ⇒ String

  The token for the next set of events to return.

• #start_time ⇒ Integer

  The start of the time range, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.

Instance Attribute Details

#end_time ⇒ Integer

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)

# 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_pattern ⇒ String

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

Returns:

• (String)

# 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

#interleaved ⇒ Boolean

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)

# 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

#limit ⇒ Integer

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

Returns:

• (Integer)

# 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_name ⇒ String

The name of the log group.

Returns:

• (String)

# 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_names ⇒ Array<String>

Optional list of log stream names.

Returns:

• (Array<String>)

# 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_token ⇒ String

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

Returns:

• (String)

# 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_time ⇒ Integer

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)

# 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