{-# 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.Transfer.ListServers
-- 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 file transfer protocol-enabled servers that are associated
-- with your Amazon Web Services account.
--
-- This operation returns paginated results.
module Amazonka.Transfer.ListServers
  ( -- * Creating a Request
    ListServers (..),
    newListServers,

    -- * Request Lenses
    listServers_maxResults,
    listServers_nextToken,

    -- * Destructuring the Response
    ListServersResponse (..),
    newListServersResponse,

    -- * Response Lenses
    listServersResponse_nextToken,
    listServersResponse_httpStatus,
    listServersResponse_servers,
  )
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.Transfer.Types

-- | /See:/ 'newListServers' smart constructor.
data ListServers = ListServers'
  { -- | Specifies the number of servers to return as a response to the
    -- @ListServers@ query.
    ListServers -> Maybe Natural
maxResults :: Prelude.Maybe Prelude.Natural,
    -- | When additional results are obtained from the @ListServers@ command, a
    -- @NextToken@ parameter is returned in the output. You can then pass the
    -- @NextToken@ parameter in a subsequent command to continue listing
    -- additional servers.
    ListServers -> Maybe Text
nextToken :: Prelude.Maybe Prelude.Text
  }
  deriving (ListServers -> ListServers -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: ListServers -> ListServers -> Bool
$c/= :: ListServers -> ListServers -> Bool
== :: ListServers -> ListServers -> Bool
$c== :: ListServers -> ListServers -> Bool
Prelude.Eq, ReadPrec [ListServers]
ReadPrec ListServers
Int -> ReadS ListServers
ReadS [ListServers]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [ListServers]
$creadListPrec :: ReadPrec [ListServers]
readPrec :: ReadPrec ListServers
$creadPrec :: ReadPrec ListServers
readList :: ReadS [ListServers]
$creadList :: ReadS [ListServers]
readsPrec :: Int -> ReadS ListServers
$creadsPrec :: Int -> ReadS ListServers
Prelude.Read, Int -> ListServers -> ShowS
[ListServers] -> ShowS
ListServers -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [ListServers] -> ShowS
$cshowList :: [ListServers] -> ShowS
show :: ListServers -> String
$cshow :: ListServers -> String
showsPrec :: Int -> ListServers -> ShowS
$cshowsPrec :: Int -> ListServers -> ShowS
Prelude.Show, forall x. Rep ListServers x -> ListServers
forall x. ListServers -> Rep ListServers x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep ListServers x -> ListServers
$cfrom :: forall x. ListServers -> Rep ListServers x
Prelude.Generic)

-- |
-- Create a value of 'ListServers' 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:
--
-- 'maxResults', 'listServers_maxResults' - Specifies the number of servers to return as a response to the
-- @ListServers@ query.
--
-- 'nextToken', 'listServers_nextToken' - When additional results are obtained from the @ListServers@ command, a
-- @NextToken@ parameter is returned in the output. You can then pass the
-- @NextToken@ parameter in a subsequent command to continue listing
-- additional servers.
newListServers ::
  ListServers
newListServers :: ListServers
newListServers =
  ListServers'
    { $sel:maxResults:ListServers' :: Maybe Natural
maxResults = forall a. Maybe a
Prelude.Nothing,
      $sel:nextToken:ListServers' :: Maybe Text
nextToken = forall a. Maybe a
Prelude.Nothing
    }

-- | Specifies the number of servers to return as a response to the
-- @ListServers@ query.
listServers_maxResults :: Lens.Lens' ListServers (Prelude.Maybe Prelude.Natural)
listServers_maxResults :: Lens' ListServers (Maybe Natural)
listServers_maxResults = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListServers' {Maybe Natural
maxResults :: Maybe Natural
$sel:maxResults:ListServers' :: ListServers -> Maybe Natural
maxResults} -> Maybe Natural
maxResults) (\s :: ListServers
s@ListServers' {} Maybe Natural
a -> ListServers
s {$sel:maxResults:ListServers' :: Maybe Natural
maxResults = Maybe Natural
a} :: ListServers)

-- | When additional results are obtained from the @ListServers@ command, a
-- @NextToken@ parameter is returned in the output. You can then pass the
-- @NextToken@ parameter in a subsequent command to continue listing
-- additional servers.
listServers_nextToken :: Lens.Lens' ListServers (Prelude.Maybe Prelude.Text)
listServers_nextToken :: Lens' ListServers (Maybe Text)
listServers_nextToken = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListServers' {Maybe Text
nextToken :: Maybe Text
$sel:nextToken:ListServers' :: ListServers -> Maybe Text
nextToken} -> Maybe Text
nextToken) (\s :: ListServers
s@ListServers' {} Maybe Text
a -> ListServers
s {$sel:nextToken:ListServers' :: Maybe Text
nextToken = Maybe Text
a} :: ListServers)

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

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

instance Prelude.NFData ListServers where
  rnf :: ListServers -> ()
rnf ListServers' {Maybe Natural
Maybe Text
nextToken :: Maybe Text
maxResults :: Maybe Natural
$sel:nextToken:ListServers' :: ListServers -> Maybe Text
$sel:maxResults:ListServers' :: ListServers -> Maybe Natural
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe Natural
maxResults
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
nextToken

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

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

-- | /See:/ 'newListServersResponse' smart constructor.
data ListServersResponse = ListServersResponse'
  { -- | When you can get additional results from the @ListServers@ operation, a
    -- @NextToken@ parameter is returned in the output. In a following command,
    -- you can pass in the @NextToken@ parameter to continue listing additional
    -- servers.
    ListServersResponse -> Maybe Text
nextToken :: Prelude.Maybe Prelude.Text,
    -- | The response's http status code.
    ListServersResponse -> Int
httpStatus :: Prelude.Int,
    -- | An array of servers that were listed.
    ListServersResponse -> [ListedServer]
servers :: [ListedServer]
  }
  deriving (ListServersResponse -> ListServersResponse -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: ListServersResponse -> ListServersResponse -> Bool
$c/= :: ListServersResponse -> ListServersResponse -> Bool
== :: ListServersResponse -> ListServersResponse -> Bool
$c== :: ListServersResponse -> ListServersResponse -> Bool
Prelude.Eq, ReadPrec [ListServersResponse]
ReadPrec ListServersResponse
Int -> ReadS ListServersResponse
ReadS [ListServersResponse]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [ListServersResponse]
$creadListPrec :: ReadPrec [ListServersResponse]
readPrec :: ReadPrec ListServersResponse
$creadPrec :: ReadPrec ListServersResponse
readList :: ReadS [ListServersResponse]
$creadList :: ReadS [ListServersResponse]
readsPrec :: Int -> ReadS ListServersResponse
$creadsPrec :: Int -> ReadS ListServersResponse
Prelude.Read, Int -> ListServersResponse -> ShowS
[ListServersResponse] -> ShowS
ListServersResponse -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [ListServersResponse] -> ShowS
$cshowList :: [ListServersResponse] -> ShowS
show :: ListServersResponse -> String
$cshow :: ListServersResponse -> String
showsPrec :: Int -> ListServersResponse -> ShowS
$cshowsPrec :: Int -> ListServersResponse -> ShowS
Prelude.Show, forall x. Rep ListServersResponse x -> ListServersResponse
forall x. ListServersResponse -> Rep ListServersResponse x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep ListServersResponse x -> ListServersResponse
$cfrom :: forall x. ListServersResponse -> Rep ListServersResponse x
Prelude.Generic)

-- |
-- Create a value of 'ListServersResponse' 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', 'listServersResponse_nextToken' - When you can get additional results from the @ListServers@ operation, a
-- @NextToken@ parameter is returned in the output. In a following command,
-- you can pass in the @NextToken@ parameter to continue listing additional
-- servers.
--
-- 'httpStatus', 'listServersResponse_httpStatus' - The response's http status code.
--
-- 'servers', 'listServersResponse_servers' - An array of servers that were listed.
newListServersResponse ::
  -- | 'httpStatus'
  Prelude.Int ->
  ListServersResponse
newListServersResponse :: Int -> ListServersResponse
newListServersResponse Int
pHttpStatus_ =
  ListServersResponse'
    { $sel:nextToken:ListServersResponse' :: Maybe Text
nextToken = forall a. Maybe a
Prelude.Nothing,
      $sel:httpStatus:ListServersResponse' :: Int
httpStatus = Int
pHttpStatus_,
      $sel:servers:ListServersResponse' :: [ListedServer]
servers = forall a. Monoid a => a
Prelude.mempty
    }

-- | When you can get additional results from the @ListServers@ operation, a
-- @NextToken@ parameter is returned in the output. In a following command,
-- you can pass in the @NextToken@ parameter to continue listing additional
-- servers.
listServersResponse_nextToken :: Lens.Lens' ListServersResponse (Prelude.Maybe Prelude.Text)
listServersResponse_nextToken :: Lens' ListServersResponse (Maybe Text)
listServersResponse_nextToken = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListServersResponse' {Maybe Text
nextToken :: Maybe Text
$sel:nextToken:ListServersResponse' :: ListServersResponse -> Maybe Text
nextToken} -> Maybe Text
nextToken) (\s :: ListServersResponse
s@ListServersResponse' {} Maybe Text
a -> ListServersResponse
s {$sel:nextToken:ListServersResponse' :: Maybe Text
nextToken = Maybe Text
a} :: ListServersResponse)

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

-- | An array of servers that were listed.
listServersResponse_servers :: Lens.Lens' ListServersResponse [ListedServer]
listServersResponse_servers :: Lens' ListServersResponse [ListedServer]
listServersResponse_servers = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListServersResponse' {[ListedServer]
servers :: [ListedServer]
$sel:servers:ListServersResponse' :: ListServersResponse -> [ListedServer]
servers} -> [ListedServer]
servers) (\s :: ListServersResponse
s@ListServersResponse' {} [ListedServer]
a -> ListServersResponse
s {$sel:servers:ListServersResponse' :: [ListedServer]
servers = [ListedServer]
a} :: ListServersResponse) 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 ListServersResponse where
  rnf :: ListServersResponse -> ()
rnf ListServersResponse' {Int
[ListedServer]
Maybe Text
servers :: [ListedServer]
httpStatus :: Int
nextToken :: Maybe Text
$sel:servers:ListServersResponse' :: ListServersResponse -> [ListedServer]
$sel:httpStatus:ListServersResponse' :: ListServersResponse -> Int
$sel:nextToken:ListServersResponse' :: ListServersResponse -> 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 [ListedServer]
servers