{-# 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-2023 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
--
-- Describes the domain configuration for the specified Amazon OpenSearch
-- Service domain, including the domain ID, domain service 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.Core.Lens.Internal as Lens
import qualified Amazonka.Data as Data
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 that you want information about.
    DescribeDomain -> Text
domainName :: Prelude.Text
  }
  deriving (DescribeDomain -> DescribeDomain -> Bool
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]
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
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. 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 that you want information about.
newDescribeDomain ::
  -- | 'domainName'
  Prelude.Text ->
  DescribeDomain
newDescribeDomain :: Text -> DescribeDomain
newDescribeDomain Text
pDomainName_ =
  DescribeDomain' {$sel:domainName:DescribeDomain' :: Text
domainName = Text
pDomainName_}

-- | The name of the domain that you want information about.
describeDomain_domainName :: Lens.Lens' DescribeDomain Prelude.Text
describeDomain_domainName :: Lens' DescribeDomain Text
describeDomain_domainName = 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 :: (Service -> Service) -> DescribeDomain -> Request DescribeDomain
request Service -> Service
overrides =
    forall a. ToRequest a => Service -> a -> Request a
Request.get (Service -> Service
overrides Service
defaultService)
  response :: forall (m :: * -> *).
MonadResource m =>
(ByteStringLazy -> IO ByteStringLazy)
-> Service
-> Proxy DescribeDomain
-> ClientResponse ClientBody
-> m (Either Error (ClientResponse (AWSResponse DescribeDomain)))
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 -> DomainStatus -> DescribeDomainResponse
DescribeDomainResponse'
            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
"DomainStatus")
      )

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

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

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

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

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

-- | 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,
    -- | List that contains the status of each specified OpenSearch Service
    -- domain.
    DescribeDomainResponse -> DomainStatus
domainStatus :: DomainStatus
  }
  deriving (DescribeDomainResponse -> DescribeDomainResponse -> Bool
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]
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
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. 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' - List that contains the status of each specified OpenSearch Service
-- domain.
newDescribeDomainResponse ::
  -- | 'httpStatus'
  Prelude.Int ->
  -- | 'domainStatus'
  DomainStatus ->
  DescribeDomainResponse
newDescribeDomainResponse :: Int -> DomainStatus -> DescribeDomainResponse
newDescribeDomainResponse Int
pHttpStatus_ DomainStatus
pDomainStatus_ =
  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 :: Lens' DescribeDomainResponse Int
describeDomainResponse_httpStatus = 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)

-- | List that contains the status of each specified OpenSearch Service
-- domain.
describeDomainResponse_domainStatus :: Lens.Lens' DescribeDomainResponse DomainStatus
describeDomainResponse_domainStatus :: Lens' DescribeDomainResponse DomainStatus
describeDomainResponse_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 where
  rnf :: DescribeDomainResponse -> ()
rnf DescribeDomainResponse' {Int
DomainStatus
domainStatus :: DomainStatus
httpStatus :: Int
$sel:domainStatus:DescribeDomainResponse' :: DescribeDomainResponse -> DomainStatus
$sel:httpStatus:DescribeDomainResponse' :: DescribeDomainResponse -> 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 DomainStatus
domainStatus