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

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing FilterLogEventsRequest as input to an Aws::Client method, you can use a vanilla 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,
}

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)

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

#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)

    The filter pattern to use.

#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)

    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.

#limitInteger

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

Returns:

  • (Integer)

    The maximum number of events to return.

#log_group_nameString

The name of the log group to search.

Returns:

  • (String)

    The name of the log group to search.

#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)

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

#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>)

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

#next_tokenString

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

Returns:

  • (String)

    The token for the next set of events to return.

#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.

Returns:

  • (Integer)

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