Safe Haskell | None |
---|---|
Language | Haskell2010 |
Retrieves log events, optionally filtered by a filter pattern from the
specified log group. You can provide an optional time range to filter the
results on the event timestamp
. You can limit the streams searched to an
explicit list of logStreamNames
.
By default, this operation returns as much matching log events as can fit
in a response size of 1MB, up to 10,000 log events, or all the events found
within a time-bounded scan window. If the response includes a nextToken
, then
there is more data to search, and the search can be resumed with a new
request providing the nextToken. The response will contain a list of searchedLogStreams
that contains information about which streams were searched in the request
and whether they have been searched completely or require further pagination.
The limit
parameter in the request. can be used to specify the maximum number
of events to return in a page.
http://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_FilterLogEvents.html
- data FilterLogEvents
- filterLogEvents :: Text -> NonEmpty Text -> FilterLogEvents
- fleEndTime :: Lens' FilterLogEvents (Maybe Natural)
- fleFilterPattern :: Lens' FilterLogEvents (Maybe Text)
- fleInterleaved :: Lens' FilterLogEvents (Maybe Bool)
- fleLimit :: Lens' FilterLogEvents (Maybe Natural)
- fleLogGroupName :: Lens' FilterLogEvents Text
- fleLogStreamNames :: Lens' FilterLogEvents (NonEmpty Text)
- fleNextToken :: Lens' FilterLogEvents (Maybe Text)
- fleStartTime :: Lens' FilterLogEvents (Maybe Natural)
- data FilterLogEventsResponse
- filterLogEventsResponse :: FilterLogEventsResponse
- flerEvents :: Lens' FilterLogEventsResponse [FilteredLogEvent]
- flerNextToken :: Lens' FilterLogEventsResponse (Maybe Text)
- flerSearchedLogStreams :: Lens' FilterLogEventsResponse [SearchedLogStream]
Request
data FilterLogEvents Source
Request constructor
FilterLogEvents
constructor.
The fields accessible through corresponding lenses are:
Request lenses
fleEndTime :: Lens' FilterLogEvents (Maybe Natural) Source
A unix timestamp indicating the end time of the range for the request. If provided, events with a timestamp later than this time will not be returned.
fleFilterPattern :: Lens' FilterLogEvents (Maybe Text) Source
A valid CloudWatch Logs filter pattern to use for filtering the response. If not provided, all the events are matched.
fleInterleaved :: Lens' FilterLogEvents (Maybe Bool) Source
If provided, the API will make a best effort to provide responses that contain events from multiple log streams within the log group interleaved in a single response. If not provided, all the matched log events in the first log stream will be searched first, then those in the next log stream, etc.
fleLimit :: Lens' FilterLogEvents (Maybe Natural) Source
The maximum number of events to return in a page of results. Default is 10,000 events.
fleLogGroupName :: Lens' FilterLogEvents Text Source
The name of the log group to query
fleLogStreamNames :: Lens' FilterLogEvents (NonEmpty Text) Source
Optional list of log stream names within the specified log group to search. Defaults to all the log streams in the log group.
fleNextToken :: Lens' FilterLogEvents (Maybe Text) Source
A pagination token obtained from a FilterLogEvents
response to continue
paginating the FilterLogEvents results.
fleStartTime :: Lens' FilterLogEvents (Maybe Natural) Source
A unix timestamp indicating the start time of the range for the request. If provided, events with a timestamp prior to this time will not be returned.
Response
Response constructor
filterLogEventsResponse :: FilterLogEventsResponse Source
FilterLogEventsResponse
constructor.
The fields accessible through corresponding lenses are:
Response lenses
flerEvents :: Lens' FilterLogEventsResponse [FilteredLogEvent] Source
A list of FilteredLogEvent
objects representing the matched events from the
request.
flerNextToken :: Lens' FilterLogEventsResponse (Maybe Text) Source
A pagination token obtained from a FilterLogEvents
response to continue
paginating the FilterLogEvents results.
flerSearchedLogStreams :: Lens' FilterLogEventsResponse [SearchedLogStream] Source
A list of SearchedLogStream
objects indicating which log streams have been
searched in this request and whether each has been searched completely or
still has more to be paginated.