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

Network.AWS.CloudWatchLogs.DescribeLogStreams

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists the log streams for the specified log group. You can list all the log streams or filter the results by prefix. You can also control how the results are ordered.

This operation has a limit of five transactions per second, after which transactions are throttled.

This operation returns paginated results.

Creating a Request

describeLogStreams #

Arguments

:: Text	`dlssLogGroupName`
-> DescribeLogStreams

Creates a value of DescribeLogStreams with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

dlssOrderBy - If the value is LogStreamName , the results are ordered by log stream name. If the value is LastEventTime , the results are ordered by the event time. The default value is LogStreamName . If you order the results by event time, you cannot specify the logStreamNamePrefix parameter. lastEventTimestamp represents the time of the most recent log event in the log stream in CloudWatch Logs. This number is expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. lastEventTimeStamp updates on an eventual consistency basis. It typically updates in less than an hour from ingestion, but may take longer in some rare situations.
dlssDescending - If the value is true, results are returned in descending order. If the value is to false, results are returned in ascending order. The default value is false.
dlssNextToken - The token for the next set of items to return. (You received this token from a previous call.)
dlssLogStreamNamePrefix - The prefix to match. iIf orderBy is LastEventTime ,you cannot specify this parameter.
dlssLimit - The maximum number of items returned. If you don't specify a value, the default is up to 50 items.
dlssLogGroupName - The name of the log group.

data DescribeLogStreams #

See: describeLogStreams smart constructor.

Instances

Eq DescribeLogStreams #
Instance details Defined in Network.AWS.CloudWatchLogs.DescribeLogStreams Methods (==) :: DescribeLogStreams -> DescribeLogStreams -> Bool # (/=) :: DescribeLogStreams -> DescribeLogStreams -> Bool #
Data DescribeLogStreams #
Instance details Defined in Network.AWS.CloudWatchLogs.DescribeLogStreams Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeLogStreams -> c DescribeLogStreams # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeLogStreams # toConstr :: DescribeLogStreams -> Constr # dataTypeOf :: DescribeLogStreams -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c DescribeLogStreams) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeLogStreams) # gmapT :: (forall b. Data b => b -> b) -> DescribeLogStreams -> DescribeLogStreams # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeLogStreams -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeLogStreams -> r # gmapQ :: (forall d. Data d => d -> u) -> DescribeLogStreams -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeLogStreams -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeLogStreams -> m DescribeLogStreams # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeLogStreams -> m DescribeLogStreams # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeLogStreams -> m DescribeLogStreams #
Read DescribeLogStreams #
Instance details Defined in Network.AWS.CloudWatchLogs.DescribeLogStreams Methods readsPrec :: Int -> ReadS DescribeLogStreams # readList :: ReadS [DescribeLogStreams] # readPrec :: ReadPrec DescribeLogStreams # readListPrec :: ReadPrec [DescribeLogStreams] #
Show DescribeLogStreams #
Instance details Defined in Network.AWS.CloudWatchLogs.DescribeLogStreams Methods showsPrec :: Int -> DescribeLogStreams -> ShowS # show :: DescribeLogStreams -> String # showList :: [DescribeLogStreams] -> ShowS #
Generic DescribeLogStreams #
Instance details Defined in Network.AWS.CloudWatchLogs.DescribeLogStreams Associated Types type Rep DescribeLogStreams :: * -> * # Methods from :: DescribeLogStreams -> Rep DescribeLogStreams x # to :: Rep DescribeLogStreams x -> DescribeLogStreams #
Hashable DescribeLogStreams #
Instance details Defined in Network.AWS.CloudWatchLogs.DescribeLogStreams Methods hashWithSalt :: Int -> DescribeLogStreams -> Int # hash :: DescribeLogStreams -> Int #
ToJSON DescribeLogStreams #
Instance details Defined in Network.AWS.CloudWatchLogs.DescribeLogStreams Methods toJSON :: DescribeLogStreams -> Value # toEncoding :: DescribeLogStreams -> Encoding # toJSONList :: [DescribeLogStreams] -> Value # toEncodingList :: [DescribeLogStreams] -> Encoding #
AWSPager DescribeLogStreams #
Instance details Defined in Network.AWS.CloudWatchLogs.DescribeLogStreams Methods page :: DescribeLogStreams -> Rs DescribeLogStreams -> Maybe DescribeLogStreams #
AWSRequest DescribeLogStreams #
Instance details Defined in Network.AWS.CloudWatchLogs.DescribeLogStreams Associated Types type Rs DescribeLogStreams :: * # Methods request :: DescribeLogStreams -> Request DescribeLogStreams # response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy DescribeLogStreams -> ClientResponse -> m (Response DescribeLogStreams) #
ToHeaders DescribeLogStreams #
Instance details Defined in Network.AWS.CloudWatchLogs.DescribeLogStreams Methods toHeaders :: DescribeLogStreams -> [Header] #
ToPath DescribeLogStreams #
Instance details Defined in Network.AWS.CloudWatchLogs.DescribeLogStreams Methods toPath :: DescribeLogStreams -> ByteString #
ToQuery DescribeLogStreams #
Instance details Defined in Network.AWS.CloudWatchLogs.DescribeLogStreams Methods toQuery :: DescribeLogStreams -> QueryString #
NFData DescribeLogStreams #
Instance details Defined in Network.AWS.CloudWatchLogs.DescribeLogStreams Methods rnf :: DescribeLogStreams -> () #
type Rep DescribeLogStreams #
Instance details Defined in Network.AWS.CloudWatchLogs.DescribeLogStreams type Rep DescribeLogStreams = D1 (MetaData "DescribeLogStreams" "Network.AWS.CloudWatchLogs.DescribeLogStreams" "amazonka-cloudwatch-logs-1.6.0-9ucWfmPUwVA5gBPycSzRQt" False) (C1 (MetaCons "DescribeLogStreams'" PrefixI True) ((S1 (MetaSel (Just "_dlssOrderBy") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe OrderBy)) :: (S1 (MetaSel (Just "_dlssDescending") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool)) :: S1 (MetaSel (Just "_dlssNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 (MetaSel (Just "_dlssLogStreamNamePrefix") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: (S1 (MetaSel (Just "_dlssLimit") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Nat)) :*: S1 (MetaSel (Just "_dlssLogGroupName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))))
type Rs DescribeLogStreams #
Instance details Defined in Network.AWS.CloudWatchLogs.DescribeLogStreams type Rs DescribeLogStreams = DescribeLogStreamsResponse

Request Lenses

dlssOrderBy :: Lens' DescribeLogStreams (Maybe OrderBy) #

If the value is LogStreamName , the results are ordered by log stream name. If the value is LastEventTime , the results are ordered by the event time. The default value is LogStreamName . If you order the results by event time, you cannot specify the logStreamNamePrefix parameter. lastEventTimestamp represents the time of the most recent log event in the log stream in CloudWatch Logs. This number is expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. lastEventTimeStamp updates on an eventual consistency basis. It typically updates in less than an hour from ingestion, but may take longer in some rare situations.

dlssDescending :: Lens' DescribeLogStreams (Maybe Bool) #

If the value is true, results are returned in descending order. If the value is to false, results are returned in ascending order. The default value is false.

dlssNextToken :: Lens' DescribeLogStreams (Maybe Text) #

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

dlssLogStreamNamePrefix :: Lens' DescribeLogStreams (Maybe Text) #

The prefix to match. iIf orderBy is LastEventTime ,you cannot specify this parameter.

dlssLimit :: Lens' DescribeLogStreams (Maybe Natural) #

The maximum number of items returned. If you don't specify a value, the default is up to 50 items.

dlssLogGroupName :: Lens' DescribeLogStreams Text #

The name of the log group.

Destructuring the Response

describeLogStreamsResponse #

Arguments

:: Int	`dlsrsResponseStatus`
-> DescribeLogStreamsResponse

Creates a value of DescribeLogStreamsResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

dlsrsNextToken - Undocumented member.
dlsrsLogStreams - The log streams.
dlsrsResponseStatus - -- | The response status code.

data DescribeLogStreamsResponse #

See: describeLogStreamsResponse smart constructor.

Instances

Eq DescribeLogStreamsResponse #
Instance details Defined in Network.AWS.CloudWatchLogs.DescribeLogStreams Methods (==) :: DescribeLogStreamsResponse -> DescribeLogStreamsResponse -> Bool # (/=) :: DescribeLogStreamsResponse -> DescribeLogStreamsResponse -> Bool #
Data DescribeLogStreamsResponse #
Instance details Defined in Network.AWS.CloudWatchLogs.DescribeLogStreams Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeLogStreamsResponse -> c DescribeLogStreamsResponse # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeLogStreamsResponse # toConstr :: DescribeLogStreamsResponse -> Constr # dataTypeOf :: DescribeLogStreamsResponse -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c DescribeLogStreamsResponse) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeLogStreamsResponse) # gmapT :: (forall b. Data b => b -> b) -> DescribeLogStreamsResponse -> DescribeLogStreamsResponse # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeLogStreamsResponse -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeLogStreamsResponse -> r # gmapQ :: (forall d. Data d => d -> u) -> DescribeLogStreamsResponse -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeLogStreamsResponse -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeLogStreamsResponse -> m DescribeLogStreamsResponse # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeLogStreamsResponse -> m DescribeLogStreamsResponse # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeLogStreamsResponse -> m DescribeLogStreamsResponse #
Read DescribeLogStreamsResponse #
Instance details Defined in Network.AWS.CloudWatchLogs.DescribeLogStreams Methods readsPrec :: Int -> ReadS DescribeLogStreamsResponse # readList :: ReadS [DescribeLogStreamsResponse] # readPrec :: ReadPrec DescribeLogStreamsResponse # readListPrec :: ReadPrec [DescribeLogStreamsResponse] #
Show DescribeLogStreamsResponse #
Instance details Defined in Network.AWS.CloudWatchLogs.DescribeLogStreams Methods showsPrec :: Int -> DescribeLogStreamsResponse -> ShowS # show :: DescribeLogStreamsResponse -> String # showList :: [DescribeLogStreamsResponse] -> ShowS #
Generic DescribeLogStreamsResponse #
Instance details Defined in Network.AWS.CloudWatchLogs.DescribeLogStreams Associated Types type Rep DescribeLogStreamsResponse :: * -> * # Methods from :: DescribeLogStreamsResponse -> Rep DescribeLogStreamsResponse x # to :: Rep DescribeLogStreamsResponse x -> DescribeLogStreamsResponse #
NFData DescribeLogStreamsResponse #
Instance details Defined in Network.AWS.CloudWatchLogs.DescribeLogStreams Methods rnf :: DescribeLogStreamsResponse -> () #
type Rep DescribeLogStreamsResponse #
Instance details Defined in Network.AWS.CloudWatchLogs.DescribeLogStreams type Rep DescribeLogStreamsResponse = D1 (MetaData "DescribeLogStreamsResponse" "Network.AWS.CloudWatchLogs.DescribeLogStreams" "amazonka-cloudwatch-logs-1.6.0-9ucWfmPUwVA5gBPycSzRQt" False) (C1 (MetaCons "DescribeLogStreamsResponse'" PrefixI True) (S1 (MetaSel (Just "_dlsrsNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: (S1 (MetaSel (Just "_dlsrsLogStreams") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [LogStream])) :: S1 (MetaSel (Just "_dlsrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int))))

Response Lenses

dlsrsNextToken :: Lens' DescribeLogStreamsResponse (Maybe Text) #

Undocumented member.

dlsrsLogStreams :: Lens' DescribeLogStreamsResponse [LogStream] #

The log streams.

dlsrsResponseStatus :: Lens' DescribeLogStreamsResponse Int #

- | The response status code.