Network.AWS.CloudWatchLogs.FilterLogEvents

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 1MB (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.

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 - The start of the time range. Events with a timestamp prior to 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. Events with a timestamp 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

See: filterLogEvents smart constructor.

Instances

Eq FilterLogEvents

Methods

(==) :: FilterLogEvents -> FilterLogEvents -> Bool

(/=) :: FilterLogEvents -> FilterLogEvents -> Bool

Data FilterLogEvents

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> FilterLogEvents -> c FilterLogEvents

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c FilterLogEvents

toConstr :: FilterLogEvents -> Constr

dataTypeOf :: FilterLogEvents -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c FilterLogEvents)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c FilterLogEvents)

gmapT :: (forall b. Data b => b -> b) -> FilterLogEvents -> FilterLogEvents

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> FilterLogEvents -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> FilterLogEvents -> r

gmapQ :: (forall d. Data d => d -> u) -> FilterLogEvents -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> FilterLogEvents -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> FilterLogEvents -> m FilterLogEvents

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> FilterLogEvents -> m FilterLogEvents

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> FilterLogEvents -> m FilterLogEvents

Read FilterLogEvents

Methods

readsPrec :: Int -> ReadS FilterLogEvents

readList :: ReadS [FilterLogEvents]

readPrec :: ReadPrec FilterLogEvents

readListPrec :: ReadPrec [FilterLogEvents]

Show FilterLogEvents

Methods

showsPrec :: Int -> FilterLogEvents -> ShowS

show :: FilterLogEvents -> String

showList :: [FilterLogEvents] -> ShowS

Generic FilterLogEvents

Associated Types

type Rep FilterLogEvents :: * -> *

Methods

from :: FilterLogEvents -> Rep FilterLogEvents x

to :: Rep FilterLogEvents x -> FilterLogEvents

Hashable FilterLogEvents

Methods

hashWithSalt :: Int -> FilterLogEvents -> Int

hash :: FilterLogEvents -> Int

ToJSON FilterLogEvents

Methods

toJSON :: FilterLogEvents -> Value

toEncoding :: FilterLogEvents -> Encoding

toJSONList :: [FilterLogEvents] -> Value

toEncodingList :: [FilterLogEvents] -> Encoding

NFData FilterLogEvents

Methods

rnf :: FilterLogEvents -> ()

AWSPager FilterLogEvents

Methods

page :: FilterLogEvents -> Rs FilterLogEvents -> Maybe FilterLogEvents

AWSRequest FilterLogEvents

Associated Types

type Rs FilterLogEvents :: *

Methods

request :: FilterLogEvents -> Request FilterLogEvents

response :: MonadResource m => Logger -> Service -> Proxy * FilterLogEvents -> ClientResponse -> m (Response FilterLogEvents)

ToPath FilterLogEvents

Methods

toPath :: FilterLogEvents -> ByteString

ToHeaders FilterLogEvents

Methods

toHeaders :: FilterLogEvents -> [Header]

ToQuery FilterLogEvents

Methods

toQuery :: FilterLogEvents -> QueryString

type Rep FilterLogEvents

type Rep FilterLogEvents = D1 (MetaData "FilterLogEvents" "Network.AWS.CloudWatchLogs.FilterLogEvents" "amazonka-cloudwatch-logs-1.4.5-JoaCELOvIeKI9iDLq1iWip" False) (C1 (MetaCons "FilterLogEvents'" PrefixI True) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_fleStartTime") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Nat))) (S1 (MetaSel (Just Symbol "_fleNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_fleLogStreamNames") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (List1 Text)))) (S1 (MetaSel (Just Symbol "_fleEndTime") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Nat))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_fleLimit") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Nat))) (S1 (MetaSel (Just Symbol "_fleFilterPattern") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_fleInterleaved") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))) (S1 (MetaSel (Just Symbol "_fleLogGroupName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))))

type Rs FilterLogEvents

type Rs FilterLogEvents = FilterLogEventsResponse

Request Lenses

fleStartTime :: Lens' FilterLogEvents (Maybe Natural)

The start of the time range. Events with a timestamp prior to this time are not returned.

fleNextToken :: Lens' FilterLogEvents (Maybe Text)

The token for the next set of events to return. (You received this token from a previous call.)

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

Optional list of log stream names.

fleEndTime :: Lens' FilterLogEvents (Maybe Natural)

The end of the time range. Events with a timestamp later than this time are not returned.

fleLimit :: Lens' FilterLogEvents (Maybe Natural)

The maximum number of events to return. The default is 10,000 events.

fleFilterPattern :: Lens' FilterLogEvents (Maybe Text)

The filter pattern to use. If not provided, all the events are matched.

fleInterleaved :: Lens' FilterLogEvents (Maybe Bool)

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

The name of the log group.

Destructuring the Response

filterLogEventsResponse

Arguments

:: Int

flersResponseStatus

-> 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 - 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

See: filterLogEventsResponse smart constructor.

Instances

Eq FilterLogEventsResponse

Methods

(==) :: FilterLogEventsResponse -> FilterLogEventsResponse -> Bool

(/=) :: FilterLogEventsResponse -> FilterLogEventsResponse -> Bool

Data FilterLogEventsResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> FilterLogEventsResponse -> c FilterLogEventsResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c FilterLogEventsResponse

toConstr :: FilterLogEventsResponse -> Constr

dataTypeOf :: FilterLogEventsResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c FilterLogEventsResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c FilterLogEventsResponse)

gmapT :: (forall b. Data b => b -> b) -> FilterLogEventsResponse -> FilterLogEventsResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> FilterLogEventsResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> FilterLogEventsResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> FilterLogEventsResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> FilterLogEventsResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> FilterLogEventsResponse -> m FilterLogEventsResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> FilterLogEventsResponse -> m FilterLogEventsResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> FilterLogEventsResponse -> m FilterLogEventsResponse

Read FilterLogEventsResponse

Methods

readsPrec :: Int -> ReadS FilterLogEventsResponse

readList :: ReadS [FilterLogEventsResponse]

readPrec :: ReadPrec FilterLogEventsResponse

readListPrec :: ReadPrec [FilterLogEventsResponse]

Show FilterLogEventsResponse

Methods

showsPrec :: Int -> FilterLogEventsResponse -> ShowS

show :: FilterLogEventsResponse -> String

showList :: [FilterLogEventsResponse] -> ShowS

Generic FilterLogEventsResponse

Associated Types

type Rep FilterLogEventsResponse :: * -> *

Methods

from :: FilterLogEventsResponse -> Rep FilterLogEventsResponse x

to :: Rep FilterLogEventsResponse x -> FilterLogEventsResponse

NFData FilterLogEventsResponse

Methods

rnf :: FilterLogEventsResponse -> ()

type Rep FilterLogEventsResponse

type Rep FilterLogEventsResponse = D1 (MetaData "FilterLogEventsResponse" "Network.AWS.CloudWatchLogs.FilterLogEvents" "amazonka-cloudwatch-logs-1.4.5-JoaCELOvIeKI9iDLq1iWip" False) (C1 (MetaCons "FilterLogEventsResponse'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_flersSearchedLogStreams") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [SearchedLogStream]))) (S1 (MetaSel (Just Symbol "_flersNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_flersEvents") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [FilteredLogEvent]))) (S1 (MetaSel (Just Symbol "_flersResponseStatus") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 Int)))))

Response Lenses

flersSearchedLogStreams :: Lens' FilterLogEventsResponse [SearchedLogStream]

Indicates which log streams have been searched and whether each has been searched completely.

flersNextToken :: Lens' FilterLogEventsResponse (Maybe Text)

The token to use when requesting the next set of items. The token expires after 24 hours.

flersEvents :: Lens' FilterLogEventsResponse [FilteredLogEvent]

The matched events.

flersResponseStatus :: Lens' FilterLogEventsResponse Int

• - | The response status code.