amazonka-cloudwatch-logs-1.6.0: Amazon CloudWatch Logs SDK.

Copyright(c) 2013-2018 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.CloudWatchLogs.DescribeLogStreams

Contents

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.

Synopsis

Creating a Request

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 # 
Data 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 # 
Show DescribeLogStreams # 
Generic DescribeLogStreams # 
Hashable DescribeLogStreams # 
ToJSON DescribeLogStreams # 
NFData DescribeLogStreams # 

Methods

rnf :: DescribeLogStreams -> () #

AWSPager DescribeLogStreams # 
AWSRequest DescribeLogStreams # 
ToHeaders DescribeLogStreams # 
ToPath DescribeLogStreams # 
ToQuery DescribeLogStreams # 
type Rep DescribeLogStreams # 
type Rep DescribeLogStreams = D1 * (MetaData "DescribeLogStreams" "Network.AWS.CloudWatchLogs.DescribeLogStreams" "amazonka-cloudwatch-logs-1.6.0-HKcajwmKjdx6seMLJU2od6" False) (C1 * (MetaCons "DescribeLogStreams'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_dlssOrderBy") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe OrderBy))) ((:*:) * (S1 * (MetaSel (Just Symbol "_dlssDescending") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Bool))) (S1 * (MetaSel (Just Symbol "_dlssNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))))) ((:*:) * (S1 * (MetaSel (Just Symbol "_dlssLogStreamNamePrefix") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_dlssLimit") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Nat))) (S1 * (MetaSel (Just Symbol "_dlssLogGroupName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text))))))
type Rs DescribeLogStreams # 

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 #

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:

data DescribeLogStreamsResponse #

See: describeLogStreamsResponse smart constructor.

Instances

Eq DescribeLogStreamsResponse # 
Data DescribeLogStreamsResponse # 

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 # 
Show DescribeLogStreamsResponse # 
Generic DescribeLogStreamsResponse # 
NFData DescribeLogStreamsResponse # 
type Rep DescribeLogStreamsResponse # 
type Rep DescribeLogStreamsResponse = D1 * (MetaData "DescribeLogStreamsResponse" "Network.AWS.CloudWatchLogs.DescribeLogStreams" "amazonka-cloudwatch-logs-1.6.0-HKcajwmKjdx6seMLJU2od6" False) (C1 * (MetaCons "DescribeLogStreamsResponse'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_dlsrsNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_dlsrsLogStreams") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [LogStream]))) (S1 * (MetaSel (Just Symbol "_dlsrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int)))))

Response Lenses

dlsrsResponseStatus :: Lens' DescribeLogStreamsResponse Int #

  • - | The response status code.