Copyright | (c) 2013-2018 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
Lists log events from the specified log group. You can list all the log events or filter the results using a filter pattern, a time range, and the name of the log stream.
By default, this operation returns as many log events as can fit in 1 MB (up to 10,000 log events), or all the events found within the time range that you specify. If the results include a token, then there are more log events available, and you can get additional results by specifying the token in a subsequent call.
This operation returns paginated results.
Synopsis
- 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:
fleStartTime
- The start of the time range, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a time stamp before this time are not returned.fleNextToken
- The token for the next set of events to return. (You received this token from a previous call.)fleLogStreamNames
- Optional list of log stream names.fleEndTime
- The end of the time range, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a time stamp later than this time are not returned.fleLimit
- The maximum number of events to return. The default is 10,000 events.fleFilterPattern
- The filter pattern to use. If not provided, all the events are matched.fleInterleaved
- 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.fleLogGroupName
- The name of the log group.
data FilterLogEvents Source #
See: filterLogEvents
smart constructor.
Instances
Request Lenses
fleStartTime :: Lens' FilterLogEvents (Maybe Natural) Source #
The start of the time range, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a time stamp before this time are not returned.
fleNextToken :: Lens' FilterLogEvents (Maybe Text) Source #
The token for the next set of events to return. (You received this token from a previous call.)
fleLogStreamNames :: Lens' FilterLogEvents (Maybe (NonEmpty Text)) Source #
Optional list of log stream names.
fleEndTime :: Lens' FilterLogEvents (Maybe Natural) Source #
The end of the time range, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a time stamp later than this time are not returned.
fleLimit :: Lens' FilterLogEvents (Maybe Natural) Source #
The maximum number of events to return. The default is 10,000 events.
fleFilterPattern :: Lens' FilterLogEvents (Maybe Text) Source #
The filter pattern to use. If not provided, all the events are matched.
fleInterleaved :: Lens' FilterLogEvents (Maybe Bool) Source #
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.
fleLogGroupName :: Lens' FilterLogEvents Text Source #
The name of the log group.
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:
flersSearchedLogStreams
- Indicates which log streams have been searched and whether each has been searched completely.flersNextToken
- The token to use when requesting the next set of items. The token expires after 24 hours.flersEvents
- The matched events.flersResponseStatus
- -- | The response status code.
data FilterLogEventsResponse Source #
See: filterLogEventsResponse
smart constructor.
Instances
Response Lenses
flersSearchedLogStreams :: Lens' FilterLogEventsResponse [SearchedLogStream] Source #
Indicates which log streams have been searched and whether each has been searched completely.
flersNextToken :: Lens' FilterLogEventsResponse (Maybe Text) Source #
The token to use when requesting the next set of items. The token expires after 24 hours.
flersEvents :: Lens' FilterLogEventsResponse [FilteredLogEvent] Source #
The matched events.
flersResponseStatus :: Lens' FilterLogEventsResponse Int Source #
- - | The response status code.