{-# LANGUAGE DeriveGeneric #-}
{-# LANGUAGE DuplicateRecordFields #-}
{-# LANGUAGE NamedFieldPuns #-}
{-# LANGUAGE OverloadedStrings #-}
{-# LANGUAGE RecordWildCards #-}
{-# LANGUAGE StrictData #-}
{-# LANGUAGE TypeFamilies #-}
{-# LANGUAGE NoImplicitPrelude #-}
{-# OPTIONS_GHC -fno-warn-unused-binds #-}
{-# OPTIONS_GHC -fno-warn-unused-imports #-}
{-# OPTIONS_GHC -fno-warn-unused-matches #-}

-- Derived from AWS service descriptions, licensed under Apache 2.0.

-- |
-- Module      : Amazonka.CloudWatchLogs.DescribeLogStreams
-- Copyright   : (c) 2013-2023 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
--
-- 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.
--
-- If you are using CloudWatch cross-account observability, you can use
-- this operation in a monitoring account and view data from the linked
-- source accounts. For more information, see
-- <https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Unified-Cross-Account.html CloudWatch cross-account observability>.
--
-- This operation returns paginated results.
module Amazonka.CloudWatchLogs.DescribeLogStreams
  ( -- * Creating a Request
    DescribeLogStreams (..),
    newDescribeLogStreams,

    -- * Request Lenses
    describeLogStreams_descending,
    describeLogStreams_limit,
    describeLogStreams_logGroupIdentifier,
    describeLogStreams_logStreamNamePrefix,
    describeLogStreams_nextToken,
    describeLogStreams_orderBy,
    describeLogStreams_logGroupName,

    -- * Destructuring the Response
    DescribeLogStreamsResponse (..),
    newDescribeLogStreamsResponse,

    -- * Response Lenses
    describeLogStreamsResponse_logStreams,
    describeLogStreamsResponse_nextToken,
    describeLogStreamsResponse_httpStatus,
  )
where

import Amazonka.CloudWatchLogs.Types
import qualified Amazonka.Core as Core
import qualified Amazonka.Core.Lens.Internal as Lens
import qualified Amazonka.Data as Data
import qualified Amazonka.Prelude as Prelude
import qualified Amazonka.Request as Request
import qualified Amazonka.Response as Response

-- | /See:/ 'newDescribeLogStreams' smart constructor.
data DescribeLogStreams = DescribeLogStreams'
  { -- | 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.
    DescribeLogStreams -> Maybe Bool
descending :: Prelude.Maybe Prelude.Bool,
    -- | The maximum number of items returned. If you don\'t specify a value, the
    -- default is up to 50 items.
    DescribeLogStreams -> Maybe Natural
limit :: Prelude.Maybe Prelude.Natural,
    -- | Specify either the name or ARN of the log group to view. If the log
    -- group is in a source account and you are using a monitoring account, you
    -- must use the log group ARN.
    --
    -- If you specify values for both @logGroupName@ and @logGroupIdentifier@,
    -- the action returns an @InvalidParameterException@ error.
    DescribeLogStreams -> Maybe Text
logGroupIdentifier :: Prelude.Maybe Prelude.Text,
    -- | The prefix to match.
    --
    -- If @orderBy@ is @LastEventTime@, you cannot specify this parameter.
    DescribeLogStreams -> Maybe Text
logStreamNamePrefix :: Prelude.Maybe Prelude.Text,
    -- | The token for the next set of items to return. (You received this token
    -- from a previous call.)
    DescribeLogStreams -> Maybe Text
nextToken :: Prelude.Maybe Prelude.Text,
    -- | 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 in rare
    -- situations might take longer.
    DescribeLogStreams -> Maybe OrderBy
orderBy :: Prelude.Maybe OrderBy,
    -- | The name of the log group.
    --
    -- If you specify values for both @logGroupName@ and @logGroupIdentifier@,
    -- the action returns an @InvalidParameterException@ error.
    DescribeLogStreams -> Text
logGroupName :: Prelude.Text
  }
  deriving (DescribeLogStreams -> DescribeLogStreams -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: DescribeLogStreams -> DescribeLogStreams -> Bool
$c/= :: DescribeLogStreams -> DescribeLogStreams -> Bool
== :: DescribeLogStreams -> DescribeLogStreams -> Bool
$c== :: DescribeLogStreams -> DescribeLogStreams -> Bool
Prelude.Eq, ReadPrec [DescribeLogStreams]
ReadPrec DescribeLogStreams
Int -> ReadS DescribeLogStreams
ReadS [DescribeLogStreams]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [DescribeLogStreams]
$creadListPrec :: ReadPrec [DescribeLogStreams]
readPrec :: ReadPrec DescribeLogStreams
$creadPrec :: ReadPrec DescribeLogStreams
readList :: ReadS [DescribeLogStreams]
$creadList :: ReadS [DescribeLogStreams]
readsPrec :: Int -> ReadS DescribeLogStreams
$creadsPrec :: Int -> ReadS DescribeLogStreams
Prelude.Read, Int -> DescribeLogStreams -> ShowS
[DescribeLogStreams] -> ShowS
DescribeLogStreams -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [DescribeLogStreams] -> ShowS
$cshowList :: [DescribeLogStreams] -> ShowS
show :: DescribeLogStreams -> String
$cshow :: DescribeLogStreams -> String
showsPrec :: Int -> DescribeLogStreams -> ShowS
$cshowsPrec :: Int -> DescribeLogStreams -> ShowS
Prelude.Show, forall x. Rep DescribeLogStreams x -> DescribeLogStreams
forall x. DescribeLogStreams -> Rep DescribeLogStreams x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep DescribeLogStreams x -> DescribeLogStreams
$cfrom :: forall x. DescribeLogStreams -> Rep DescribeLogStreams x
Prelude.Generic)

-- |
-- Create a value of 'DescribeLogStreams' with all optional fields omitted.
--
-- Use <https://hackage.haskell.org/package/generic-lens generic-lens> or <https://hackage.haskell.org/package/optics optics> to modify other optional fields.
--
-- The following record fields are available, with the corresponding lenses provided
-- for backwards compatibility:
--
-- 'descending', 'describeLogStreams_descending' - 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.
--
-- 'limit', 'describeLogStreams_limit' - The maximum number of items returned. If you don\'t specify a value, the
-- default is up to 50 items.
--
-- 'logGroupIdentifier', 'describeLogStreams_logGroupIdentifier' - Specify either the name or ARN of the log group to view. If the log
-- group is in a source account and you are using a monitoring account, you
-- must use the log group ARN.
--
-- If you specify values for both @logGroupName@ and @logGroupIdentifier@,
-- the action returns an @InvalidParameterException@ error.
--
-- 'logStreamNamePrefix', 'describeLogStreams_logStreamNamePrefix' - The prefix to match.
--
-- If @orderBy@ is @LastEventTime@, you cannot specify this parameter.
--
-- 'nextToken', 'describeLogStreams_nextToken' - The token for the next set of items to return. (You received this token
-- from a previous call.)
--
-- 'orderBy', 'describeLogStreams_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 in rare
-- situations might take longer.
--
-- 'logGroupName', 'describeLogStreams_logGroupName' - The name of the log group.
--
-- If you specify values for both @logGroupName@ and @logGroupIdentifier@,
-- the action returns an @InvalidParameterException@ error.
newDescribeLogStreams ::
  -- | 'logGroupName'
  Prelude.Text ->
  DescribeLogStreams
newDescribeLogStreams :: Text -> DescribeLogStreams
newDescribeLogStreams Text
pLogGroupName_ =
  DescribeLogStreams'
    { $sel:descending:DescribeLogStreams' :: Maybe Bool
descending = forall a. Maybe a
Prelude.Nothing,
      $sel:limit:DescribeLogStreams' :: Maybe Natural
limit = forall a. Maybe a
Prelude.Nothing,
      $sel:logGroupIdentifier:DescribeLogStreams' :: Maybe Text
logGroupIdentifier = forall a. Maybe a
Prelude.Nothing,
      $sel:logStreamNamePrefix:DescribeLogStreams' :: Maybe Text
logStreamNamePrefix = forall a. Maybe a
Prelude.Nothing,
      $sel:nextToken:DescribeLogStreams' :: Maybe Text
nextToken = forall a. Maybe a
Prelude.Nothing,
      $sel:orderBy:DescribeLogStreams' :: Maybe OrderBy
orderBy = forall a. Maybe a
Prelude.Nothing,
      $sel:logGroupName:DescribeLogStreams' :: Text
logGroupName = Text
pLogGroupName_
    }

-- | 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.
describeLogStreams_descending :: Lens.Lens' DescribeLogStreams (Prelude.Maybe Prelude.Bool)
describeLogStreams_descending :: Lens' DescribeLogStreams (Maybe Bool)
describeLogStreams_descending = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeLogStreams' {Maybe Bool
descending :: Maybe Bool
$sel:descending:DescribeLogStreams' :: DescribeLogStreams -> Maybe Bool
descending} -> Maybe Bool
descending) (\s :: DescribeLogStreams
s@DescribeLogStreams' {} Maybe Bool
a -> DescribeLogStreams
s {$sel:descending:DescribeLogStreams' :: Maybe Bool
descending = Maybe Bool
a} :: DescribeLogStreams)

-- | The maximum number of items returned. If you don\'t specify a value, the
-- default is up to 50 items.
describeLogStreams_limit :: Lens.Lens' DescribeLogStreams (Prelude.Maybe Prelude.Natural)
describeLogStreams_limit :: Lens' DescribeLogStreams (Maybe Natural)
describeLogStreams_limit = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeLogStreams' {Maybe Natural
limit :: Maybe Natural
$sel:limit:DescribeLogStreams' :: DescribeLogStreams -> Maybe Natural
limit} -> Maybe Natural
limit) (\s :: DescribeLogStreams
s@DescribeLogStreams' {} Maybe Natural
a -> DescribeLogStreams
s {$sel:limit:DescribeLogStreams' :: Maybe Natural
limit = Maybe Natural
a} :: DescribeLogStreams)

-- | Specify either the name or ARN of the log group to view. If the log
-- group is in a source account and you are using a monitoring account, you
-- must use the log group ARN.
--
-- If you specify values for both @logGroupName@ and @logGroupIdentifier@,
-- the action returns an @InvalidParameterException@ error.
describeLogStreams_logGroupIdentifier :: Lens.Lens' DescribeLogStreams (Prelude.Maybe Prelude.Text)
describeLogStreams_logGroupIdentifier :: Lens' DescribeLogStreams (Maybe Text)
describeLogStreams_logGroupIdentifier = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeLogStreams' {Maybe Text
logGroupIdentifier :: Maybe Text
$sel:logGroupIdentifier:DescribeLogStreams' :: DescribeLogStreams -> Maybe Text
logGroupIdentifier} -> Maybe Text
logGroupIdentifier) (\s :: DescribeLogStreams
s@DescribeLogStreams' {} Maybe Text
a -> DescribeLogStreams
s {$sel:logGroupIdentifier:DescribeLogStreams' :: Maybe Text
logGroupIdentifier = Maybe Text
a} :: DescribeLogStreams)

-- | The prefix to match.
--
-- If @orderBy@ is @LastEventTime@, you cannot specify this parameter.
describeLogStreams_logStreamNamePrefix :: Lens.Lens' DescribeLogStreams (Prelude.Maybe Prelude.Text)
describeLogStreams_logStreamNamePrefix :: Lens' DescribeLogStreams (Maybe Text)
describeLogStreams_logStreamNamePrefix = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeLogStreams' {Maybe Text
logStreamNamePrefix :: Maybe Text
$sel:logStreamNamePrefix:DescribeLogStreams' :: DescribeLogStreams -> Maybe Text
logStreamNamePrefix} -> Maybe Text
logStreamNamePrefix) (\s :: DescribeLogStreams
s@DescribeLogStreams' {} Maybe Text
a -> DescribeLogStreams
s {$sel:logStreamNamePrefix:DescribeLogStreams' :: Maybe Text
logStreamNamePrefix = Maybe Text
a} :: DescribeLogStreams)

-- | The token for the next set of items to return. (You received this token
-- from a previous call.)
describeLogStreams_nextToken :: Lens.Lens' DescribeLogStreams (Prelude.Maybe Prelude.Text)
describeLogStreams_nextToken :: Lens' DescribeLogStreams (Maybe Text)
describeLogStreams_nextToken = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeLogStreams' {Maybe Text
nextToken :: Maybe Text
$sel:nextToken:DescribeLogStreams' :: DescribeLogStreams -> Maybe Text
nextToken} -> Maybe Text
nextToken) (\s :: DescribeLogStreams
s@DescribeLogStreams' {} Maybe Text
a -> DescribeLogStreams
s {$sel:nextToken:DescribeLogStreams' :: Maybe Text
nextToken = Maybe Text
a} :: DescribeLogStreams)

-- | 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 in rare
-- situations might take longer.
describeLogStreams_orderBy :: Lens.Lens' DescribeLogStreams (Prelude.Maybe OrderBy)
describeLogStreams_orderBy :: Lens' DescribeLogStreams (Maybe OrderBy)
describeLogStreams_orderBy = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeLogStreams' {Maybe OrderBy
orderBy :: Maybe OrderBy
$sel:orderBy:DescribeLogStreams' :: DescribeLogStreams -> Maybe OrderBy
orderBy} -> Maybe OrderBy
orderBy) (\s :: DescribeLogStreams
s@DescribeLogStreams' {} Maybe OrderBy
a -> DescribeLogStreams
s {$sel:orderBy:DescribeLogStreams' :: Maybe OrderBy
orderBy = Maybe OrderBy
a} :: DescribeLogStreams)

-- | The name of the log group.
--
-- If you specify values for both @logGroupName@ and @logGroupIdentifier@,
-- the action returns an @InvalidParameterException@ error.
describeLogStreams_logGroupName :: Lens.Lens' DescribeLogStreams Prelude.Text
describeLogStreams_logGroupName :: Lens' DescribeLogStreams Text
describeLogStreams_logGroupName = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeLogStreams' {Text
logGroupName :: Text
$sel:logGroupName:DescribeLogStreams' :: DescribeLogStreams -> Text
logGroupName} -> Text
logGroupName) (\s :: DescribeLogStreams
s@DescribeLogStreams' {} Text
a -> DescribeLogStreams
s {$sel:logGroupName:DescribeLogStreams' :: Text
logGroupName = Text
a} :: DescribeLogStreams)

instance Core.AWSPager DescribeLogStreams where
  page :: DescribeLogStreams
-> AWSResponse DescribeLogStreams -> Maybe DescribeLogStreams
page DescribeLogStreams
rq AWSResponse DescribeLogStreams
rs
    | forall a. AWSTruncated a => a -> Bool
Core.stop
        ( AWSResponse DescribeLogStreams
rs
            forall s a. s -> Getting (First a) s a -> Maybe a
Lens.^? Lens' DescribeLogStreamsResponse (Maybe Text)
describeLogStreamsResponse_nextToken
            forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall a b. Prism (Maybe a) (Maybe b) a b
Lens._Just
        ) =
        forall a. Maybe a
Prelude.Nothing
    | forall a. AWSTruncated a => a -> Bool
Core.stop
        ( AWSResponse DescribeLogStreams
rs
            forall s a. s -> Getting (First a) s a -> Maybe a
Lens.^? Lens' DescribeLogStreamsResponse (Maybe [LogStream])
describeLogStreamsResponse_logStreams
            forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall a b. Prism (Maybe a) (Maybe b) a b
Lens._Just
        ) =
        forall a. Maybe a
Prelude.Nothing
    | Bool
Prelude.otherwise =
        forall a. a -> Maybe a
Prelude.Just
          forall a b. (a -> b) -> a -> b
Prelude.$ DescribeLogStreams
rq
          forall a b. a -> (a -> b) -> b
Prelude.& Lens' DescribeLogStreams (Maybe Text)
describeLogStreams_nextToken
          forall s t a b. ASetter s t a b -> b -> s -> t
Lens..~ AWSResponse DescribeLogStreams
rs
          forall s a. s -> Getting (First a) s a -> Maybe a
Lens.^? Lens' DescribeLogStreamsResponse (Maybe Text)
describeLogStreamsResponse_nextToken
          forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall a b. Prism (Maybe a) (Maybe b) a b
Lens._Just

instance Core.AWSRequest DescribeLogStreams where
  type
    AWSResponse DescribeLogStreams =
      DescribeLogStreamsResponse
  request :: (Service -> Service)
-> DescribeLogStreams -> Request DescribeLogStreams
request Service -> Service
overrides =
    forall a. (ToRequest a, ToJSON a) => Service -> a -> Request a
Request.postJSON (Service -> Service
overrides Service
defaultService)
  response :: forall (m :: * -> *).
MonadResource m =>
(ByteStringLazy -> IO ByteStringLazy)
-> Service
-> Proxy DescribeLogStreams
-> ClientResponse ClientBody
-> m (Either
        Error (ClientResponse (AWSResponse DescribeLogStreams)))
response =
    forall (m :: * -> *) a.
MonadResource m =>
(Int -> ResponseHeaders -> Object -> Either String (AWSResponse a))
-> (ByteStringLazy -> IO ByteStringLazy)
-> Service
-> Proxy a
-> ClientResponse ClientBody
-> m (Either Error (ClientResponse (AWSResponse a)))
Response.receiveJSON
      ( \Int
s ResponseHeaders
h Object
x ->
          Maybe [LogStream]
-> Maybe Text -> Int -> DescribeLogStreamsResponse
DescribeLogStreamsResponse'
            forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> (Object
x forall a. FromJSON a => Object -> Key -> Either String (Maybe a)
Data..?> Key
"logStreams" forall (f :: * -> *) a. Functor f => f (Maybe a) -> a -> f a
Core..!@ forall a. Monoid a => a
Prelude.mempty)
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Either String (Maybe a)
Data..?> Key
"nextToken")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (forall (f :: * -> *) a. Applicative f => a -> f a
Prelude.pure (forall a. Enum a => a -> Int
Prelude.fromEnum Int
s))
      )

instance Prelude.Hashable DescribeLogStreams where
  hashWithSalt :: Int -> DescribeLogStreams -> Int
hashWithSalt Int
_salt DescribeLogStreams' {Maybe Bool
Maybe Natural
Maybe Text
Maybe OrderBy
Text
logGroupName :: Text
orderBy :: Maybe OrderBy
nextToken :: Maybe Text
logStreamNamePrefix :: Maybe Text
logGroupIdentifier :: Maybe Text
limit :: Maybe Natural
descending :: Maybe Bool
$sel:logGroupName:DescribeLogStreams' :: DescribeLogStreams -> Text
$sel:orderBy:DescribeLogStreams' :: DescribeLogStreams -> Maybe OrderBy
$sel:nextToken:DescribeLogStreams' :: DescribeLogStreams -> Maybe Text
$sel:logStreamNamePrefix:DescribeLogStreams' :: DescribeLogStreams -> Maybe Text
$sel:logGroupIdentifier:DescribeLogStreams' :: DescribeLogStreams -> Maybe Text
$sel:limit:DescribeLogStreams' :: DescribeLogStreams -> Maybe Natural
$sel:descending:DescribeLogStreams' :: DescribeLogStreams -> Maybe Bool
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Bool
descending
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Natural
limit
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
logGroupIdentifier
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
logStreamNamePrefix
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
nextToken
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe OrderBy
orderBy
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Text
logGroupName

instance Prelude.NFData DescribeLogStreams where
  rnf :: DescribeLogStreams -> ()
rnf DescribeLogStreams' {Maybe Bool
Maybe Natural
Maybe Text
Maybe OrderBy
Text
logGroupName :: Text
orderBy :: Maybe OrderBy
nextToken :: Maybe Text
logStreamNamePrefix :: Maybe Text
logGroupIdentifier :: Maybe Text
limit :: Maybe Natural
descending :: Maybe Bool
$sel:logGroupName:DescribeLogStreams' :: DescribeLogStreams -> Text
$sel:orderBy:DescribeLogStreams' :: DescribeLogStreams -> Maybe OrderBy
$sel:nextToken:DescribeLogStreams' :: DescribeLogStreams -> Maybe Text
$sel:logStreamNamePrefix:DescribeLogStreams' :: DescribeLogStreams -> Maybe Text
$sel:logGroupIdentifier:DescribeLogStreams' :: DescribeLogStreams -> Maybe Text
$sel:limit:DescribeLogStreams' :: DescribeLogStreams -> Maybe Natural
$sel:descending:DescribeLogStreams' :: DescribeLogStreams -> Maybe Bool
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe Bool
descending
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Natural
limit
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
logGroupIdentifier
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
logStreamNamePrefix
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
nextToken
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe OrderBy
orderBy
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Text
logGroupName

instance Data.ToHeaders DescribeLogStreams where
  toHeaders :: DescribeLogStreams -> ResponseHeaders
toHeaders =
    forall a b. a -> b -> a
Prelude.const
      ( forall a. Monoid a => [a] -> a
Prelude.mconcat
          [ HeaderName
"X-Amz-Target"
              forall a. ToHeader a => HeaderName -> a -> ResponseHeaders
Data.=# ( ByteString
"Logs_20140328.DescribeLogStreams" ::
                          Prelude.ByteString
                      ),
            HeaderName
"Content-Type"
              forall a. ToHeader a => HeaderName -> a -> ResponseHeaders
Data.=# ( ByteString
"application/x-amz-json-1.1" ::
                          Prelude.ByteString
                      )
          ]
      )

instance Data.ToJSON DescribeLogStreams where
  toJSON :: DescribeLogStreams -> Value
toJSON DescribeLogStreams' {Maybe Bool
Maybe Natural
Maybe Text
Maybe OrderBy
Text
logGroupName :: Text
orderBy :: Maybe OrderBy
nextToken :: Maybe Text
logStreamNamePrefix :: Maybe Text
logGroupIdentifier :: Maybe Text
limit :: Maybe Natural
descending :: Maybe Bool
$sel:logGroupName:DescribeLogStreams' :: DescribeLogStreams -> Text
$sel:orderBy:DescribeLogStreams' :: DescribeLogStreams -> Maybe OrderBy
$sel:nextToken:DescribeLogStreams' :: DescribeLogStreams -> Maybe Text
$sel:logStreamNamePrefix:DescribeLogStreams' :: DescribeLogStreams -> Maybe Text
$sel:logGroupIdentifier:DescribeLogStreams' :: DescribeLogStreams -> Maybe Text
$sel:limit:DescribeLogStreams' :: DescribeLogStreams -> Maybe Natural
$sel:descending:DescribeLogStreams' :: DescribeLogStreams -> Maybe Bool
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ (Key
"descending" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=) forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe Bool
descending,
            (Key
"limit" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=) forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe Natural
limit,
            (Key
"logGroupIdentifier" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=)
              forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe Text
logGroupIdentifier,
            (Key
"logStreamNamePrefix" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=)
              forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe Text
logStreamNamePrefix,
            (Key
"nextToken" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=) forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe Text
nextToken,
            (Key
"orderBy" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=) forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe OrderBy
orderBy,
            forall a. a -> Maybe a
Prelude.Just (Key
"logGroupName" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= Text
logGroupName)
          ]
      )

instance Data.ToPath DescribeLogStreams where
  toPath :: DescribeLogStreams -> ByteString
toPath = forall a b. a -> b -> a
Prelude.const ByteString
"/"

instance Data.ToQuery DescribeLogStreams where
  toQuery :: DescribeLogStreams -> QueryString
toQuery = forall a b. a -> b -> a
Prelude.const forall a. Monoid a => a
Prelude.mempty

-- | /See:/ 'newDescribeLogStreamsResponse' smart constructor.
data DescribeLogStreamsResponse = DescribeLogStreamsResponse'
  { -- | The log streams.
    DescribeLogStreamsResponse -> Maybe [LogStream]
logStreams :: Prelude.Maybe [LogStream],
    DescribeLogStreamsResponse -> Maybe Text
nextToken :: Prelude.Maybe Prelude.Text,
    -- | The response's http status code.
    DescribeLogStreamsResponse -> Int
httpStatus :: Prelude.Int
  }
  deriving (DescribeLogStreamsResponse -> DescribeLogStreamsResponse -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: DescribeLogStreamsResponse -> DescribeLogStreamsResponse -> Bool
$c/= :: DescribeLogStreamsResponse -> DescribeLogStreamsResponse -> Bool
== :: DescribeLogStreamsResponse -> DescribeLogStreamsResponse -> Bool
$c== :: DescribeLogStreamsResponse -> DescribeLogStreamsResponse -> Bool
Prelude.Eq, ReadPrec [DescribeLogStreamsResponse]
ReadPrec DescribeLogStreamsResponse
Int -> ReadS DescribeLogStreamsResponse
ReadS [DescribeLogStreamsResponse]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [DescribeLogStreamsResponse]
$creadListPrec :: ReadPrec [DescribeLogStreamsResponse]
readPrec :: ReadPrec DescribeLogStreamsResponse
$creadPrec :: ReadPrec DescribeLogStreamsResponse
readList :: ReadS [DescribeLogStreamsResponse]
$creadList :: ReadS [DescribeLogStreamsResponse]
readsPrec :: Int -> ReadS DescribeLogStreamsResponse
$creadsPrec :: Int -> ReadS DescribeLogStreamsResponse
Prelude.Read, Int -> DescribeLogStreamsResponse -> ShowS
[DescribeLogStreamsResponse] -> ShowS
DescribeLogStreamsResponse -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [DescribeLogStreamsResponse] -> ShowS
$cshowList :: [DescribeLogStreamsResponse] -> ShowS
show :: DescribeLogStreamsResponse -> String
$cshow :: DescribeLogStreamsResponse -> String
showsPrec :: Int -> DescribeLogStreamsResponse -> ShowS
$cshowsPrec :: Int -> DescribeLogStreamsResponse -> ShowS
Prelude.Show, forall x.
Rep DescribeLogStreamsResponse x -> DescribeLogStreamsResponse
forall x.
DescribeLogStreamsResponse -> Rep DescribeLogStreamsResponse x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x.
Rep DescribeLogStreamsResponse x -> DescribeLogStreamsResponse
$cfrom :: forall x.
DescribeLogStreamsResponse -> Rep DescribeLogStreamsResponse x
Prelude.Generic)

-- |
-- Create a value of 'DescribeLogStreamsResponse' with all optional fields omitted.
--
-- Use <https://hackage.haskell.org/package/generic-lens generic-lens> or <https://hackage.haskell.org/package/optics optics> to modify other optional fields.
--
-- The following record fields are available, with the corresponding lenses provided
-- for backwards compatibility:
--
-- 'logStreams', 'describeLogStreamsResponse_logStreams' - The log streams.
--
-- 'nextToken', 'describeLogStreamsResponse_nextToken' - Undocumented member.
--
-- 'httpStatus', 'describeLogStreamsResponse_httpStatus' - The response's http status code.
newDescribeLogStreamsResponse ::
  -- | 'httpStatus'
  Prelude.Int ->
  DescribeLogStreamsResponse
newDescribeLogStreamsResponse :: Int -> DescribeLogStreamsResponse
newDescribeLogStreamsResponse Int
pHttpStatus_ =
  DescribeLogStreamsResponse'
    { $sel:logStreams:DescribeLogStreamsResponse' :: Maybe [LogStream]
logStreams =
        forall a. Maybe a
Prelude.Nothing,
      $sel:nextToken:DescribeLogStreamsResponse' :: Maybe Text
nextToken = forall a. Maybe a
Prelude.Nothing,
      $sel:httpStatus:DescribeLogStreamsResponse' :: Int
httpStatus = Int
pHttpStatus_
    }

-- | The log streams.
describeLogStreamsResponse_logStreams :: Lens.Lens' DescribeLogStreamsResponse (Prelude.Maybe [LogStream])
describeLogStreamsResponse_logStreams :: Lens' DescribeLogStreamsResponse (Maybe [LogStream])
describeLogStreamsResponse_logStreams = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeLogStreamsResponse' {Maybe [LogStream]
logStreams :: Maybe [LogStream]
$sel:logStreams:DescribeLogStreamsResponse' :: DescribeLogStreamsResponse -> Maybe [LogStream]
logStreams} -> Maybe [LogStream]
logStreams) (\s :: DescribeLogStreamsResponse
s@DescribeLogStreamsResponse' {} Maybe [LogStream]
a -> DescribeLogStreamsResponse
s {$sel:logStreams:DescribeLogStreamsResponse' :: Maybe [LogStream]
logStreams = Maybe [LogStream]
a} :: DescribeLogStreamsResponse) forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall (f :: * -> *) (g :: * -> *) s t a b.
(Functor f, Functor g) =>
AnIso s t a b -> Iso (f s) (g t) (f a) (g b)
Lens.mapping forall s t a b. (Coercible s a, Coercible t b) => Iso s t a b
Lens.coerced

-- | Undocumented member.
describeLogStreamsResponse_nextToken :: Lens.Lens' DescribeLogStreamsResponse (Prelude.Maybe Prelude.Text)
describeLogStreamsResponse_nextToken :: Lens' DescribeLogStreamsResponse (Maybe Text)
describeLogStreamsResponse_nextToken = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeLogStreamsResponse' {Maybe Text
nextToken :: Maybe Text
$sel:nextToken:DescribeLogStreamsResponse' :: DescribeLogStreamsResponse -> Maybe Text
nextToken} -> Maybe Text
nextToken) (\s :: DescribeLogStreamsResponse
s@DescribeLogStreamsResponse' {} Maybe Text
a -> DescribeLogStreamsResponse
s {$sel:nextToken:DescribeLogStreamsResponse' :: Maybe Text
nextToken = Maybe Text
a} :: DescribeLogStreamsResponse)

-- | The response's http status code.
describeLogStreamsResponse_httpStatus :: Lens.Lens' DescribeLogStreamsResponse Prelude.Int
describeLogStreamsResponse_httpStatus :: Lens' DescribeLogStreamsResponse Int
describeLogStreamsResponse_httpStatus = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeLogStreamsResponse' {Int
httpStatus :: Int
$sel:httpStatus:DescribeLogStreamsResponse' :: DescribeLogStreamsResponse -> Int
httpStatus} -> Int
httpStatus) (\s :: DescribeLogStreamsResponse
s@DescribeLogStreamsResponse' {} Int
a -> DescribeLogStreamsResponse
s {$sel:httpStatus:DescribeLogStreamsResponse' :: Int
httpStatus = Int
a} :: DescribeLogStreamsResponse)

instance Prelude.NFData DescribeLogStreamsResponse where
  rnf :: DescribeLogStreamsResponse -> ()
rnf DescribeLogStreamsResponse' {Int
Maybe [LogStream]
Maybe Text
httpStatus :: Int
nextToken :: Maybe Text
logStreams :: Maybe [LogStream]
$sel:httpStatus:DescribeLogStreamsResponse' :: DescribeLogStreamsResponse -> Int
$sel:nextToken:DescribeLogStreamsResponse' :: DescribeLogStreamsResponse -> Maybe Text
$sel:logStreams:DescribeLogStreamsResponse' :: DescribeLogStreamsResponse -> Maybe [LogStream]
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe [LogStream]
logStreams
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
nextToken
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Int
httpStatus