Network.AWS.CloudWatchLogs.GetLogEvents

Lists log events from the specified log stream. You can list all the log events or filter using a time range.

By default, this operation returns as many log events as can fit in a response size of 1MB (up to 10,000 log events). If the results include tokens, there are more log events available. You can get additional log events by specifying one of the tokens in a subsequent call.

Creating a Request

getLogEvents

Arguments

:: Text

gleLogGroupName

-> Text

gleLogStreamName

-> GetLogEvents

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:

• gleStartTime - The start of the time range. Events with a timestamp earlier than this time are not included.
• gleStartFromHead - If the value is true, the earliest log events are returned first. If the value is false, the latest log events are returned first. The default value is false.
• gleNextToken - The token for the next set of items to return. (You received this token from a previous call.)
• gleEndTime - The end of the time range. Events with a timestamp later than this time are not included.
• gleLimit - The maximum number of log events returned. If you don't specify a value, the maximum is as many log events as can fit in a response size of 1MB, up to 10,000 log events.
• gleLogGroupName - The name of the log group.
• gleLogStreamName - The name of the log stream.

data GetLogEvents

See: getLogEvents smart constructor.

Instances

Eq GetLogEvents

Methods

(==) :: GetLogEvents -> GetLogEvents -> Bool

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

Data GetLogEvents

Methods

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

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

toConstr :: GetLogEvents -> Constr

dataTypeOf :: GetLogEvents -> DataType

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

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

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

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

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

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

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

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

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

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

Read GetLogEvents

Methods

readsPrec :: Int -> ReadS GetLogEvents

readList :: ReadS [GetLogEvents]

readPrec :: ReadPrec GetLogEvents

readListPrec :: ReadPrec [GetLogEvents]

Show GetLogEvents

Methods

showsPrec :: Int -> GetLogEvents -> ShowS

show :: GetLogEvents -> String

showList :: [GetLogEvents] -> ShowS

Generic GetLogEvents

Associated Types

type Rep GetLogEvents :: * -> *

Methods

from :: GetLogEvents -> Rep GetLogEvents x

to :: Rep GetLogEvents x -> GetLogEvents

Hashable GetLogEvents

Methods

hashWithSalt :: Int -> GetLogEvents -> Int

hash :: GetLogEvents -> Int

ToJSON GetLogEvents

Methods

toJSON :: GetLogEvents -> Value

toEncoding :: GetLogEvents -> Encoding

toJSONList :: [GetLogEvents] -> Value

toEncodingList :: [GetLogEvents] -> Encoding

NFData GetLogEvents

Methods

rnf :: GetLogEvents -> ()

AWSRequest GetLogEvents

Associated Types

type Rs GetLogEvents :: *

Methods

request :: GetLogEvents -> Request GetLogEvents

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

ToPath GetLogEvents

Methods

toPath :: GetLogEvents -> ByteString

ToHeaders GetLogEvents

Methods

toHeaders :: GetLogEvents -> [Header]

ToQuery GetLogEvents

Methods

toQuery :: GetLogEvents -> QueryString

type Rep GetLogEvents

type Rep GetLogEvents = D1 (MetaData "GetLogEvents" "Network.AWS.CloudWatchLogs.GetLogEvents" "amazonka-cloudwatch-logs-1.4.5-JoaCELOvIeKI9iDLq1iWip" False) (C1 (MetaCons "GetLogEvents'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_gleStartTime") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Nat))) ((:*:) (S1 (MetaSel (Just Symbol "_gleStartFromHead") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))) (S1 (MetaSel (Just Symbol "_gleNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_gleEndTime") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Nat))) (S1 (MetaSel (Just Symbol "_gleLimit") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Nat)))) ((:*:) (S1 (MetaSel (Just Symbol "_gleLogGroupName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_gleLogStreamName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))))

type Rs GetLogEvents

type Rs GetLogEvents = GetLogEventsResponse

Request Lenses

gleStartTime :: Lens' GetLogEvents (Maybe Natural)

The start of the time range. Events with a timestamp earlier than this time are not included.

gleStartFromHead :: Lens' GetLogEvents (Maybe Bool)

If the value is true, the earliest log events are returned first. If the value is false, the latest log events are returned first. The default value is false.

gleNextToken :: Lens' GetLogEvents (Maybe Text)

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

gleEndTime :: Lens' GetLogEvents (Maybe Natural)

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

gleLimit :: Lens' GetLogEvents (Maybe Natural)

The maximum number of log events returned. If you don't specify a value, the maximum is as many log events as can fit in a response size of 1MB, up to 10,000 log events.

gleLogGroupName :: Lens' GetLogEvents Text

The name of the log group.

gleLogStreamName :: Lens' GetLogEvents Text

The name of the log stream.

Destructuring the Response

getLogEventsResponse

Arguments

:: Int

glersResponseStatus

-> GetLogEventsResponse

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:

• glersNextBackwardToken - The token for the next set of items in the backward direction. The token expires after 24 hours.
• glersNextForwardToken - The token for the next set of items in the forward direction. The token expires after 24 hours.
• glersEvents - The events.
• glersResponseStatus - -- | The response status code.

data GetLogEventsResponse

See: getLogEventsResponse smart constructor.

Instances

Eq GetLogEventsResponse

Methods

(==) :: GetLogEventsResponse -> GetLogEventsResponse -> Bool

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

Data GetLogEventsResponse

Methods

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

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

toConstr :: GetLogEventsResponse -> Constr

dataTypeOf :: GetLogEventsResponse -> DataType

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

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

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

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

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

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

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

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

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

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

Read GetLogEventsResponse

Methods

readsPrec :: Int -> ReadS GetLogEventsResponse

readList :: ReadS [GetLogEventsResponse]

readPrec :: ReadPrec GetLogEventsResponse

readListPrec :: ReadPrec [GetLogEventsResponse]

Show GetLogEventsResponse

Methods

showsPrec :: Int -> GetLogEventsResponse -> ShowS

show :: GetLogEventsResponse -> String

showList :: [GetLogEventsResponse] -> ShowS

Generic GetLogEventsResponse

Associated Types

type Rep GetLogEventsResponse :: * -> *

Methods

from :: GetLogEventsResponse -> Rep GetLogEventsResponse x

to :: Rep GetLogEventsResponse x -> GetLogEventsResponse

NFData GetLogEventsResponse

Methods

rnf :: GetLogEventsResponse -> ()

type Rep GetLogEventsResponse

type Rep GetLogEventsResponse = D1 (MetaData "GetLogEventsResponse" "Network.AWS.CloudWatchLogs.GetLogEvents" "amazonka-cloudwatch-logs-1.4.5-JoaCELOvIeKI9iDLq1iWip" False) (C1 (MetaCons "GetLogEventsResponse'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_glersNextBackwardToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_glersNextForwardToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_glersEvents") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [OutputLogEvent]))) (S1 (MetaSel (Just Symbol "_glersResponseStatus") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 Int)))))

Response Lenses

glersNextBackwardToken :: Lens' GetLogEventsResponse (Maybe Text)

The token for the next set of items in the backward direction. The token expires after 24 hours.

glersNextForwardToken :: Lens' GetLogEventsResponse (Maybe Text)

The token for the next set of items in the forward direction. The token expires after 24 hours.

glersEvents :: Lens' GetLogEventsResponse [OutputLogEvent]

The events.

glersResponseStatus :: Lens' GetLogEventsResponse Int

• - | The response status code.