class Aws::CloudWatchLogs::Types::FilterLogEventsRequest
@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, }
@!attribute [rw] log_group_name
The name of the log group to search. @return [String]
@!attribute [rw] log_stream_names
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. @return [Array<String>]
@!attribute [rw] log_stream_name_prefix
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. @return [String]
@!attribute [rw] start_time
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. @return [Integer]
@!attribute [rw] end_time
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. @return [Integer]
@!attribute [rw] filter_pattern
The filter pattern to use. For more information, see [Filter and Pattern Syntax][1]. If not provided, all the events are matched. [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/FilterAndPatternSyntax.html @return [String]
@!attribute [rw] next_token
The token for the next set of events to return. (You received this token from a previous call.) @return [String]
@!attribute [rw] limit
The maximum number of events to return. The default is 10,000 events. @return [Integer]
@!attribute [rw] interleaved
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. @return [Boolean]
@see docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/FilterLogEventsRequest AWS API Documentation
Constants
- SENSITIVE