{-# 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.DescribeServer
-- Copyright   : (c) 2013-2023 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
--
-- Describes a file transfer protocol-enabled server that you specify by
-- passing the @ServerId@ parameter.
--
-- The response contains a description of a server\'s properties. When you
-- set @EndpointType@ to VPC, the response will contain the
-- @EndpointDetails@.
module Amazonka.Transfer.DescribeServer
  ( -- * Creating a Request
    DescribeServer (..),
    newDescribeServer,

    -- * Request Lenses
    describeServer_serverId,

    -- * Destructuring the Response
    DescribeServerResponse (..),
    newDescribeServerResponse,

    -- * Response Lenses
    describeServerResponse_httpStatus,
    describeServerResponse_server,
  )
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:/ 'newDescribeServer' smart constructor.
data DescribeServer = DescribeServer'
  { -- | A system-assigned unique identifier for a server.
    DescribeServer -> Text
serverId :: Prelude.Text
  }
  deriving (DescribeServer -> DescribeServer -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: DescribeServer -> DescribeServer -> Bool
$c/= :: DescribeServer -> DescribeServer -> Bool
== :: DescribeServer -> DescribeServer -> Bool
$c== :: DescribeServer -> DescribeServer -> Bool
Prelude.Eq, ReadPrec [DescribeServer]
ReadPrec DescribeServer
Int -> ReadS DescribeServer
ReadS [DescribeServer]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [DescribeServer]
$creadListPrec :: ReadPrec [DescribeServer]
readPrec :: ReadPrec DescribeServer
$creadPrec :: ReadPrec DescribeServer
readList :: ReadS [DescribeServer]
$creadList :: ReadS [DescribeServer]
readsPrec :: Int -> ReadS DescribeServer
$creadsPrec :: Int -> ReadS DescribeServer
Prelude.Read, Int -> DescribeServer -> ShowS
[DescribeServer] -> ShowS
DescribeServer -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [DescribeServer] -> ShowS
$cshowList :: [DescribeServer] -> ShowS
show :: DescribeServer -> String
$cshow :: DescribeServer -> String
showsPrec :: Int -> DescribeServer -> ShowS
$cshowsPrec :: Int -> DescribeServer -> ShowS
Prelude.Show, forall x. Rep DescribeServer x -> DescribeServer
forall x. DescribeServer -> Rep DescribeServer x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep DescribeServer x -> DescribeServer
$cfrom :: forall x. DescribeServer -> Rep DescribeServer x
Prelude.Generic)

-- |
-- Create a value of 'DescribeServer' 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:
--
-- 'serverId', 'describeServer_serverId' - A system-assigned unique identifier for a server.
newDescribeServer ::
  -- | 'serverId'
  Prelude.Text ->
  DescribeServer
newDescribeServer :: Text -> DescribeServer
newDescribeServer Text
pServerId_ =
  DescribeServer' {$sel:serverId:DescribeServer' :: Text
serverId = Text
pServerId_}

-- | A system-assigned unique identifier for a server.
describeServer_serverId :: Lens.Lens' DescribeServer Prelude.Text
describeServer_serverId :: Lens' DescribeServer Text
describeServer_serverId = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeServer' {Text
serverId :: Text
$sel:serverId:DescribeServer' :: DescribeServer -> Text
serverId} -> Text
serverId) (\s :: DescribeServer
s@DescribeServer' {} Text
a -> DescribeServer
s {$sel:serverId:DescribeServer' :: Text
serverId = Text
a} :: DescribeServer)

instance Core.AWSRequest DescribeServer where
  type
    AWSResponse DescribeServer =
      DescribeServerResponse
  request :: (Service -> Service) -> DescribeServer -> Request DescribeServer
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 DescribeServer
-> ClientResponse ClientBody
-> m (Either Error (ClientResponse (AWSResponse DescribeServer)))
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 ->
          Int -> DescribedServer -> DescribeServerResponse
DescribeServerResponse'
            forall (f :: * -> *) a b. Functor 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 a
Data..:> Key
"Server")
      )

instance Prelude.Hashable DescribeServer where
  hashWithSalt :: Int -> DescribeServer -> Int
hashWithSalt Int
_salt DescribeServer' {Text
serverId :: Text
$sel:serverId:DescribeServer' :: DescribeServer -> Text
..} =
    Int
_salt forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Text
serverId

instance Prelude.NFData DescribeServer where
  rnf :: DescribeServer -> ()
rnf DescribeServer' {Text
serverId :: Text
$sel:serverId:DescribeServer' :: DescribeServer -> Text
..} = forall a. NFData a => a -> ()
Prelude.rnf Text
serverId

instance Data.ToHeaders DescribeServer where
  toHeaders :: DescribeServer -> 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.DescribeServer" ::
                          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 DescribeServer where
  toJSON :: DescribeServer -> Value
toJSON DescribeServer' {Text
serverId :: Text
$sel:serverId:DescribeServer' :: DescribeServer -> Text
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [forall a. a -> Maybe a
Prelude.Just (Key
"ServerId" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= Text
serverId)]
      )

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

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

-- | /See:/ 'newDescribeServerResponse' smart constructor.
data DescribeServerResponse = DescribeServerResponse'
  { -- | The response's http status code.
    DescribeServerResponse -> Int
httpStatus :: Prelude.Int,
    -- | An array containing the properties of a server with the @ServerID@ you
    -- specified.
    DescribeServerResponse -> DescribedServer
server :: DescribedServer
  }
  deriving (DescribeServerResponse -> DescribeServerResponse -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: DescribeServerResponse -> DescribeServerResponse -> Bool
$c/= :: DescribeServerResponse -> DescribeServerResponse -> Bool
== :: DescribeServerResponse -> DescribeServerResponse -> Bool
$c== :: DescribeServerResponse -> DescribeServerResponse -> Bool
Prelude.Eq, ReadPrec [DescribeServerResponse]
ReadPrec DescribeServerResponse
Int -> ReadS DescribeServerResponse
ReadS [DescribeServerResponse]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [DescribeServerResponse]
$creadListPrec :: ReadPrec [DescribeServerResponse]
readPrec :: ReadPrec DescribeServerResponse
$creadPrec :: ReadPrec DescribeServerResponse
readList :: ReadS [DescribeServerResponse]
$creadList :: ReadS [DescribeServerResponse]
readsPrec :: Int -> ReadS DescribeServerResponse
$creadsPrec :: Int -> ReadS DescribeServerResponse
Prelude.Read, Int -> DescribeServerResponse -> ShowS
[DescribeServerResponse] -> ShowS
DescribeServerResponse -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [DescribeServerResponse] -> ShowS
$cshowList :: [DescribeServerResponse] -> ShowS
show :: DescribeServerResponse -> String
$cshow :: DescribeServerResponse -> String
showsPrec :: Int -> DescribeServerResponse -> ShowS
$cshowsPrec :: Int -> DescribeServerResponse -> ShowS
Prelude.Show, forall x. Rep DescribeServerResponse x -> DescribeServerResponse
forall x. DescribeServerResponse -> Rep DescribeServerResponse x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep DescribeServerResponse x -> DescribeServerResponse
$cfrom :: forall x. DescribeServerResponse -> Rep DescribeServerResponse x
Prelude.Generic)

-- |
-- Create a value of 'DescribeServerResponse' 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:
--
-- 'httpStatus', 'describeServerResponse_httpStatus' - The response's http status code.
--
-- 'server', 'describeServerResponse_server' - An array containing the properties of a server with the @ServerID@ you
-- specified.
newDescribeServerResponse ::
  -- | 'httpStatus'
  Prelude.Int ->
  -- | 'server'
  DescribedServer ->
  DescribeServerResponse
newDescribeServerResponse :: Int -> DescribedServer -> DescribeServerResponse
newDescribeServerResponse Int
pHttpStatus_ DescribedServer
pServer_ =
  DescribeServerResponse'
    { $sel:httpStatus:DescribeServerResponse' :: Int
httpStatus = Int
pHttpStatus_,
      $sel:server:DescribeServerResponse' :: DescribedServer
server = DescribedServer
pServer_
    }

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

-- | An array containing the properties of a server with the @ServerID@ you
-- specified.
describeServerResponse_server :: Lens.Lens' DescribeServerResponse DescribedServer
describeServerResponse_server :: Lens' DescribeServerResponse DescribedServer
describeServerResponse_server = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeServerResponse' {DescribedServer
server :: DescribedServer
$sel:server:DescribeServerResponse' :: DescribeServerResponse -> DescribedServer
server} -> DescribedServer
server) (\s :: DescribeServerResponse
s@DescribeServerResponse' {} DescribedServer
a -> DescribeServerResponse
s {$sel:server:DescribeServerResponse' :: DescribedServer
server = DescribedServer
a} :: DescribeServerResponse)

instance Prelude.NFData DescribeServerResponse where
  rnf :: DescribeServerResponse -> ()
rnf DescribeServerResponse' {Int
DescribedServer
server :: DescribedServer
httpStatus :: Int
$sel:server:DescribeServerResponse' :: DescribeServerResponse -> DescribedServer
$sel:httpStatus:DescribeServerResponse' :: DescribeServerResponse -> Int
..} =
    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 DescribedServer
server