{-# 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.Kafka.DescribeCluster
-- Copyright   : (c) 2013-2021 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay <brendan.g.hay+amazonka@gmail.com>
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
--
-- Returns a description of the MSK cluster whose Amazon Resource Name
-- (ARN) is specified in the request.
module Amazonka.Kafka.DescribeCluster
  ( -- * Creating a Request
    DescribeCluster (..),
    newDescribeCluster,

    -- * Request Lenses
    describeCluster_clusterArn,

    -- * Destructuring the Response
    DescribeClusterResponse (..),
    newDescribeClusterResponse,

    -- * Response Lenses
    describeClusterResponse_clusterInfo,
    describeClusterResponse_httpStatus,
  )
where

import qualified Amazonka.Core as Core
import Amazonka.Kafka.Types
import qualified Amazonka.Lens as Lens
import qualified Amazonka.Prelude as Prelude
import qualified Amazonka.Request as Request
import qualified Amazonka.Response as Response

-- | /See:/ 'newDescribeCluster' smart constructor.
data DescribeCluster = DescribeCluster'
  { -- | The Amazon Resource Name (ARN) that uniquely identifies the cluster.
    DescribeCluster -> Text
clusterArn :: Prelude.Text
  }
  deriving (DescribeCluster -> DescribeCluster -> Bool
(DescribeCluster -> DescribeCluster -> Bool)
-> (DescribeCluster -> DescribeCluster -> Bool)
-> Eq DescribeCluster
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: DescribeCluster -> DescribeCluster -> Bool
$c/= :: DescribeCluster -> DescribeCluster -> Bool
== :: DescribeCluster -> DescribeCluster -> Bool
$c== :: DescribeCluster -> DescribeCluster -> Bool
Prelude.Eq, ReadPrec [DescribeCluster]
ReadPrec DescribeCluster
Int -> ReadS DescribeCluster
ReadS [DescribeCluster]
(Int -> ReadS DescribeCluster)
-> ReadS [DescribeCluster]
-> ReadPrec DescribeCluster
-> ReadPrec [DescribeCluster]
-> Read DescribeCluster
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [DescribeCluster]
$creadListPrec :: ReadPrec [DescribeCluster]
readPrec :: ReadPrec DescribeCluster
$creadPrec :: ReadPrec DescribeCluster
readList :: ReadS [DescribeCluster]
$creadList :: ReadS [DescribeCluster]
readsPrec :: Int -> ReadS DescribeCluster
$creadsPrec :: Int -> ReadS DescribeCluster
Prelude.Read, Int -> DescribeCluster -> ShowS
[DescribeCluster] -> ShowS
DescribeCluster -> String
(Int -> DescribeCluster -> ShowS)
-> (DescribeCluster -> String)
-> ([DescribeCluster] -> ShowS)
-> Show DescribeCluster
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [DescribeCluster] -> ShowS
$cshowList :: [DescribeCluster] -> ShowS
show :: DescribeCluster -> String
$cshow :: DescribeCluster -> String
showsPrec :: Int -> DescribeCluster -> ShowS
$cshowsPrec :: Int -> DescribeCluster -> ShowS
Prelude.Show, (forall x. DescribeCluster -> Rep DescribeCluster x)
-> (forall x. Rep DescribeCluster x -> DescribeCluster)
-> Generic DescribeCluster
forall x. Rep DescribeCluster x -> DescribeCluster
forall x. DescribeCluster -> Rep DescribeCluster x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep DescribeCluster x -> DescribeCluster
$cfrom :: forall x. DescribeCluster -> Rep DescribeCluster x
Prelude.Generic)

-- |
-- Create a value of 'DescribeCluster' 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:
--
-- 'clusterArn', 'describeCluster_clusterArn' - The Amazon Resource Name (ARN) that uniquely identifies the cluster.
newDescribeCluster ::
  -- | 'clusterArn'
  Prelude.Text ->
  DescribeCluster
newDescribeCluster :: Text -> DescribeCluster
newDescribeCluster Text
pClusterArn_ =
  DescribeCluster' :: Text -> DescribeCluster
DescribeCluster' {$sel:clusterArn:DescribeCluster' :: Text
clusterArn = Text
pClusterArn_}

-- | The Amazon Resource Name (ARN) that uniquely identifies the cluster.
describeCluster_clusterArn :: Lens.Lens' DescribeCluster Prelude.Text
describeCluster_clusterArn :: (Text -> f Text) -> DescribeCluster -> f DescribeCluster
describeCluster_clusterArn = (DescribeCluster -> Text)
-> (DescribeCluster -> Text -> DescribeCluster)
-> Lens DescribeCluster DescribeCluster Text Text
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeCluster' {Text
clusterArn :: Text
$sel:clusterArn:DescribeCluster' :: DescribeCluster -> Text
clusterArn} -> Text
clusterArn) (\s :: DescribeCluster
s@DescribeCluster' {} Text
a -> DescribeCluster
s {$sel:clusterArn:DescribeCluster' :: Text
clusterArn = Text
a} :: DescribeCluster)

instance Core.AWSRequest DescribeCluster where
  type
    AWSResponse DescribeCluster =
      DescribeClusterResponse
  request :: DescribeCluster -> Request DescribeCluster
request = Service -> DescribeCluster -> Request DescribeCluster
forall a. ToRequest a => Service -> a -> Request a
Request.get Service
defaultService
  response :: Logger
-> Service
-> Proxy DescribeCluster
-> ClientResponse ClientBody
-> m (Either Error (ClientResponse (AWSResponse DescribeCluster)))
response =
    (Int
 -> ResponseHeaders
 -> Object
 -> Either String (AWSResponse DescribeCluster))
-> Logger
-> Service
-> Proxy DescribeCluster
-> ClientResponse ClientBody
-> m (Either Error (ClientResponse (AWSResponse DescribeCluster)))
forall (m :: * -> *) a.
MonadResource m =>
(Int -> ResponseHeaders -> Object -> Either String (AWSResponse a))
-> Logger
-> Service
-> Proxy a
-> ClientResponse ClientBody
-> m (Either Error (ClientResponse (AWSResponse a)))
Response.receiveJSON
      ( \Int
s ResponseHeaders
h Object
x ->
          Maybe ClusterInfo -> Int -> DescribeClusterResponse
DescribeClusterResponse'
            (Maybe ClusterInfo -> Int -> DescribeClusterResponse)
-> Either String (Maybe ClusterInfo)
-> Either String (Int -> DescribeClusterResponse)
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> (Object
x Object -> Text -> Either String (Maybe ClusterInfo)
forall a. FromJSON a => Object -> Text -> Either String (Maybe a)
Core..?> Text
"clusterInfo")
            Either String (Int -> DescribeClusterResponse)
-> Either String Int -> Either String DescribeClusterResponse
forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Int -> Either String Int
forall (f :: * -> *) a. Applicative f => a -> f a
Prelude.pure (Int -> Int
forall a. Enum a => a -> Int
Prelude.fromEnum Int
s))
      )

instance Prelude.Hashable DescribeCluster

instance Prelude.NFData DescribeCluster

instance Core.ToHeaders DescribeCluster where
  toHeaders :: DescribeCluster -> ResponseHeaders
toHeaders =
    ResponseHeaders -> DescribeCluster -> ResponseHeaders
forall a b. a -> b -> a
Prelude.const
      ( [ResponseHeaders] -> ResponseHeaders
forall a. Monoid a => [a] -> a
Prelude.mconcat
          [ HeaderName
"Content-Type"
              HeaderName -> ByteString -> ResponseHeaders
forall a. ToHeader a => HeaderName -> a -> ResponseHeaders
Core.=# ( ByteString
"application/x-amz-json-1.1" ::
                          Prelude.ByteString
                      )
          ]
      )

instance Core.ToPath DescribeCluster where
  toPath :: DescribeCluster -> ByteString
toPath DescribeCluster' {Text
clusterArn :: Text
$sel:clusterArn:DescribeCluster' :: DescribeCluster -> Text
..} =
    [ByteString] -> ByteString
forall a. Monoid a => [a] -> a
Prelude.mconcat
      [ByteString
"/v1/clusters/", Text -> ByteString
forall a. ToByteString a => a -> ByteString
Core.toBS Text
clusterArn]

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

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

-- |
-- Create a value of 'DescribeClusterResponse' 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:
--
-- 'clusterInfo', 'describeClusterResponse_clusterInfo' - The cluster information.
--
-- 'httpStatus', 'describeClusterResponse_httpStatus' - The response's http status code.
newDescribeClusterResponse ::
  -- | 'httpStatus'
  Prelude.Int ->
  DescribeClusterResponse
newDescribeClusterResponse :: Int -> DescribeClusterResponse
newDescribeClusterResponse Int
pHttpStatus_ =
  DescribeClusterResponse' :: Maybe ClusterInfo -> Int -> DescribeClusterResponse
DescribeClusterResponse'
    { $sel:clusterInfo:DescribeClusterResponse' :: Maybe ClusterInfo
clusterInfo =
        Maybe ClusterInfo
forall a. Maybe a
Prelude.Nothing,
      $sel:httpStatus:DescribeClusterResponse' :: Int
httpStatus = Int
pHttpStatus_
    }

-- | The cluster information.
describeClusterResponse_clusterInfo :: Lens.Lens' DescribeClusterResponse (Prelude.Maybe ClusterInfo)
describeClusterResponse_clusterInfo :: (Maybe ClusterInfo -> f (Maybe ClusterInfo))
-> DescribeClusterResponse -> f DescribeClusterResponse
describeClusterResponse_clusterInfo = (DescribeClusterResponse -> Maybe ClusterInfo)
-> (DescribeClusterResponse
    -> Maybe ClusterInfo -> DescribeClusterResponse)
-> Lens
     DescribeClusterResponse
     DescribeClusterResponse
     (Maybe ClusterInfo)
     (Maybe ClusterInfo)
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeClusterResponse' {Maybe ClusterInfo
clusterInfo :: Maybe ClusterInfo
$sel:clusterInfo:DescribeClusterResponse' :: DescribeClusterResponse -> Maybe ClusterInfo
clusterInfo} -> Maybe ClusterInfo
clusterInfo) (\s :: DescribeClusterResponse
s@DescribeClusterResponse' {} Maybe ClusterInfo
a -> DescribeClusterResponse
s {$sel:clusterInfo:DescribeClusterResponse' :: Maybe ClusterInfo
clusterInfo = Maybe ClusterInfo
a} :: DescribeClusterResponse)

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

instance Prelude.NFData DescribeClusterResponse