{-# 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.SMS.ListApps
-- Copyright   : (c) 2013-2023 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
--
-- Retrieves summaries for all applications.
--
-- This operation returns paginated results.
module Amazonka.SMS.ListApps
  ( -- * Creating a Request
    ListApps (..),
    newListApps,

    -- * Request Lenses
    listApps_appIds,
    listApps_maxResults,
    listApps_nextToken,

    -- * Destructuring the Response
    ListAppsResponse (..),
    newListAppsResponse,

    -- * Response Lenses
    listAppsResponse_apps,
    listAppsResponse_nextToken,
    listAppsResponse_httpStatus,
  )
where

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
import Amazonka.SMS.Types

-- | /See:/ 'newListApps' smart constructor.
data ListApps = ListApps'
  { -- | The unique application IDs.
    ListApps -> Maybe [Text]
appIds :: Prelude.Maybe [Prelude.Text],
    -- | The maximum number of results to return in a single call. The default
    -- value is 100. To retrieve the remaining results, make another call with
    -- the returned @NextToken@ value.
    ListApps -> Maybe Int
maxResults :: Prelude.Maybe Prelude.Int,
    -- | The token for the next set of results.
    ListApps -> Maybe Text
nextToken :: Prelude.Maybe Prelude.Text
  }
  deriving (ListApps -> ListApps -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: ListApps -> ListApps -> Bool
$c/= :: ListApps -> ListApps -> Bool
== :: ListApps -> ListApps -> Bool
$c== :: ListApps -> ListApps -> Bool
Prelude.Eq, ReadPrec [ListApps]
ReadPrec ListApps
Int -> ReadS ListApps
ReadS [ListApps]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [ListApps]
$creadListPrec :: ReadPrec [ListApps]
readPrec :: ReadPrec ListApps
$creadPrec :: ReadPrec ListApps
readList :: ReadS [ListApps]
$creadList :: ReadS [ListApps]
readsPrec :: Int -> ReadS ListApps
$creadsPrec :: Int -> ReadS ListApps
Prelude.Read, Int -> ListApps -> ShowS
[ListApps] -> ShowS
ListApps -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [ListApps] -> ShowS
$cshowList :: [ListApps] -> ShowS
show :: ListApps -> String
$cshow :: ListApps -> String
showsPrec :: Int -> ListApps -> ShowS
$cshowsPrec :: Int -> ListApps -> ShowS
Prelude.Show, forall x. Rep ListApps x -> ListApps
forall x. ListApps -> Rep ListApps x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep ListApps x -> ListApps
$cfrom :: forall x. ListApps -> Rep ListApps x
Prelude.Generic)

-- |
-- Create a value of 'ListApps' 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:
--
-- 'appIds', 'listApps_appIds' - The unique application IDs.
--
-- 'maxResults', 'listApps_maxResults' - The maximum number of results to return in a single call. The default
-- value is 100. To retrieve the remaining results, make another call with
-- the returned @NextToken@ value.
--
-- 'nextToken', 'listApps_nextToken' - The token for the next set of results.
newListApps ::
  ListApps
newListApps :: ListApps
newListApps =
  ListApps'
    { $sel:appIds:ListApps' :: Maybe [Text]
appIds = forall a. Maybe a
Prelude.Nothing,
      $sel:maxResults:ListApps' :: Maybe Int
maxResults = forall a. Maybe a
Prelude.Nothing,
      $sel:nextToken:ListApps' :: Maybe Text
nextToken = forall a. Maybe a
Prelude.Nothing
    }

-- | The unique application IDs.
listApps_appIds :: Lens.Lens' ListApps (Prelude.Maybe [Prelude.Text])
listApps_appIds :: Lens' ListApps (Maybe [Text])
listApps_appIds = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListApps' {Maybe [Text]
appIds :: Maybe [Text]
$sel:appIds:ListApps' :: ListApps -> Maybe [Text]
appIds} -> Maybe [Text]
appIds) (\s :: ListApps
s@ListApps' {} Maybe [Text]
a -> ListApps
s {$sel:appIds:ListApps' :: Maybe [Text]
appIds = Maybe [Text]
a} :: ListApps) 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

-- | The maximum number of results to return in a single call. The default
-- value is 100. To retrieve the remaining results, make another call with
-- the returned @NextToken@ value.
listApps_maxResults :: Lens.Lens' ListApps (Prelude.Maybe Prelude.Int)
listApps_maxResults :: Lens' ListApps (Maybe Int)
listApps_maxResults = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListApps' {Maybe Int
maxResults :: Maybe Int
$sel:maxResults:ListApps' :: ListApps -> Maybe Int
maxResults} -> Maybe Int
maxResults) (\s :: ListApps
s@ListApps' {} Maybe Int
a -> ListApps
s {$sel:maxResults:ListApps' :: Maybe Int
maxResults = Maybe Int
a} :: ListApps)

-- | The token for the next set of results.
listApps_nextToken :: Lens.Lens' ListApps (Prelude.Maybe Prelude.Text)
listApps_nextToken :: Lens' ListApps (Maybe Text)
listApps_nextToken = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListApps' {Maybe Text
nextToken :: Maybe Text
$sel:nextToken:ListApps' :: ListApps -> Maybe Text
nextToken} -> Maybe Text
nextToken) (\s :: ListApps
s@ListApps' {} Maybe Text
a -> ListApps
s {$sel:nextToken:ListApps' :: Maybe Text
nextToken = Maybe Text
a} :: ListApps)

instance Core.AWSPager ListApps where
  page :: ListApps -> AWSResponse ListApps -> Maybe ListApps
page ListApps
rq AWSResponse ListApps
rs
    | forall a. AWSTruncated a => a -> Bool
Core.stop
        ( AWSResponse ListApps
rs
            forall s a. s -> Getting (First a) s a -> Maybe a
Lens.^? Lens' ListAppsResponse (Maybe Text)
listAppsResponse_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 ListApps
rs
            forall s a. s -> Getting (First a) s a -> Maybe a
Lens.^? Lens' ListAppsResponse (Maybe [AppSummary])
listAppsResponse_apps
            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.$ ListApps
rq
          forall a b. a -> (a -> b) -> b
Prelude.& Lens' ListApps (Maybe Text)
listApps_nextToken
          forall s t a b. ASetter s t a b -> b -> s -> t
Lens..~ AWSResponse ListApps
rs
          forall s a. s -> Getting (First a) s a -> Maybe a
Lens.^? Lens' ListAppsResponse (Maybe Text)
listAppsResponse_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 ListApps where
  type AWSResponse ListApps = ListAppsResponse
  request :: (Service -> Service) -> ListApps -> Request ListApps
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 ListApps
-> ClientResponse ClientBody
-> m (Either Error (ClientResponse (AWSResponse ListApps)))
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 [AppSummary] -> Maybe Text -> Int -> ListAppsResponse
ListAppsResponse'
            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
"apps" 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 ListApps where
  hashWithSalt :: Int -> ListApps -> Int
hashWithSalt Int
_salt ListApps' {Maybe Int
Maybe [Text]
Maybe Text
nextToken :: Maybe Text
maxResults :: Maybe Int
appIds :: Maybe [Text]
$sel:nextToken:ListApps' :: ListApps -> Maybe Text
$sel:maxResults:ListApps' :: ListApps -> Maybe Int
$sel:appIds:ListApps' :: ListApps -> Maybe [Text]
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe [Text]
appIds
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Int
maxResults
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
nextToken

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

instance Data.ToHeaders ListApps where
  toHeaders :: ListApps -> 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
"AWSServerMigrationService_V2016_10_24.ListApps" ::
                          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 ListApps where
  toJSON :: ListApps -> Value
toJSON ListApps' {Maybe Int
Maybe [Text]
Maybe Text
nextToken :: Maybe Text
maxResults :: Maybe Int
appIds :: Maybe [Text]
$sel:nextToken:ListApps' :: ListApps -> Maybe Text
$sel:maxResults:ListApps' :: ListApps -> Maybe Int
$sel:appIds:ListApps' :: ListApps -> Maybe [Text]
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ (Key
"appIds" 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]
appIds,
            (Key
"maxResults" 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 Int
maxResults,
            (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 ListApps where
  toPath :: ListApps -> ByteString
toPath = forall a b. a -> b -> a
Prelude.const ByteString
"/"

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

-- | /See:/ 'newListAppsResponse' smart constructor.
data ListAppsResponse = ListAppsResponse'
  { -- | The application summaries.
    ListAppsResponse -> Maybe [AppSummary]
apps :: Prelude.Maybe [AppSummary],
    -- | The token required to retrieve the next set of results. This value is
    -- null when there are no more results to return.
    ListAppsResponse -> Maybe Text
nextToken :: Prelude.Maybe Prelude.Text,
    -- | The response's http status code.
    ListAppsResponse -> Int
httpStatus :: Prelude.Int
  }
  deriving (ListAppsResponse -> ListAppsResponse -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: ListAppsResponse -> ListAppsResponse -> Bool
$c/= :: ListAppsResponse -> ListAppsResponse -> Bool
== :: ListAppsResponse -> ListAppsResponse -> Bool
$c== :: ListAppsResponse -> ListAppsResponse -> Bool
Prelude.Eq, ReadPrec [ListAppsResponse]
ReadPrec ListAppsResponse
Int -> ReadS ListAppsResponse
ReadS [ListAppsResponse]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [ListAppsResponse]
$creadListPrec :: ReadPrec [ListAppsResponse]
readPrec :: ReadPrec ListAppsResponse
$creadPrec :: ReadPrec ListAppsResponse
readList :: ReadS [ListAppsResponse]
$creadList :: ReadS [ListAppsResponse]
readsPrec :: Int -> ReadS ListAppsResponse
$creadsPrec :: Int -> ReadS ListAppsResponse
Prelude.Read, Int -> ListAppsResponse -> ShowS
[ListAppsResponse] -> ShowS
ListAppsResponse -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [ListAppsResponse] -> ShowS
$cshowList :: [ListAppsResponse] -> ShowS
show :: ListAppsResponse -> String
$cshow :: ListAppsResponse -> String
showsPrec :: Int -> ListAppsResponse -> ShowS
$cshowsPrec :: Int -> ListAppsResponse -> ShowS
Prelude.Show, forall x. Rep ListAppsResponse x -> ListAppsResponse
forall x. ListAppsResponse -> Rep ListAppsResponse x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep ListAppsResponse x -> ListAppsResponse
$cfrom :: forall x. ListAppsResponse -> Rep ListAppsResponse x
Prelude.Generic)

-- |
-- Create a value of 'ListAppsResponse' 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:
--
-- 'apps', 'listAppsResponse_apps' - The application summaries.
--
-- 'nextToken', 'listAppsResponse_nextToken' - The token required to retrieve the next set of results. This value is
-- null when there are no more results to return.
--
-- 'httpStatus', 'listAppsResponse_httpStatus' - The response's http status code.
newListAppsResponse ::
  -- | 'httpStatus'
  Prelude.Int ->
  ListAppsResponse
newListAppsResponse :: Int -> ListAppsResponse
newListAppsResponse Int
pHttpStatus_ =
  ListAppsResponse'
    { $sel:apps:ListAppsResponse' :: Maybe [AppSummary]
apps = forall a. Maybe a
Prelude.Nothing,
      $sel:nextToken:ListAppsResponse' :: Maybe Text
nextToken = forall a. Maybe a
Prelude.Nothing,
      $sel:httpStatus:ListAppsResponse' :: Int
httpStatus = Int
pHttpStatus_
    }

-- | The application summaries.
listAppsResponse_apps :: Lens.Lens' ListAppsResponse (Prelude.Maybe [AppSummary])
listAppsResponse_apps :: Lens' ListAppsResponse (Maybe [AppSummary])
listAppsResponse_apps = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListAppsResponse' {Maybe [AppSummary]
apps :: Maybe [AppSummary]
$sel:apps:ListAppsResponse' :: ListAppsResponse -> Maybe [AppSummary]
apps} -> Maybe [AppSummary]
apps) (\s :: ListAppsResponse
s@ListAppsResponse' {} Maybe [AppSummary]
a -> ListAppsResponse
s {$sel:apps:ListAppsResponse' :: Maybe [AppSummary]
apps = Maybe [AppSummary]
a} :: ListAppsResponse) 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

-- | The token required to retrieve the next set of results. This value is
-- null when there are no more results to return.
listAppsResponse_nextToken :: Lens.Lens' ListAppsResponse (Prelude.Maybe Prelude.Text)
listAppsResponse_nextToken :: Lens' ListAppsResponse (Maybe Text)
listAppsResponse_nextToken = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListAppsResponse' {Maybe Text
nextToken :: Maybe Text
$sel:nextToken:ListAppsResponse' :: ListAppsResponse -> Maybe Text
nextToken} -> Maybe Text
nextToken) (\s :: ListAppsResponse
s@ListAppsResponse' {} Maybe Text
a -> ListAppsResponse
s {$sel:nextToken:ListAppsResponse' :: Maybe Text
nextToken = Maybe Text
a} :: ListAppsResponse)

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

instance Prelude.NFData ListAppsResponse where
  rnf :: ListAppsResponse -> ()
rnf ListAppsResponse' {Int
Maybe [AppSummary]
Maybe Text
httpStatus :: Int
nextToken :: Maybe Text
apps :: Maybe [AppSummary]
$sel:httpStatus:ListAppsResponse' :: ListAppsResponse -> Int
$sel:nextToken:ListAppsResponse' :: ListAppsResponse -> Maybe Text
$sel:apps:ListAppsResponse' :: ListAppsResponse -> Maybe [AppSummary]
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe [AppSummary]
apps
      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