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 from the specified log stream. You can provide an optional time range to filter the results on the event timestamp
.
By default, this operation returns as much log events as can fit in a response size of 1MB, up to 10,000 log events. The response will always include a nextForwardToken
and a nextBackwardToken
in the response body. You can use any of these tokens in subsequent GetLogEvents
requests to paginate through events in either forward or backward direction. You can also limit the number of log events returned in the response by specifying the limit
parameter in the request.
- getLogEvents :: Text -> Text -> GetLogEvents
- data GetLogEvents
- gleStartTime :: Lens' GetLogEvents (Maybe Natural)
- gleStartFromHead :: Lens' GetLogEvents (Maybe Bool)
- gleNextToken :: Lens' GetLogEvents (Maybe Text)
- gleEndTime :: Lens' GetLogEvents (Maybe Natural)
- gleLimit :: Lens' GetLogEvents (Maybe Natural)
- gleLogGroupName :: Lens' GetLogEvents Text
- gleLogStreamName :: Lens' GetLogEvents Text
- getLogEventsResponse :: Int -> GetLogEventsResponse
- data GetLogEventsResponse
- glersNextBackwardToken :: Lens' GetLogEventsResponse (Maybe Text)
- glersNextForwardToken :: Lens' GetLogEventsResponse (Maybe Text)
- glersEvents :: Lens' GetLogEventsResponse [OutputLogEvent]
- glersResponseStatus :: Lens' GetLogEventsResponse Int
Creating a Request
Creates a value of GetLogEvents
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data GetLogEvents Source #
See: getLogEvents
smart constructor.
Request Lenses
gleStartTime :: Lens' GetLogEvents (Maybe Natural) Source #
Undocumented member.
gleStartFromHead :: Lens' GetLogEvents (Maybe Bool) Source #
If set to true, the earliest log events would be returned first. The default is false (the latest log events are returned first).
gleNextToken :: Lens' GetLogEvents (Maybe Text) Source #
A string token used for pagination that points to the next page of results. It must be a value obtained from the nextForwardToken
or nextBackwardToken
fields in the response of the previous GetLogEvents
request.
gleEndTime :: Lens' GetLogEvents (Maybe Natural) Source #
Undocumented member.
gleLimit :: Lens' GetLogEvents (Maybe Natural) Source #
The maximum number of log events returned in the response. If you don't specify a value, the request would return as many log events as can fit in a response size of 1MB, up to 10,000 log events.
gleLogGroupName :: Lens' GetLogEvents Text Source #
The name of the log group to query.
gleLogStreamName :: Lens' GetLogEvents Text Source #
The name of the log stream to query.
Destructuring the Response
Creates a value of GetLogEventsResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data GetLogEventsResponse Source #
See: getLogEventsResponse
smart constructor.
Response Lenses
glersNextBackwardToken :: Lens' GetLogEventsResponse (Maybe Text) Source #
Undocumented member.
glersNextForwardToken :: Lens' GetLogEventsResponse (Maybe Text) Source #
Undocumented member.
glersEvents :: Lens' GetLogEventsResponse [OutputLogEvent] Source #
Undocumented member.
glersResponseStatus :: Lens' GetLogEventsResponse Int Source #
The response status code.