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
- Struct
- Aws::CloudWatchLogs::Types::FilterLogEventsRequest
- Defined in:
- (unknown)
Overview
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
-
#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 to search.
-
#log_stream_name_prefix ⇒ String
Filters the results to include only events from log streams that have names starting with this prefix.
-
#log_stream_names ⇒ Array<String>
Filters the results to only logs from the log streams in this list.
-
#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 timestamp later than this time are not returned.
#filter_pattern ⇒ String
The filter pattern to use. For more information, see Filter and Pattern Syntax.
If not provided, all the events are matched.
#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.
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.
#limit ⇒ Integer
The maximum number of events to return. The default is 10,000 events.
#log_group_name ⇒ String
The name of the log group to search.
#log_stream_name_prefix ⇒ String
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.
#log_stream_names ⇒ Array<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.
#next_token ⇒ String
The token for the next set of events to return. (You received this token from a previous call.)
#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 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.