{-# 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.OpenSearch.DescribeDomain
-- 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 domain configuration information about the specified domain,
-- including the domain ID, domain endpoint, and domain ARN.
module Amazonka.OpenSearch.DescribeDomain
  ( -- * Creating a Request
    DescribeDomain (..),
    newDescribeDomain,

    -- * Request Lenses
    describeDomain_domainName,

    -- * Destructuring the Response
    DescribeDomainResponse (..),
    newDescribeDomainResponse,

    -- * Response Lenses
    describeDomainResponse_httpStatus,
    describeDomainResponse_domainStatus,
  )
where

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

-- | Container for the parameters to the @ DescribeDomain @ operation.
--
-- /See:/ 'newDescribeDomain' smart constructor.
data DescribeDomain = DescribeDomain'
  { -- | The name of the domain for which you want information.
    DescribeDomain -> Text
domainName :: Prelude.Text
  }
  deriving (DescribeDomain -> DescribeDomain -> Bool
(DescribeDomain -> DescribeDomain -> Bool)
-> (DescribeDomain -> DescribeDomain -> Bool) -> Eq DescribeDomain
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: DescribeDomain -> DescribeDomain -> Bool
$c/= :: DescribeDomain -> DescribeDomain -> Bool
== :: DescribeDomain -> DescribeDomain -> Bool
$c== :: DescribeDomain -> DescribeDomain -> Bool
Prelude.Eq, ReadPrec [DescribeDomain]
ReadPrec DescribeDomain
Int -> ReadS DescribeDomain
ReadS [DescribeDomain]
(Int -> ReadS DescribeDomain)
-> ReadS [DescribeDomain]
-> ReadPrec DescribeDomain
-> ReadPrec [DescribeDomain]
-> Read DescribeDomain
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [DescribeDomain]
$creadListPrec :: ReadPrec [DescribeDomain]
readPrec :: ReadPrec DescribeDomain
$creadPrec :: ReadPrec DescribeDomain
readList :: ReadS [DescribeDomain]
$creadList :: ReadS [DescribeDomain]
readsPrec :: Int -> ReadS DescribeDomain
$creadsPrec :: Int -> ReadS DescribeDomain
Prelude.Read, Int -> DescribeDomain -> ShowS
[DescribeDomain] -> ShowS
DescribeDomain -> String
(Int -> DescribeDomain -> ShowS)
-> (DescribeDomain -> String)
-> ([DescribeDomain] -> ShowS)
-> Show DescribeDomain
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [DescribeDomain] -> ShowS
$cshowList :: [DescribeDomain] -> ShowS
show :: DescribeDomain -> String
$cshow :: DescribeDomain -> String
showsPrec :: Int -> DescribeDomain -> ShowS
$cshowsPrec :: Int -> DescribeDomain -> ShowS
Prelude.Show, (forall x. DescribeDomain -> Rep DescribeDomain x)
-> (forall x. Rep DescribeDomain x -> DescribeDomain)
-> Generic DescribeDomain
forall x. Rep DescribeDomain x -> DescribeDomain
forall x. DescribeDomain -> Rep DescribeDomain x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep DescribeDomain x -> DescribeDomain
$cfrom :: forall x. DescribeDomain -> Rep DescribeDomain x
Prelude.Generic)

-- |
-- Create a value of 'DescribeDomain' 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:
--
-- 'domainName', 'describeDomain_domainName' - The name of the domain for which you want information.
newDescribeDomain ::
  -- | 'domainName'
  Prelude.Text ->
  DescribeDomain
newDescribeDomain :: Text -> DescribeDomain
newDescribeDomain Text
pDomainName_ =
  DescribeDomain' :: Text -> DescribeDomain
DescribeDomain' {$sel:domainName:DescribeDomain' :: Text
domainName = Text
pDomainName_}

-- | The name of the domain for which you want information.
describeDomain_domainName :: Lens.Lens' DescribeDomain Prelude.Text
describeDomain_domainName :: (Text -> f Text) -> DescribeDomain -> f DescribeDomain
describeDomain_domainName = (DescribeDomain -> Text)
-> (DescribeDomain -> Text -> DescribeDomain)
-> Lens DescribeDomain DescribeDomain Text Text
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeDomain' {Text
domainName :: Text
$sel:domainName:DescribeDomain' :: DescribeDomain -> Text
domainName} -> Text
domainName) (\s :: DescribeDomain
s@DescribeDomain' {} Text
a -> DescribeDomain
s {$sel:domainName:DescribeDomain' :: Text
domainName = Text
a} :: DescribeDomain)

instance Core.AWSRequest DescribeDomain where
  type
    AWSResponse DescribeDomain =
      DescribeDomainResponse
  request :: DescribeDomain -> Request DescribeDomain
request = Service -> DescribeDomain -> Request DescribeDomain
forall a. ToRequest a => Service -> a -> Request a
Request.get Service
defaultService
  response :: Logger
-> Service
-> Proxy DescribeDomain
-> ClientResponse ClientBody
-> m (Either Error (ClientResponse (AWSResponse DescribeDomain)))
response =
    (Int
 -> ResponseHeaders
 -> Object
 -> Either String (AWSResponse DescribeDomain))
-> Logger
-> Service
-> Proxy DescribeDomain
-> ClientResponse ClientBody
-> m (Either Error (ClientResponse (AWSResponse DescribeDomain)))
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 ->
          Int -> DomainStatus -> DescribeDomainResponse
DescribeDomainResponse'
            (Int -> DomainStatus -> DescribeDomainResponse)
-> Either String Int
-> Either String (DomainStatus -> DescribeDomainResponse)
forall (f :: * -> *) a b. Functor 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))
            Either String (DomainStatus -> DescribeDomainResponse)
-> Either String DomainStatus
-> Either String DescribeDomainResponse
forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x Object -> Text -> Either String DomainStatus
forall a. FromJSON a => Object -> Text -> Either String a
Core..:> Text
"DomainStatus")
      )

instance Prelude.Hashable DescribeDomain

instance Prelude.NFData DescribeDomain

instance Core.ToHeaders DescribeDomain where
  toHeaders :: DescribeDomain -> ResponseHeaders
toHeaders = ResponseHeaders -> DescribeDomain -> ResponseHeaders
forall a b. a -> b -> a
Prelude.const ResponseHeaders
forall a. Monoid a => a
Prelude.mempty

instance Core.ToPath DescribeDomain where
  toPath :: DescribeDomain -> ByteString
toPath DescribeDomain' {Text
domainName :: Text
$sel:domainName:DescribeDomain' :: DescribeDomain -> Text
..} =
    [ByteString] -> ByteString
forall a. Monoid a => [a] -> a
Prelude.mconcat
      [ ByteString
"/2021-01-01/opensearch/domain/",
        Text -> ByteString
forall a. ToByteString a => a -> ByteString
Core.toBS Text
domainName
      ]

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

-- | The result of a @DescribeDomain@ request. Contains the status of the
-- domain specified in the request.
--
-- /See:/ 'newDescribeDomainResponse' smart constructor.
data DescribeDomainResponse = DescribeDomainResponse'
  { -- | The response's http status code.
    DescribeDomainResponse -> Int
httpStatus :: Prelude.Int,
    -- | The current status of the domain.
    DescribeDomainResponse -> DomainStatus
domainStatus :: DomainStatus
  }
  deriving (DescribeDomainResponse -> DescribeDomainResponse -> Bool
(DescribeDomainResponse -> DescribeDomainResponse -> Bool)
-> (DescribeDomainResponse -> DescribeDomainResponse -> Bool)
-> Eq DescribeDomainResponse
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: DescribeDomainResponse -> DescribeDomainResponse -> Bool
$c/= :: DescribeDomainResponse -> DescribeDomainResponse -> Bool
== :: DescribeDomainResponse -> DescribeDomainResponse -> Bool
$c== :: DescribeDomainResponse -> DescribeDomainResponse -> Bool
Prelude.Eq, ReadPrec [DescribeDomainResponse]
ReadPrec DescribeDomainResponse
Int -> ReadS DescribeDomainResponse
ReadS [DescribeDomainResponse]
(Int -> ReadS DescribeDomainResponse)
-> ReadS [DescribeDomainResponse]
-> ReadPrec DescribeDomainResponse
-> ReadPrec [DescribeDomainResponse]
-> Read DescribeDomainResponse
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [DescribeDomainResponse]
$creadListPrec :: ReadPrec [DescribeDomainResponse]
readPrec :: ReadPrec DescribeDomainResponse
$creadPrec :: ReadPrec DescribeDomainResponse
readList :: ReadS [DescribeDomainResponse]
$creadList :: ReadS [DescribeDomainResponse]
readsPrec :: Int -> ReadS DescribeDomainResponse
$creadsPrec :: Int -> ReadS DescribeDomainResponse
Prelude.Read, Int -> DescribeDomainResponse -> ShowS
[DescribeDomainResponse] -> ShowS
DescribeDomainResponse -> String
(Int -> DescribeDomainResponse -> ShowS)
-> (DescribeDomainResponse -> String)
-> ([DescribeDomainResponse] -> ShowS)
-> Show DescribeDomainResponse
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [DescribeDomainResponse] -> ShowS
$cshowList :: [DescribeDomainResponse] -> ShowS
show :: DescribeDomainResponse -> String
$cshow :: DescribeDomainResponse -> String
showsPrec :: Int -> DescribeDomainResponse -> ShowS
$cshowsPrec :: Int -> DescribeDomainResponse -> ShowS
Prelude.Show, (forall x. DescribeDomainResponse -> Rep DescribeDomainResponse x)
-> (forall x.
    Rep DescribeDomainResponse x -> DescribeDomainResponse)
-> Generic DescribeDomainResponse
forall x. Rep DescribeDomainResponse x -> DescribeDomainResponse
forall x. DescribeDomainResponse -> Rep DescribeDomainResponse x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep DescribeDomainResponse x -> DescribeDomainResponse
$cfrom :: forall x. DescribeDomainResponse -> Rep DescribeDomainResponse x
Prelude.Generic)

-- |
-- Create a value of 'DescribeDomainResponse' 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', 'describeDomainResponse_httpStatus' - The response's http status code.
--
-- 'domainStatus', 'describeDomainResponse_domainStatus' - The current status of the domain.
newDescribeDomainResponse ::
  -- | 'httpStatus'
  Prelude.Int ->
  -- | 'domainStatus'
  DomainStatus ->
  DescribeDomainResponse
newDescribeDomainResponse :: Int -> DomainStatus -> DescribeDomainResponse
newDescribeDomainResponse Int
pHttpStatus_ DomainStatus
pDomainStatus_ =
  DescribeDomainResponse' :: Int -> DomainStatus -> DescribeDomainResponse
DescribeDomainResponse'
    { $sel:httpStatus:DescribeDomainResponse' :: Int
httpStatus = Int
pHttpStatus_,
      $sel:domainStatus:DescribeDomainResponse' :: DomainStatus
domainStatus = DomainStatus
pDomainStatus_
    }

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

-- | The current status of the domain.
describeDomainResponse_domainStatus :: Lens.Lens' DescribeDomainResponse DomainStatus
describeDomainResponse_domainStatus :: (DomainStatus -> f DomainStatus)
-> DescribeDomainResponse -> f DescribeDomainResponse
describeDomainResponse_domainStatus = (DescribeDomainResponse -> DomainStatus)
-> (DescribeDomainResponse
    -> DomainStatus -> DescribeDomainResponse)
-> Lens
     DescribeDomainResponse
     DescribeDomainResponse
     DomainStatus
     DomainStatus
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeDomainResponse' {DomainStatus
domainStatus :: DomainStatus
$sel:domainStatus:DescribeDomainResponse' :: DescribeDomainResponse -> DomainStatus
domainStatus} -> DomainStatus
domainStatus) (\s :: DescribeDomainResponse
s@DescribeDomainResponse' {} DomainStatus
a -> DescribeDomainResponse
s {$sel:domainStatus:DescribeDomainResponse' :: DomainStatus
domainStatus = DomainStatus
a} :: DescribeDomainResponse)

instance Prelude.NFData DescribeDomainResponse