Network.AWS.CloudWatchLogs.FilterLogEvents

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.

See: AWS API Reference for FilterLogEvents.

This operation returns paginated results.

Creating a Request

filterLogEvents

Arguments

:: Text

fleLogGroupName

-> FilterLogEvents

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
• fleLogStreamNames
• fleNextToken
• fleEndTime
• fleLimit
• fleFilterPattern
• fleInterleaved
• fleLogGroupName

data FilterLogEvents

See: filterLogEvents smart constructor.

Instances

Eq FilterLogEvents

Data FilterLogEvents

Read FilterLogEvents

Show FilterLogEvents

Generic FilterLogEvents

ToJSON FilterLogEvents

AWSPager FilterLogEvents

AWSRequest FilterLogEvents

ToPath FilterLogEvents

ToHeaders FilterLogEvents

ToQuery FilterLogEvents

Typeable * FilterLogEvents

type Rep FilterLogEvents

type Rs FilterLogEvents = FilterLogEventsResponse

Request Lenses

fleStartTime :: Lens' FilterLogEvents (Maybe Natural)

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.

fleLogStreamNames :: Lens' FilterLogEvents (Maybe (NonEmpty Text))

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)

A pagination token obtained from a FilterLogEvents response to continue paginating the FilterLogEvents results.

fleEndTime :: Lens' FilterLogEvents (Maybe Natural)

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.

fleLimit :: Lens' FilterLogEvents (Maybe Natural)

The maximum number of events to return in a page of results. Default is 10,000 events.

fleFilterPattern :: Lens' FilterLogEvents (Maybe Text)

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)

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

The name of the log group to query.

Destructuring the Response

filterLogEventsResponse

Arguments

:: Int

flersStatus

-> FilterLogEventsResponse

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
• flersNextToken
• flersEvents
• flersStatus

data FilterLogEventsResponse

See: filterLogEventsResponse smart constructor.

Instances

Eq FilterLogEventsResponse

Data FilterLogEventsResponse

Read FilterLogEventsResponse

Show FilterLogEventsResponse

Generic FilterLogEventsResponse

Typeable * FilterLogEventsResponse

type Rep FilterLogEventsResponse

Response Lenses

flersSearchedLogStreams :: Lens' FilterLogEventsResponse [SearchedLogStream]

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)

A pagination token obtained from a FilterLogEvents response to continue paginating the FilterLogEvents results.

flersEvents :: Lens' FilterLogEventsResponse [FilteredLogEvent]

A list of FilteredLogEvent objects representing the matched events from the request.

flersStatus :: Lens' FilterLogEventsResponse Int

The response status code.