Copyright | (c) 2013-2016 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
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.
This operation returns paginated results.
- filterLogEvents :: Text -> FilterLogEvents
- data FilterLogEvents
- fleStartTime :: Lens' FilterLogEvents (Maybe Natural)
- fleNextToken :: Lens' FilterLogEvents (Maybe Text)
- fleLogStreamNames :: Lens' FilterLogEvents (Maybe (NonEmpty Text))
- fleEndTime :: Lens' FilterLogEvents (Maybe Natural)
- fleLimit :: Lens' FilterLogEvents (Maybe Natural)
- fleFilterPattern :: Lens' FilterLogEvents (Maybe Text)
- fleInterleaved :: Lens' FilterLogEvents (Maybe Bool)
- fleLogGroupName :: Lens' FilterLogEvents Text
- filterLogEventsResponse :: Int -> FilterLogEventsResponse
- data FilterLogEventsResponse
- flersSearchedLogStreams :: Lens' FilterLogEventsResponse [SearchedLogStream]
- flersNextToken :: Lens' FilterLogEventsResponse (Maybe Text)
- flersEvents :: Lens' FilterLogEventsResponse [FilteredLogEvent]
- flersResponseStatus :: Lens' FilterLogEventsResponse Int
Creating a Request
Creates a value of FilterLogEvents
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data FilterLogEvents Source #
See: filterLogEvents
smart constructor.
Request Lenses
fleStartTime :: Lens' FilterLogEvents (Maybe Natural) Source #
A point in time expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC. If provided, events with a timestamp prior to this time are not returned.
fleNextToken :: Lens' FilterLogEvents (Maybe Text) Source #
A pagination token obtained from a FilterLogEvents
response to
continue paginating the FilterLogEvents results. This token is omitted
from the response when there are no other events to display.
fleLogStreamNames :: Lens' FilterLogEvents (Maybe (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.
fleEndTime :: Lens' FilterLogEvents (Maybe Natural) Source #
A point in time expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC. If provided, events with a timestamp later than this time are not returned.
fleLimit :: Lens' FilterLogEvents (Maybe Natural) Source #
The maximum number of events to return in a page of results. Default is 10,000 events.
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.
fleLogGroupName :: Lens' FilterLogEvents Text Source #
The name of the log group to query.
Destructuring the Response
filterLogEventsResponse Source #
Creates a value of FilterLogEventsResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data FilterLogEventsResponse Source #
See: filterLogEventsResponse
smart constructor.
Response Lenses
flersSearchedLogStreams :: 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.
flersNextToken :: Lens' FilterLogEventsResponse (Maybe Text) Source #
A pagination token obtained from a FilterLogEvents
response to
continue paginating the FilterLogEvents results. This token is omitted
from the response when there are no other events to display.
flersEvents :: Lens' FilterLogEventsResponse [FilteredLogEvent] Source #
A list of FilteredLogEvent
objects representing the matched events
from the request.
flersResponseStatus :: Lens' FilterLogEventsResponse Int Source #
The response status code.