{-# 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.KinesisAnalyticsV2.ListApplications
-- Copyright   : (c) 2013-2023 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
--
-- Returns a list of Kinesis Data Analytics applications in your account.
-- For each application, the response includes the application name, Amazon
-- Resource Name (ARN), and status.
--
-- If you want detailed information about a specific application, use
-- DescribeApplication.
--
-- This operation returns paginated results.
module Amazonka.KinesisAnalyticsV2.ListApplications
  ( -- * Creating a Request
    ListApplications (..),
    newListApplications,

    -- * Request Lenses
    listApplications_limit,
    listApplications_nextToken,

    -- * Destructuring the Response
    ListApplicationsResponse (..),
    newListApplicationsResponse,

    -- * Response Lenses
    listApplicationsResponse_nextToken,
    listApplicationsResponse_httpStatus,
    listApplicationsResponse_applicationSummaries,
  )
where

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

-- | /See:/ 'newListApplications' smart constructor.
data ListApplications = ListApplications'
  { -- | The maximum number of applications to list.
    ListApplications -> Maybe Natural
limit :: Prelude.Maybe Prelude.Natural,
    -- | If a previous command returned a pagination token, pass it into this
    -- value to retrieve the next set of results. For more information about
    -- pagination, see
    -- <https://docs.aws.amazon.com/cli/latest/userguide/pagination.html Using the Amazon Command Line Interface\'s Pagination Options>.
    ListApplications -> Maybe Text
nextToken :: Prelude.Maybe Prelude.Text
  }
  deriving (ListApplications -> ListApplications -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: ListApplications -> ListApplications -> Bool
$c/= :: ListApplications -> ListApplications -> Bool
== :: ListApplications -> ListApplications -> Bool
$c== :: ListApplications -> ListApplications -> Bool
Prelude.Eq, ReadPrec [ListApplications]
ReadPrec ListApplications
Int -> ReadS ListApplications
ReadS [ListApplications]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [ListApplications]
$creadListPrec :: ReadPrec [ListApplications]
readPrec :: ReadPrec ListApplications
$creadPrec :: ReadPrec ListApplications
readList :: ReadS [ListApplications]
$creadList :: ReadS [ListApplications]
readsPrec :: Int -> ReadS ListApplications
$creadsPrec :: Int -> ReadS ListApplications
Prelude.Read, Int -> ListApplications -> ShowS
[ListApplications] -> ShowS
ListApplications -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [ListApplications] -> ShowS
$cshowList :: [ListApplications] -> ShowS
show :: ListApplications -> String
$cshow :: ListApplications -> String
showsPrec :: Int -> ListApplications -> ShowS
$cshowsPrec :: Int -> ListApplications -> ShowS
Prelude.Show, forall x. Rep ListApplications x -> ListApplications
forall x. ListApplications -> Rep ListApplications x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep ListApplications x -> ListApplications
$cfrom :: forall x. ListApplications -> Rep ListApplications x
Prelude.Generic)

-- |
-- Create a value of 'ListApplications' 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:
--
-- 'limit', 'listApplications_limit' - The maximum number of applications to list.
--
-- 'nextToken', 'listApplications_nextToken' - If a previous command returned a pagination token, pass it into this
-- value to retrieve the next set of results. For more information about
-- pagination, see
-- <https://docs.aws.amazon.com/cli/latest/userguide/pagination.html Using the Amazon Command Line Interface\'s Pagination Options>.
newListApplications ::
  ListApplications
newListApplications :: ListApplications
newListApplications =
  ListApplications'
    { $sel:limit:ListApplications' :: Maybe Natural
limit = forall a. Maybe a
Prelude.Nothing,
      $sel:nextToken:ListApplications' :: Maybe Text
nextToken = forall a. Maybe a
Prelude.Nothing
    }

-- | The maximum number of applications to list.
listApplications_limit :: Lens.Lens' ListApplications (Prelude.Maybe Prelude.Natural)
listApplications_limit :: Lens' ListApplications (Maybe Natural)
listApplications_limit = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListApplications' {Maybe Natural
limit :: Maybe Natural
$sel:limit:ListApplications' :: ListApplications -> Maybe Natural
limit} -> Maybe Natural
limit) (\s :: ListApplications
s@ListApplications' {} Maybe Natural
a -> ListApplications
s {$sel:limit:ListApplications' :: Maybe Natural
limit = Maybe Natural
a} :: ListApplications)

-- | If a previous command returned a pagination token, pass it into this
-- value to retrieve the next set of results. For more information about
-- pagination, see
-- <https://docs.aws.amazon.com/cli/latest/userguide/pagination.html Using the Amazon Command Line Interface\'s Pagination Options>.
listApplications_nextToken :: Lens.Lens' ListApplications (Prelude.Maybe Prelude.Text)
listApplications_nextToken :: Lens' ListApplications (Maybe Text)
listApplications_nextToken = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListApplications' {Maybe Text
nextToken :: Maybe Text
$sel:nextToken:ListApplications' :: ListApplications -> Maybe Text
nextToken} -> Maybe Text
nextToken) (\s :: ListApplications
s@ListApplications' {} Maybe Text
a -> ListApplications
s {$sel:nextToken:ListApplications' :: Maybe Text
nextToken = Maybe Text
a} :: ListApplications)

instance Core.AWSPager ListApplications where
  page :: ListApplications
-> AWSResponse ListApplications -> Maybe ListApplications
page ListApplications
rq AWSResponse ListApplications
rs
    | forall a. AWSTruncated a => a -> Bool
Core.stop
        ( AWSResponse ListApplications
rs
            forall s a. s -> Getting (First a) s a -> Maybe a
Lens.^? Lens' ListApplicationsResponse (Maybe Text)
listApplicationsResponse_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 ListApplications
rs
            forall s a. s -> Getting a s a -> a
Lens.^. Lens' ListApplicationsResponse [ApplicationSummary]
listApplicationsResponse_applicationSummaries
        ) =
        forall a. Maybe a
Prelude.Nothing
    | Bool
Prelude.otherwise =
        forall a. a -> Maybe a
Prelude.Just
          forall a b. (a -> b) -> a -> b
Prelude.$ ListApplications
rq
          forall a b. a -> (a -> b) -> b
Prelude.& Lens' ListApplications (Maybe Text)
listApplications_nextToken
          forall s t a b. ASetter s t a b -> b -> s -> t
Lens..~ AWSResponse ListApplications
rs
          forall s a. s -> Getting (First a) s a -> Maybe a
Lens.^? Lens' ListApplicationsResponse (Maybe Text)
listApplicationsResponse_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 ListApplications where
  type
    AWSResponse ListApplications =
      ListApplicationsResponse
  request :: (Service -> Service)
-> ListApplications -> Request ListApplications
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 ListApplications
-> ClientResponse ClientBody
-> m (Either Error (ClientResponse (AWSResponse ListApplications)))
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 Text
-> Int -> [ApplicationSummary] -> ListApplicationsResponse
ListApplicationsResponse'
            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
"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))
            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
"ApplicationSummaries"
                            forall (f :: * -> *) a. Functor f => f (Maybe a) -> a -> f a
Core..!@ forall a. Monoid a => a
Prelude.mempty
                        )
      )

instance Prelude.Hashable ListApplications where
  hashWithSalt :: Int -> ListApplications -> Int
hashWithSalt Int
_salt ListApplications' {Maybe Natural
Maybe Text
nextToken :: Maybe Text
limit :: Maybe Natural
$sel:nextToken:ListApplications' :: ListApplications -> Maybe Text
$sel:limit:ListApplications' :: ListApplications -> Maybe Natural
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Natural
limit
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
nextToken

instance Prelude.NFData ListApplications where
  rnf :: ListApplications -> ()
rnf ListApplications' {Maybe Natural
Maybe Text
nextToken :: Maybe Text
limit :: Maybe Natural
$sel:nextToken:ListApplications' :: ListApplications -> Maybe Text
$sel:limit:ListApplications' :: ListApplications -> Maybe Natural
..} =
    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
nextToken

instance Data.ToHeaders ListApplications where
  toHeaders :: ListApplications -> 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
"KinesisAnalytics_20180523.ListApplications" ::
                          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 ListApplications where
  toJSON :: ListApplications -> Value
toJSON ListApplications' {Maybe Natural
Maybe Text
nextToken :: Maybe Text
limit :: Maybe Natural
$sel:nextToken:ListApplications' :: ListApplications -> Maybe Text
$sel:limit:ListApplications' :: ListApplications -> Maybe Natural
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ (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
"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
          ]
      )

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

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

-- | /See:/ 'newListApplicationsResponse' smart constructor.
data ListApplicationsResponse = ListApplicationsResponse'
  { -- | The pagination token for the next set of results, or @null@ if there are
    -- no additional results. Pass this token into a subsequent command to
    -- retrieve the next set of items For more information about pagination,
    -- see
    -- <https://docs.aws.amazon.com/cli/latest/userguide/pagination.html Using the Amazon Command Line Interface\'s Pagination Options>.
    ListApplicationsResponse -> Maybe Text
nextToken :: Prelude.Maybe Prelude.Text,
    -- | The response's http status code.
    ListApplicationsResponse -> Int
httpStatus :: Prelude.Int,
    -- | A list of @ApplicationSummary@ objects.
    ListApplicationsResponse -> [ApplicationSummary]
applicationSummaries :: [ApplicationSummary]
  }
  deriving (ListApplicationsResponse -> ListApplicationsResponse -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: ListApplicationsResponse -> ListApplicationsResponse -> Bool
$c/= :: ListApplicationsResponse -> ListApplicationsResponse -> Bool
== :: ListApplicationsResponse -> ListApplicationsResponse -> Bool
$c== :: ListApplicationsResponse -> ListApplicationsResponse -> Bool
Prelude.Eq, ReadPrec [ListApplicationsResponse]
ReadPrec ListApplicationsResponse
Int -> ReadS ListApplicationsResponse
ReadS [ListApplicationsResponse]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [ListApplicationsResponse]
$creadListPrec :: ReadPrec [ListApplicationsResponse]
readPrec :: ReadPrec ListApplicationsResponse
$creadPrec :: ReadPrec ListApplicationsResponse
readList :: ReadS [ListApplicationsResponse]
$creadList :: ReadS [ListApplicationsResponse]
readsPrec :: Int -> ReadS ListApplicationsResponse
$creadsPrec :: Int -> ReadS ListApplicationsResponse
Prelude.Read, Int -> ListApplicationsResponse -> ShowS
[ListApplicationsResponse] -> ShowS
ListApplicationsResponse -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [ListApplicationsResponse] -> ShowS
$cshowList :: [ListApplicationsResponse] -> ShowS
show :: ListApplicationsResponse -> String
$cshow :: ListApplicationsResponse -> String
showsPrec :: Int -> ListApplicationsResponse -> ShowS
$cshowsPrec :: Int -> ListApplicationsResponse -> ShowS
Prelude.Show, forall x.
Rep ListApplicationsResponse x -> ListApplicationsResponse
forall x.
ListApplicationsResponse -> Rep ListApplicationsResponse x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x.
Rep ListApplicationsResponse x -> ListApplicationsResponse
$cfrom :: forall x.
ListApplicationsResponse -> Rep ListApplicationsResponse x
Prelude.Generic)

-- |
-- Create a value of 'ListApplicationsResponse' 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:
--
-- 'nextToken', 'listApplicationsResponse_nextToken' - The pagination token for the next set of results, or @null@ if there are
-- no additional results. Pass this token into a subsequent command to
-- retrieve the next set of items For more information about pagination,
-- see
-- <https://docs.aws.amazon.com/cli/latest/userguide/pagination.html Using the Amazon Command Line Interface\'s Pagination Options>.
--
-- 'httpStatus', 'listApplicationsResponse_httpStatus' - The response's http status code.
--
-- 'applicationSummaries', 'listApplicationsResponse_applicationSummaries' - A list of @ApplicationSummary@ objects.
newListApplicationsResponse ::
  -- | 'httpStatus'
  Prelude.Int ->
  ListApplicationsResponse
newListApplicationsResponse :: Int -> ListApplicationsResponse
newListApplicationsResponse Int
pHttpStatus_ =
  ListApplicationsResponse'
    { $sel:nextToken:ListApplicationsResponse' :: Maybe Text
nextToken =
        forall a. Maybe a
Prelude.Nothing,
      $sel:httpStatus:ListApplicationsResponse' :: Int
httpStatus = Int
pHttpStatus_,
      $sel:applicationSummaries:ListApplicationsResponse' :: [ApplicationSummary]
applicationSummaries = forall a. Monoid a => a
Prelude.mempty
    }

-- | The pagination token for the next set of results, or @null@ if there are
-- no additional results. Pass this token into a subsequent command to
-- retrieve the next set of items For more information about pagination,
-- see
-- <https://docs.aws.amazon.com/cli/latest/userguide/pagination.html Using the Amazon Command Line Interface\'s Pagination Options>.
listApplicationsResponse_nextToken :: Lens.Lens' ListApplicationsResponse (Prelude.Maybe Prelude.Text)
listApplicationsResponse_nextToken :: Lens' ListApplicationsResponse (Maybe Text)
listApplicationsResponse_nextToken = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListApplicationsResponse' {Maybe Text
nextToken :: Maybe Text
$sel:nextToken:ListApplicationsResponse' :: ListApplicationsResponse -> Maybe Text
nextToken} -> Maybe Text
nextToken) (\s :: ListApplicationsResponse
s@ListApplicationsResponse' {} Maybe Text
a -> ListApplicationsResponse
s {$sel:nextToken:ListApplicationsResponse' :: Maybe Text
nextToken = Maybe Text
a} :: ListApplicationsResponse)

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

-- | A list of @ApplicationSummary@ objects.
listApplicationsResponse_applicationSummaries :: Lens.Lens' ListApplicationsResponse [ApplicationSummary]
listApplicationsResponse_applicationSummaries :: Lens' ListApplicationsResponse [ApplicationSummary]
listApplicationsResponse_applicationSummaries = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListApplicationsResponse' {[ApplicationSummary]
applicationSummaries :: [ApplicationSummary]
$sel:applicationSummaries:ListApplicationsResponse' :: ListApplicationsResponse -> [ApplicationSummary]
applicationSummaries} -> [ApplicationSummary]
applicationSummaries) (\s :: ListApplicationsResponse
s@ListApplicationsResponse' {} [ApplicationSummary]
a -> ListApplicationsResponse
s {$sel:applicationSummaries:ListApplicationsResponse' :: [ApplicationSummary]
applicationSummaries = [ApplicationSummary]
a} :: ListApplicationsResponse) forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall s t a b. (Coercible s a, Coercible t b) => Iso s t a b
Lens.coerced

instance Prelude.NFData ListApplicationsResponse where
  rnf :: ListApplicationsResponse -> ()
rnf ListApplicationsResponse' {Int
[ApplicationSummary]
Maybe Text
applicationSummaries :: [ApplicationSummary]
httpStatus :: Int
nextToken :: Maybe Text
$sel:applicationSummaries:ListApplicationsResponse' :: ListApplicationsResponse -> [ApplicationSummary]
$sel:httpStatus:ListApplicationsResponse' :: ListApplicationsResponse -> Int
$sel:nextToken:ListApplicationsResponse' :: ListApplicationsResponse -> Maybe Text
..} =
    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
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf [ApplicationSummary]
applicationSummaries