{-# 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.DescribeUser
-- 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 the user assigned to the specific file transfer
-- protocol-enabled server, as identified by its @ServerId@ property.
--
-- The response from this call returns the properties of the user
-- associated with the @ServerId@ value that was specified.
module Amazonka.Transfer.DescribeUser
  ( -- * Creating a Request
    DescribeUser (..),
    newDescribeUser,

    -- * Request Lenses
    describeUser_serverId,
    describeUser_userName,

    -- * Destructuring the Response
    DescribeUserResponse (..),
    newDescribeUserResponse,

    -- * Response Lenses
    describeUserResponse_httpStatus,
    describeUserResponse_serverId,
    describeUserResponse_user,
  )
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:/ 'newDescribeUser' smart constructor.
data DescribeUser = DescribeUser'
  { -- | A system-assigned unique identifier for a server that has this user
    -- assigned.
    DescribeUser -> Text
serverId :: Prelude.Text,
    -- | The name of the user assigned to one or more servers. User names are
    -- part of the sign-in credentials to use the Transfer Family service and
    -- perform file transfer tasks.
    DescribeUser -> Text
userName :: Prelude.Text
  }
  deriving (DescribeUser -> DescribeUser -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: DescribeUser -> DescribeUser -> Bool
$c/= :: DescribeUser -> DescribeUser -> Bool
== :: DescribeUser -> DescribeUser -> Bool
$c== :: DescribeUser -> DescribeUser -> Bool
Prelude.Eq, ReadPrec [DescribeUser]
ReadPrec DescribeUser
Int -> ReadS DescribeUser
ReadS [DescribeUser]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [DescribeUser]
$creadListPrec :: ReadPrec [DescribeUser]
readPrec :: ReadPrec DescribeUser
$creadPrec :: ReadPrec DescribeUser
readList :: ReadS [DescribeUser]
$creadList :: ReadS [DescribeUser]
readsPrec :: Int -> ReadS DescribeUser
$creadsPrec :: Int -> ReadS DescribeUser
Prelude.Read, Int -> DescribeUser -> ShowS
[DescribeUser] -> ShowS
DescribeUser -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [DescribeUser] -> ShowS
$cshowList :: [DescribeUser] -> ShowS
show :: DescribeUser -> String
$cshow :: DescribeUser -> String
showsPrec :: Int -> DescribeUser -> ShowS
$cshowsPrec :: Int -> DescribeUser -> ShowS
Prelude.Show, forall x. Rep DescribeUser x -> DescribeUser
forall x. DescribeUser -> Rep DescribeUser x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep DescribeUser x -> DescribeUser
$cfrom :: forall x. DescribeUser -> Rep DescribeUser x
Prelude.Generic)

-- |
-- Create a value of 'DescribeUser' 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', 'describeUser_serverId' - A system-assigned unique identifier for a server that has this user
-- assigned.
--
-- 'userName', 'describeUser_userName' - The name of the user assigned to one or more servers. User names are
-- part of the sign-in credentials to use the Transfer Family service and
-- perform file transfer tasks.
newDescribeUser ::
  -- | 'serverId'
  Prelude.Text ->
  -- | 'userName'
  Prelude.Text ->
  DescribeUser
newDescribeUser :: Text -> Text -> DescribeUser
newDescribeUser Text
pServerId_ Text
pUserName_ =
  DescribeUser'
    { $sel:serverId:DescribeUser' :: Text
serverId = Text
pServerId_,
      $sel:userName:DescribeUser' :: Text
userName = Text
pUserName_
    }

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

-- | The name of the user assigned to one or more servers. User names are
-- part of the sign-in credentials to use the Transfer Family service and
-- perform file transfer tasks.
describeUser_userName :: Lens.Lens' DescribeUser Prelude.Text
describeUser_userName :: Lens' DescribeUser Text
describeUser_userName = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeUser' {Text
userName :: Text
$sel:userName:DescribeUser' :: DescribeUser -> Text
userName} -> Text
userName) (\s :: DescribeUser
s@DescribeUser' {} Text
a -> DescribeUser
s {$sel:userName:DescribeUser' :: Text
userName = Text
a} :: DescribeUser)

instance Core.AWSRequest DescribeUser where
  type AWSResponse DescribeUser = DescribeUserResponse
  request :: (Service -> Service) -> DescribeUser -> Request DescribeUser
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 DescribeUser
-> ClientResponse ClientBody
-> m (Either Error (ClientResponse (AWSResponse DescribeUser)))
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 -> Text -> DescribedUser -> DescribeUserResponse
DescribeUserResponse'
            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
"ServerId")
            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
"User")
      )

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

instance Prelude.NFData DescribeUser where
  rnf :: DescribeUser -> ()
rnf DescribeUser' {Text
userName :: Text
serverId :: Text
$sel:userName:DescribeUser' :: DescribeUser -> Text
$sel:serverId:DescribeUser' :: DescribeUser -> Text
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Text
serverId
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Text
userName

instance Data.ToHeaders DescribeUser where
  toHeaders :: DescribeUser -> 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.DescribeUser" ::
                          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 DescribeUser where
  toJSON :: DescribeUser -> Value
toJSON DescribeUser' {Text
userName :: Text
serverId :: Text
$sel:userName:DescribeUser' :: DescribeUser -> Text
$sel:serverId:DescribeUser' :: DescribeUser -> 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),
            forall a. a -> Maybe a
Prelude.Just (Key
"UserName" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= Text
userName)
          ]
      )

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

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

-- | /See:/ 'newDescribeUserResponse' smart constructor.
data DescribeUserResponse = DescribeUserResponse'
  { -- | The response's http status code.
    DescribeUserResponse -> Int
httpStatus :: Prelude.Int,
    -- | A system-assigned unique identifier for a server that has this user
    -- assigned.
    DescribeUserResponse -> Text
serverId :: Prelude.Text,
    -- | An array containing the properties of the user account for the
    -- @ServerID@ value that you specified.
    DescribeUserResponse -> DescribedUser
user :: DescribedUser
  }
  deriving (DescribeUserResponse -> DescribeUserResponse -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: DescribeUserResponse -> DescribeUserResponse -> Bool
$c/= :: DescribeUserResponse -> DescribeUserResponse -> Bool
== :: DescribeUserResponse -> DescribeUserResponse -> Bool
$c== :: DescribeUserResponse -> DescribeUserResponse -> Bool
Prelude.Eq, ReadPrec [DescribeUserResponse]
ReadPrec DescribeUserResponse
Int -> ReadS DescribeUserResponse
ReadS [DescribeUserResponse]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [DescribeUserResponse]
$creadListPrec :: ReadPrec [DescribeUserResponse]
readPrec :: ReadPrec DescribeUserResponse
$creadPrec :: ReadPrec DescribeUserResponse
readList :: ReadS [DescribeUserResponse]
$creadList :: ReadS [DescribeUserResponse]
readsPrec :: Int -> ReadS DescribeUserResponse
$creadsPrec :: Int -> ReadS DescribeUserResponse
Prelude.Read, Int -> DescribeUserResponse -> ShowS
[DescribeUserResponse] -> ShowS
DescribeUserResponse -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [DescribeUserResponse] -> ShowS
$cshowList :: [DescribeUserResponse] -> ShowS
show :: DescribeUserResponse -> String
$cshow :: DescribeUserResponse -> String
showsPrec :: Int -> DescribeUserResponse -> ShowS
$cshowsPrec :: Int -> DescribeUserResponse -> ShowS
Prelude.Show, forall x. Rep DescribeUserResponse x -> DescribeUserResponse
forall x. DescribeUserResponse -> Rep DescribeUserResponse x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep DescribeUserResponse x -> DescribeUserResponse
$cfrom :: forall x. DescribeUserResponse -> Rep DescribeUserResponse x
Prelude.Generic)

-- |
-- Create a value of 'DescribeUserResponse' 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', 'describeUserResponse_httpStatus' - The response's http status code.
--
-- 'serverId', 'describeUserResponse_serverId' - A system-assigned unique identifier for a server that has this user
-- assigned.
--
-- 'user', 'describeUserResponse_user' - An array containing the properties of the user account for the
-- @ServerID@ value that you specified.
newDescribeUserResponse ::
  -- | 'httpStatus'
  Prelude.Int ->
  -- | 'serverId'
  Prelude.Text ->
  -- | 'user'
  DescribedUser ->
  DescribeUserResponse
newDescribeUserResponse :: Int -> Text -> DescribedUser -> DescribeUserResponse
newDescribeUserResponse
  Int
pHttpStatus_
  Text
pServerId_
  DescribedUser
pUser_ =
    DescribeUserResponse'
      { $sel:httpStatus:DescribeUserResponse' :: Int
httpStatus = Int
pHttpStatus_,
        $sel:serverId:DescribeUserResponse' :: Text
serverId = Text
pServerId_,
        $sel:user:DescribeUserResponse' :: DescribedUser
user = DescribedUser
pUser_
      }

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

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

-- | An array containing the properties of the user account for the
-- @ServerID@ value that you specified.
describeUserResponse_user :: Lens.Lens' DescribeUserResponse DescribedUser
describeUserResponse_user :: Lens' DescribeUserResponse DescribedUser
describeUserResponse_user = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeUserResponse' {DescribedUser
user :: DescribedUser
$sel:user:DescribeUserResponse' :: DescribeUserResponse -> DescribedUser
user} -> DescribedUser
user) (\s :: DescribeUserResponse
s@DescribeUserResponse' {} DescribedUser
a -> DescribeUserResponse
s {$sel:user:DescribeUserResponse' :: DescribedUser
user = DescribedUser
a} :: DescribeUserResponse)

instance Prelude.NFData DescribeUserResponse where
  rnf :: DescribeUserResponse -> ()
rnf DescribeUserResponse' {Int
Text
DescribedUser
user :: DescribedUser
serverId :: Text
httpStatus :: Int
$sel:user:DescribeUserResponse' :: DescribeUserResponse -> DescribedUser
$sel:serverId:DescribeUserResponse' :: DescribeUserResponse -> Text
$sel:httpStatus:DescribeUserResponse' :: DescribeUserResponse -> 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 Text
serverId
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf DescribedUser
user