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"],
  log_stream_name_prefix: "LogStreamName",
  start_time: 1,
  end_time: 1,
  filter_pattern: "FilterPattern",
  next_token: "NextToken",
  limit: 1,
  interleaved: false,
}

Constant Summary collapse

SENSITIVE =
[]

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 timestamp later than this time are not returned.

Returns:

  • (Integer)


1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/types.rb', line 1195

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

#filter_patternString

The filter pattern to use. For more information, see Filter and Pattern Syntax.

If not provided, all the events are matched.

Returns:

  • (String)


1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/types.rb', line 1195

class FilterLogEventsRequest < Struct.new(
  :log_group_name,
  :log_stream_names,
  :log_stream_name_prefix,
  :start_time,
  :end_time,
  :filter_pattern,
  :next_token,
  :limit,
  :interleaved)
  SENSITIVE = []
  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.

Important: Starting on June 17, 2019, this parameter is ignored and the value is assumed to be true. The response from this operation always interleaves events from multiple log streams within a log group.

Returns:

  • (Boolean)


1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/types.rb', line 1195

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

#limitInteger

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

Returns:

  • (Integer)


1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/types.rb', line 1195

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

#log_group_nameString

The name of the log group to search.

Returns:

  • (String)


1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/types.rb', line 1195

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

#log_stream_name_prefixString

Filters the results to include only events from log streams that have names starting with this prefix.

If you specify a value for both logStreamNamePrefix and logStreamNames, but the value for logStreamNamePrefix does not match any log stream names specified in logStreamNames, the action returns an InvalidParameterException error.

Returns:

  • (String)


1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/types.rb', line 1195

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

#log_stream_namesArray<String>

Filters the results to only logs from the log streams in this list.

If you specify a value for both logStreamNamePrefix and logStreamNames, the action returns an InvalidParameterException error.

Returns:

  • (Array<String>)


1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/types.rb', line 1195

class FilterLogEventsRequest < Struct.new(
  :log_group_name,
  :log_stream_names,
  :log_stream_name_prefix,
  :start_time,
  :end_time,
  :filter_pattern,
  :next_token,
  :limit,
  :interleaved)
  SENSITIVE = []
  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)


1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/types.rb', line 1195

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

If you omit startTime and endTime the most recent log events are retrieved, to up 1 MB or 10,000 log events.

Returns:

  • (Integer)


1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/types.rb', line 1195

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