Network.AWS.CloudWatchLogs.DescribeLogStreams

Returns all the log streams that are associated with the specified log group. The list returned in the response is ASCII-sorted by log stream name.

By default, this operation returns up to 50 log streams. If there are more log streams to list, the response would contain a nextToken value in the response body. You can also limit the number of log streams returned in the response by specifying the limit parameter in the request. 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
• dlssDescending
• dlssNextToken
• dlssLogStreamNamePrefix
• dlssLimit
• dlssLogGroupName

data DescribeLogStreams

See: describeLogStreams smart constructor.

Instances

Eq DescribeLogStreams

Methods

(==) :: DescribeLogStreams -> DescribeLogStreams -> Bool

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

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

Methods

readsPrec :: Int -> ReadS DescribeLogStreams

readList :: ReadS [DescribeLogStreams]

readPrec :: ReadPrec DescribeLogStreams

readListPrec :: ReadPrec [DescribeLogStreams]

Show DescribeLogStreams

Methods

showsPrec :: Int -> DescribeLogStreams -> ShowS

show :: DescribeLogStreams -> String

showList :: [DescribeLogStreams] -> ShowS

Generic DescribeLogStreams

Associated Types

type Rep DescribeLogStreams :: * -> *

Methods

from :: DescribeLogStreams -> Rep DescribeLogStreams x

to :: Rep DescribeLogStreams x -> DescribeLogStreams

Hashable DescribeLogStreams

Methods

hashWithSalt :: Int -> DescribeLogStreams -> Int

hash :: DescribeLogStreams -> Int

ToJSON DescribeLogStreams

Methods

toJSON :: DescribeLogStreams -> Value

toEncoding :: DescribeLogStreams -> Encoding

toJSONList :: [DescribeLogStreams] -> Value

toEncodingList :: [DescribeLogStreams] -> Encoding

NFData DescribeLogStreams

Methods

rnf :: DescribeLogStreams -> ()

AWSPager DescribeLogStreams

Methods

page :: DescribeLogStreams -> Rs DescribeLogStreams -> Maybe DescribeLogStreams

AWSRequest DescribeLogStreams

Associated Types

type Rs DescribeLogStreams :: *

Methods

request :: DescribeLogStreams -> Request DescribeLogStreams

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

ToQuery DescribeLogStreams

Methods

toQuery :: DescribeLogStreams -> QueryString

ToPath DescribeLogStreams

Methods

toPath :: DescribeLogStreams -> ByteString

ToHeaders DescribeLogStreams

Methods

toHeaders :: DescribeLogStreams -> [Header]

type Rep DescribeLogStreams

type Rep DescribeLogStreams = D1 (MetaData "DescribeLogStreams" "Network.AWS.CloudWatchLogs.DescribeLogStreams" "amazonka-cloudwatch-logs-1.4.3-KJyQH8tL8lh8FhkJJO1rsH" 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

type Rs DescribeLogStreams = DescribeLogStreamsResponse

Request Lenses

dlssOrderBy :: Lens' DescribeLogStreams (Maybe OrderBy)

Specifies what to order the returned log streams by. Valid arguments are 'LogStreamName' or 'LastEventTime'. If you don't specify a value, results are ordered by LogStreamName. If 'LastEventTime' is chosen, the request cannot also contain a logStreamNamePrefix.

dlssDescending :: Lens' DescribeLogStreams (Maybe Bool)

If set to true, results are returned in descending order. If you don't specify a value or set it to false, results are returned in ascending order.

dlssNextToken :: Lens' DescribeLogStreams (Maybe Text)

A string token used for pagination that points to the next page of results. It must be a value obtained from the response of the previous DescribeLogStreams request.

dlssLogStreamNamePrefix :: Lens' DescribeLogStreams (Maybe Text)

Will only return log streams that match the provided logStreamNamePrefix. If you don't specify a value, no prefix filter is applied.

dlssLimit :: Lens' DescribeLogStreams (Maybe Natural)

The maximum number of items returned in the response. If you don't specify a value, the request would return up to 50 items.

dlssLogGroupName :: Lens' DescribeLogStreams Text

The log group name for which log streams are to be listed.

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
• dlsrsLogStreams
• dlsrsResponseStatus

data DescribeLogStreamsResponse

See: describeLogStreamsResponse smart constructor.

Instances

Eq DescribeLogStreamsResponse

Methods

(==) :: DescribeLogStreamsResponse -> DescribeLogStreamsResponse -> Bool

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

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

Methods

readsPrec :: Int -> ReadS DescribeLogStreamsResponse

readList :: ReadS [DescribeLogStreamsResponse]

readPrec :: ReadPrec DescribeLogStreamsResponse

readListPrec :: ReadPrec [DescribeLogStreamsResponse]

Show DescribeLogStreamsResponse

Methods

showsPrec :: Int -> DescribeLogStreamsResponse -> ShowS

show :: DescribeLogStreamsResponse -> String

showList :: [DescribeLogStreamsResponse] -> ShowS

Generic DescribeLogStreamsResponse

Associated Types

type Rep DescribeLogStreamsResponse :: * -> *

Methods

from :: DescribeLogStreamsResponse -> Rep DescribeLogStreamsResponse x

to :: Rep DescribeLogStreamsResponse x -> DescribeLogStreamsResponse

NFData DescribeLogStreamsResponse

Methods

rnf :: DescribeLogStreamsResponse -> ()

type Rep DescribeLogStreamsResponse

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

dlsrsNextToken :: Lens' DescribeLogStreamsResponse (Maybe Text)

Undocumented member.

dlsrsLogStreams :: Lens' DescribeLogStreamsResponse [LogStream]

Undocumented member.

dlsrsResponseStatus :: Lens' DescribeLogStreamsResponse Int

The response status code.