{-# 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.IoTSecureTunneling.DescribeTunnel
-- Copyright   : (c) 2013-2023 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
--
-- Gets information about a tunnel identified by the unique tunnel id.
--
-- Requires permission to access the
-- <https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions DescribeTunnel>
-- action.
module Amazonka.IoTSecureTunneling.DescribeTunnel
  ( -- * Creating a Request
    DescribeTunnel (..),
    newDescribeTunnel,

    -- * Request Lenses
    describeTunnel_tunnelId,

    -- * Destructuring the Response
    DescribeTunnelResponse (..),
    newDescribeTunnelResponse,

    -- * Response Lenses
    describeTunnelResponse_tunnel,
    describeTunnelResponse_httpStatus,
  )
where

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

-- | /See:/ 'newDescribeTunnel' smart constructor.
data DescribeTunnel = DescribeTunnel'
  { -- | The tunnel to describe.
    DescribeTunnel -> Text
tunnelId :: Prelude.Text
  }
  deriving (DescribeTunnel -> DescribeTunnel -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: DescribeTunnel -> DescribeTunnel -> Bool
$c/= :: DescribeTunnel -> DescribeTunnel -> Bool
== :: DescribeTunnel -> DescribeTunnel -> Bool
$c== :: DescribeTunnel -> DescribeTunnel -> Bool
Prelude.Eq, ReadPrec [DescribeTunnel]
ReadPrec DescribeTunnel
Int -> ReadS DescribeTunnel
ReadS [DescribeTunnel]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [DescribeTunnel]
$creadListPrec :: ReadPrec [DescribeTunnel]
readPrec :: ReadPrec DescribeTunnel
$creadPrec :: ReadPrec DescribeTunnel
readList :: ReadS [DescribeTunnel]
$creadList :: ReadS [DescribeTunnel]
readsPrec :: Int -> ReadS DescribeTunnel
$creadsPrec :: Int -> ReadS DescribeTunnel
Prelude.Read, Int -> DescribeTunnel -> ShowS
[DescribeTunnel] -> ShowS
DescribeTunnel -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [DescribeTunnel] -> ShowS
$cshowList :: [DescribeTunnel] -> ShowS
show :: DescribeTunnel -> String
$cshow :: DescribeTunnel -> String
showsPrec :: Int -> DescribeTunnel -> ShowS
$cshowsPrec :: Int -> DescribeTunnel -> ShowS
Prelude.Show, forall x. Rep DescribeTunnel x -> DescribeTunnel
forall x. DescribeTunnel -> Rep DescribeTunnel x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep DescribeTunnel x -> DescribeTunnel
$cfrom :: forall x. DescribeTunnel -> Rep DescribeTunnel x
Prelude.Generic)

-- |
-- Create a value of 'DescribeTunnel' 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:
--
-- 'tunnelId', 'describeTunnel_tunnelId' - The tunnel to describe.
newDescribeTunnel ::
  -- | 'tunnelId'
  Prelude.Text ->
  DescribeTunnel
newDescribeTunnel :: Text -> DescribeTunnel
newDescribeTunnel Text
pTunnelId_ =
  DescribeTunnel' {$sel:tunnelId:DescribeTunnel' :: Text
tunnelId = Text
pTunnelId_}

-- | The tunnel to describe.
describeTunnel_tunnelId :: Lens.Lens' DescribeTunnel Prelude.Text
describeTunnel_tunnelId :: Lens' DescribeTunnel Text
describeTunnel_tunnelId = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeTunnel' {Text
tunnelId :: Text
$sel:tunnelId:DescribeTunnel' :: DescribeTunnel -> Text
tunnelId} -> Text
tunnelId) (\s :: DescribeTunnel
s@DescribeTunnel' {} Text
a -> DescribeTunnel
s {$sel:tunnelId:DescribeTunnel' :: Text
tunnelId = Text
a} :: DescribeTunnel)

instance Core.AWSRequest DescribeTunnel where
  type
    AWSResponse DescribeTunnel =
      DescribeTunnelResponse
  request :: (Service -> Service) -> DescribeTunnel -> Request DescribeTunnel
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 DescribeTunnel
-> ClientResponse ClientBody
-> m (Either Error (ClientResponse (AWSResponse DescribeTunnel)))
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 Tunnel -> Int -> DescribeTunnelResponse
DescribeTunnelResponse'
            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
"tunnel")
            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 DescribeTunnel where
  hashWithSalt :: Int -> DescribeTunnel -> Int
hashWithSalt Int
_salt DescribeTunnel' {Text
tunnelId :: Text
$sel:tunnelId:DescribeTunnel' :: DescribeTunnel -> Text
..} =
    Int
_salt forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Text
tunnelId

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

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

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

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

-- | /See:/ 'newDescribeTunnelResponse' smart constructor.
data DescribeTunnelResponse = DescribeTunnelResponse'
  { -- | The tunnel being described.
    DescribeTunnelResponse -> Maybe Tunnel
tunnel :: Prelude.Maybe Tunnel,
    -- | The response's http status code.
    DescribeTunnelResponse -> Int
httpStatus :: Prelude.Int
  }
  deriving (DescribeTunnelResponse -> DescribeTunnelResponse -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: DescribeTunnelResponse -> DescribeTunnelResponse -> Bool
$c/= :: DescribeTunnelResponse -> DescribeTunnelResponse -> Bool
== :: DescribeTunnelResponse -> DescribeTunnelResponse -> Bool
$c== :: DescribeTunnelResponse -> DescribeTunnelResponse -> Bool
Prelude.Eq, ReadPrec [DescribeTunnelResponse]
ReadPrec DescribeTunnelResponse
Int -> ReadS DescribeTunnelResponse
ReadS [DescribeTunnelResponse]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [DescribeTunnelResponse]
$creadListPrec :: ReadPrec [DescribeTunnelResponse]
readPrec :: ReadPrec DescribeTunnelResponse
$creadPrec :: ReadPrec DescribeTunnelResponse
readList :: ReadS [DescribeTunnelResponse]
$creadList :: ReadS [DescribeTunnelResponse]
readsPrec :: Int -> ReadS DescribeTunnelResponse
$creadsPrec :: Int -> ReadS DescribeTunnelResponse
Prelude.Read, Int -> DescribeTunnelResponse -> ShowS
[DescribeTunnelResponse] -> ShowS
DescribeTunnelResponse -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [DescribeTunnelResponse] -> ShowS
$cshowList :: [DescribeTunnelResponse] -> ShowS
show :: DescribeTunnelResponse -> String
$cshow :: DescribeTunnelResponse -> String
showsPrec :: Int -> DescribeTunnelResponse -> ShowS
$cshowsPrec :: Int -> DescribeTunnelResponse -> ShowS
Prelude.Show, forall x. Rep DescribeTunnelResponse x -> DescribeTunnelResponse
forall x. DescribeTunnelResponse -> Rep DescribeTunnelResponse x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep DescribeTunnelResponse x -> DescribeTunnelResponse
$cfrom :: forall x. DescribeTunnelResponse -> Rep DescribeTunnelResponse x
Prelude.Generic)

-- |
-- Create a value of 'DescribeTunnelResponse' 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:
--
-- 'tunnel', 'describeTunnelResponse_tunnel' - The tunnel being described.
--
-- 'httpStatus', 'describeTunnelResponse_httpStatus' - The response's http status code.
newDescribeTunnelResponse ::
  -- | 'httpStatus'
  Prelude.Int ->
  DescribeTunnelResponse
newDescribeTunnelResponse :: Int -> DescribeTunnelResponse
newDescribeTunnelResponse Int
pHttpStatus_ =
  DescribeTunnelResponse'
    { $sel:tunnel:DescribeTunnelResponse' :: Maybe Tunnel
tunnel = forall a. Maybe a
Prelude.Nothing,
      $sel:httpStatus:DescribeTunnelResponse' :: Int
httpStatus = Int
pHttpStatus_
    }

-- | The tunnel being described.
describeTunnelResponse_tunnel :: Lens.Lens' DescribeTunnelResponse (Prelude.Maybe Tunnel)
describeTunnelResponse_tunnel :: Lens' DescribeTunnelResponse (Maybe Tunnel)
describeTunnelResponse_tunnel = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeTunnelResponse' {Maybe Tunnel
tunnel :: Maybe Tunnel
$sel:tunnel:DescribeTunnelResponse' :: DescribeTunnelResponse -> Maybe Tunnel
tunnel} -> Maybe Tunnel
tunnel) (\s :: DescribeTunnelResponse
s@DescribeTunnelResponse' {} Maybe Tunnel
a -> DescribeTunnelResponse
s {$sel:tunnel:DescribeTunnelResponse' :: Maybe Tunnel
tunnel = Maybe Tunnel
a} :: DescribeTunnelResponse)

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

instance Prelude.NFData DescribeTunnelResponse where
  rnf :: DescribeTunnelResponse -> ()
rnf DescribeTunnelResponse' {Int
Maybe Tunnel
httpStatus :: Int
tunnel :: Maybe Tunnel
$sel:httpStatus:DescribeTunnelResponse' :: DescribeTunnelResponse -> Int
$sel:tunnel:DescribeTunnelResponse' :: DescribeTunnelResponse -> Maybe Tunnel
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe Tunnel
tunnel
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Int
httpStatus