amazonka-cloudwatch-logs-1.6.1: 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 Source #

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

See: describeLogStreams smart constructor.

Instances
Eq DescribeLogStreams Source # 
Instance details

Defined in Network.AWS.CloudWatchLogs.DescribeLogStreams

Data DescribeLogStreams Source # 
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 Source # 
Instance details

Defined in Network.AWS.CloudWatchLogs.DescribeLogStreams

Show DescribeLogStreams Source # 
Instance details

Defined in Network.AWS.CloudWatchLogs.DescribeLogStreams

Generic DescribeLogStreams Source # 
Instance details

Defined in Network.AWS.CloudWatchLogs.DescribeLogStreams

Associated Types

type Rep DescribeLogStreams :: Type -> Type #

Hashable DescribeLogStreams Source # 
Instance details

Defined in Network.AWS.CloudWatchLogs.DescribeLogStreams

ToJSON DescribeLogStreams Source # 
Instance details

Defined in Network.AWS.CloudWatchLogs.DescribeLogStreams

AWSPager DescribeLogStreams Source # 
Instance details

Defined in Network.AWS.CloudWatchLogs.DescribeLogStreams

AWSRequest DescribeLogStreams Source # 
Instance details

Defined in Network.AWS.CloudWatchLogs.DescribeLogStreams

Associated Types

type Rs DescribeLogStreams :: Type #

ToHeaders DescribeLogStreams Source # 
Instance details

Defined in Network.AWS.CloudWatchLogs.DescribeLogStreams

ToPath DescribeLogStreams Source # 
Instance details

Defined in Network.AWS.CloudWatchLogs.DescribeLogStreams

ToQuery DescribeLogStreams Source # 
Instance details

Defined in Network.AWS.CloudWatchLogs.DescribeLogStreams

NFData DescribeLogStreams Source # 
Instance details

Defined in Network.AWS.CloudWatchLogs.DescribeLogStreams

Methods

rnf :: DescribeLogStreams -> () #

type Rep DescribeLogStreams Source # 
Instance details

Defined in Network.AWS.CloudWatchLogs.DescribeLogStreams

type Rep DescribeLogStreams = D1 (MetaData "DescribeLogStreams" "Network.AWS.CloudWatchLogs.DescribeLogStreams" "amazonka-cloudwatch-logs-1.6.1-3MDuvRaDmjeBjiAkGx8qXs" 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 Source # 
Instance details

Defined in Network.AWS.CloudWatchLogs.DescribeLogStreams

Request Lenses

dlssOrderBy :: Lens' DescribeLogStreams (Maybe OrderBy) Source #

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) Source #

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) Source #

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

dlssLogStreamNamePrefix :: Lens' DescribeLogStreams (Maybe Text) Source #

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

dlssLimit :: Lens' DescribeLogStreams (Maybe Natural) Source #

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

dlssLogGroupName :: Lens' DescribeLogStreams Text Source #

The name of the log group.

Destructuring the Response

describeLogStreamsResponse Source #

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

See: describeLogStreamsResponse smart constructor.

Instances
Eq DescribeLogStreamsResponse Source # 
Instance details

Defined in Network.AWS.CloudWatchLogs.DescribeLogStreams

Data DescribeLogStreamsResponse Source # 
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 Source # 
Instance details

Defined in Network.AWS.CloudWatchLogs.DescribeLogStreams

Show DescribeLogStreamsResponse Source # 
Instance details

Defined in Network.AWS.CloudWatchLogs.DescribeLogStreams

Generic DescribeLogStreamsResponse Source # 
Instance details

Defined in Network.AWS.CloudWatchLogs.DescribeLogStreams

Associated Types

type Rep DescribeLogStreamsResponse :: Type -> Type #

NFData DescribeLogStreamsResponse Source # 
Instance details

Defined in Network.AWS.CloudWatchLogs.DescribeLogStreams

type Rep DescribeLogStreamsResponse Source # 
Instance details

Defined in Network.AWS.CloudWatchLogs.DescribeLogStreams

type Rep DescribeLogStreamsResponse = D1 (MetaData "DescribeLogStreamsResponse" "Network.AWS.CloudWatchLogs.DescribeLogStreams" "amazonka-cloudwatch-logs-1.6.1-3MDuvRaDmjeBjiAkGx8qXs" 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