{-# 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.Route53Domains.CheckDomainTransferability
-- Copyright   : (c) 2013-2023 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
--
-- Checks whether a domain name can be transferred to Amazon Route 53.
module Amazonka.Route53Domains.CheckDomainTransferability
  ( -- * Creating a Request
    CheckDomainTransferability (..),
    newCheckDomainTransferability,

    -- * Request Lenses
    checkDomainTransferability_authCode,
    checkDomainTransferability_domainName,

    -- * Destructuring the Response
    CheckDomainTransferabilityResponse (..),
    newCheckDomainTransferabilityResponse,

    -- * Response Lenses
    checkDomainTransferabilityResponse_transferability,
    checkDomainTransferabilityResponse_httpStatus,
  )
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.Route53Domains.Types

-- | The CheckDomainTransferability request contains the following elements.
--
-- /See:/ 'newCheckDomainTransferability' smart constructor.
data CheckDomainTransferability = CheckDomainTransferability'
  { -- | If the registrar for the top-level domain (TLD) requires an
    -- authorization code to transfer the domain, the code that you got from
    -- the current registrar for the domain.
    CheckDomainTransferability -> Maybe (Sensitive Text)
authCode :: Prelude.Maybe (Data.Sensitive Prelude.Text),
    -- | The name of the domain that you want to transfer to Route 53. The
    -- top-level domain (TLD), such as .com, must be a TLD that Route 53
    -- supports. For a list of supported TLDs, see
    -- <https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/registrar-tld-list.html Domains that You Can Register with Amazon Route 53>
    -- in the /Amazon Route 53 Developer Guide/.
    --
    -- The domain name can contain only the following characters:
    --
    -- -   Letters a through z. Domain names are not case sensitive.
    --
    -- -   Numbers 0 through 9.
    --
    -- -   Hyphen (-). You can\'t specify a hyphen at the beginning or end of a
    --     label.
    --
    -- -   Period (.) to separate the labels in the name, such as the @.@ in
    --     @example.com@.
    CheckDomainTransferability -> Text
domainName :: Prelude.Text
  }
  deriving (CheckDomainTransferability -> CheckDomainTransferability -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: CheckDomainTransferability -> CheckDomainTransferability -> Bool
$c/= :: CheckDomainTransferability -> CheckDomainTransferability -> Bool
== :: CheckDomainTransferability -> CheckDomainTransferability -> Bool
$c== :: CheckDomainTransferability -> CheckDomainTransferability -> Bool
Prelude.Eq, Int -> CheckDomainTransferability -> ShowS
[CheckDomainTransferability] -> ShowS
CheckDomainTransferability -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [CheckDomainTransferability] -> ShowS
$cshowList :: [CheckDomainTransferability] -> ShowS
show :: CheckDomainTransferability -> String
$cshow :: CheckDomainTransferability -> String
showsPrec :: Int -> CheckDomainTransferability -> ShowS
$cshowsPrec :: Int -> CheckDomainTransferability -> ShowS
Prelude.Show, forall x.
Rep CheckDomainTransferability x -> CheckDomainTransferability
forall x.
CheckDomainTransferability -> Rep CheckDomainTransferability x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x.
Rep CheckDomainTransferability x -> CheckDomainTransferability
$cfrom :: forall x.
CheckDomainTransferability -> Rep CheckDomainTransferability x
Prelude.Generic)

-- |
-- Create a value of 'CheckDomainTransferability' 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:
--
-- 'authCode', 'checkDomainTransferability_authCode' - If the registrar for the top-level domain (TLD) requires an
-- authorization code to transfer the domain, the code that you got from
-- the current registrar for the domain.
--
-- 'domainName', 'checkDomainTransferability_domainName' - The name of the domain that you want to transfer to Route 53. The
-- top-level domain (TLD), such as .com, must be a TLD that Route 53
-- supports. For a list of supported TLDs, see
-- <https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/registrar-tld-list.html Domains that You Can Register with Amazon Route 53>
-- in the /Amazon Route 53 Developer Guide/.
--
-- The domain name can contain only the following characters:
--
-- -   Letters a through z. Domain names are not case sensitive.
--
-- -   Numbers 0 through 9.
--
-- -   Hyphen (-). You can\'t specify a hyphen at the beginning or end of a
--     label.
--
-- -   Period (.) to separate the labels in the name, such as the @.@ in
--     @example.com@.
newCheckDomainTransferability ::
  -- | 'domainName'
  Prelude.Text ->
  CheckDomainTransferability
newCheckDomainTransferability :: Text -> CheckDomainTransferability
newCheckDomainTransferability Text
pDomainName_ =
  CheckDomainTransferability'
    { $sel:authCode:CheckDomainTransferability' :: Maybe (Sensitive Text)
authCode =
        forall a. Maybe a
Prelude.Nothing,
      $sel:domainName:CheckDomainTransferability' :: Text
domainName = Text
pDomainName_
    }

-- | If the registrar for the top-level domain (TLD) requires an
-- authorization code to transfer the domain, the code that you got from
-- the current registrar for the domain.
checkDomainTransferability_authCode :: Lens.Lens' CheckDomainTransferability (Prelude.Maybe Prelude.Text)
checkDomainTransferability_authCode :: Lens' CheckDomainTransferability (Maybe Text)
checkDomainTransferability_authCode = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\CheckDomainTransferability' {Maybe (Sensitive Text)
authCode :: Maybe (Sensitive Text)
$sel:authCode:CheckDomainTransferability' :: CheckDomainTransferability -> Maybe (Sensitive Text)
authCode} -> Maybe (Sensitive Text)
authCode) (\s :: CheckDomainTransferability
s@CheckDomainTransferability' {} Maybe (Sensitive Text)
a -> CheckDomainTransferability
s {$sel:authCode:CheckDomainTransferability' :: Maybe (Sensitive Text)
authCode = Maybe (Sensitive Text)
a} :: CheckDomainTransferability) forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall (f :: * -> *) (g :: * -> *) s t a b.
(Functor f, Functor g) =>
AnIso s t a b -> Iso (f s) (g t) (f a) (g b)
Lens.mapping forall a. Iso' (Sensitive a) a
Data._Sensitive

-- | The name of the domain that you want to transfer to Route 53. The
-- top-level domain (TLD), such as .com, must be a TLD that Route 53
-- supports. For a list of supported TLDs, see
-- <https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/registrar-tld-list.html Domains that You Can Register with Amazon Route 53>
-- in the /Amazon Route 53 Developer Guide/.
--
-- The domain name can contain only the following characters:
--
-- -   Letters a through z. Domain names are not case sensitive.
--
-- -   Numbers 0 through 9.
--
-- -   Hyphen (-). You can\'t specify a hyphen at the beginning or end of a
--     label.
--
-- -   Period (.) to separate the labels in the name, such as the @.@ in
--     @example.com@.
checkDomainTransferability_domainName :: Lens.Lens' CheckDomainTransferability Prelude.Text
checkDomainTransferability_domainName :: Lens' CheckDomainTransferability Text
checkDomainTransferability_domainName = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\CheckDomainTransferability' {Text
domainName :: Text
$sel:domainName:CheckDomainTransferability' :: CheckDomainTransferability -> Text
domainName} -> Text
domainName) (\s :: CheckDomainTransferability
s@CheckDomainTransferability' {} Text
a -> CheckDomainTransferability
s {$sel:domainName:CheckDomainTransferability' :: Text
domainName = Text
a} :: CheckDomainTransferability)

instance Core.AWSRequest CheckDomainTransferability where
  type
    AWSResponse CheckDomainTransferability =
      CheckDomainTransferabilityResponse
  request :: (Service -> Service)
-> CheckDomainTransferability -> Request CheckDomainTransferability
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 CheckDomainTransferability
-> ClientResponse ClientBody
-> m (Either
        Error (ClientResponse (AWSResponse CheckDomainTransferability)))
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 DomainTransferability
-> Int -> CheckDomainTransferabilityResponse
CheckDomainTransferabilityResponse'
            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
"Transferability")
            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 CheckDomainTransferability where
  hashWithSalt :: Int -> CheckDomainTransferability -> Int
hashWithSalt Int
_salt CheckDomainTransferability' {Maybe (Sensitive Text)
Text
domainName :: Text
authCode :: Maybe (Sensitive Text)
$sel:domainName:CheckDomainTransferability' :: CheckDomainTransferability -> Text
$sel:authCode:CheckDomainTransferability' :: CheckDomainTransferability -> Maybe (Sensitive Text)
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe (Sensitive Text)
authCode
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Text
domainName

instance Prelude.NFData CheckDomainTransferability where
  rnf :: CheckDomainTransferability -> ()
rnf CheckDomainTransferability' {Maybe (Sensitive Text)
Text
domainName :: Text
authCode :: Maybe (Sensitive Text)
$sel:domainName:CheckDomainTransferability' :: CheckDomainTransferability -> Text
$sel:authCode:CheckDomainTransferability' :: CheckDomainTransferability -> Maybe (Sensitive Text)
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe (Sensitive Text)
authCode
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Text
domainName

instance Data.ToHeaders CheckDomainTransferability where
  toHeaders :: CheckDomainTransferability -> 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
"Route53Domains_v20140515.CheckDomainTransferability" ::
                          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 CheckDomainTransferability where
  toJSON :: CheckDomainTransferability -> Value
toJSON CheckDomainTransferability' {Maybe (Sensitive Text)
Text
domainName :: Text
authCode :: Maybe (Sensitive Text)
$sel:domainName:CheckDomainTransferability' :: CheckDomainTransferability -> Text
$sel:authCode:CheckDomainTransferability' :: CheckDomainTransferability -> Maybe (Sensitive Text)
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ (Key
"AuthCode" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=) forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe (Sensitive Text)
authCode,
            forall a. a -> Maybe a
Prelude.Just (Key
"DomainName" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= Text
domainName)
          ]
      )

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

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

-- | The CheckDomainTransferability response includes the following elements.
--
-- /See:/ 'newCheckDomainTransferabilityResponse' smart constructor.
data CheckDomainTransferabilityResponse = CheckDomainTransferabilityResponse'
  { -- | A complex type that contains information about whether the specified
    -- domain can be transferred to Route 53.
    CheckDomainTransferabilityResponse -> Maybe DomainTransferability
transferability :: Prelude.Maybe DomainTransferability,
    -- | The response's http status code.
    CheckDomainTransferabilityResponse -> Int
httpStatus :: Prelude.Int
  }
  deriving (CheckDomainTransferabilityResponse
-> CheckDomainTransferabilityResponse -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: CheckDomainTransferabilityResponse
-> CheckDomainTransferabilityResponse -> Bool
$c/= :: CheckDomainTransferabilityResponse
-> CheckDomainTransferabilityResponse -> Bool
== :: CheckDomainTransferabilityResponse
-> CheckDomainTransferabilityResponse -> Bool
$c== :: CheckDomainTransferabilityResponse
-> CheckDomainTransferabilityResponse -> Bool
Prelude.Eq, ReadPrec [CheckDomainTransferabilityResponse]
ReadPrec CheckDomainTransferabilityResponse
Int -> ReadS CheckDomainTransferabilityResponse
ReadS [CheckDomainTransferabilityResponse]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [CheckDomainTransferabilityResponse]
$creadListPrec :: ReadPrec [CheckDomainTransferabilityResponse]
readPrec :: ReadPrec CheckDomainTransferabilityResponse
$creadPrec :: ReadPrec CheckDomainTransferabilityResponse
readList :: ReadS [CheckDomainTransferabilityResponse]
$creadList :: ReadS [CheckDomainTransferabilityResponse]
readsPrec :: Int -> ReadS CheckDomainTransferabilityResponse
$creadsPrec :: Int -> ReadS CheckDomainTransferabilityResponse
Prelude.Read, Int -> CheckDomainTransferabilityResponse -> ShowS
[CheckDomainTransferabilityResponse] -> ShowS
CheckDomainTransferabilityResponse -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [CheckDomainTransferabilityResponse] -> ShowS
$cshowList :: [CheckDomainTransferabilityResponse] -> ShowS
show :: CheckDomainTransferabilityResponse -> String
$cshow :: CheckDomainTransferabilityResponse -> String
showsPrec :: Int -> CheckDomainTransferabilityResponse -> ShowS
$cshowsPrec :: Int -> CheckDomainTransferabilityResponse -> ShowS
Prelude.Show, forall x.
Rep CheckDomainTransferabilityResponse x
-> CheckDomainTransferabilityResponse
forall x.
CheckDomainTransferabilityResponse
-> Rep CheckDomainTransferabilityResponse x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x.
Rep CheckDomainTransferabilityResponse x
-> CheckDomainTransferabilityResponse
$cfrom :: forall x.
CheckDomainTransferabilityResponse
-> Rep CheckDomainTransferabilityResponse x
Prelude.Generic)

-- |
-- Create a value of 'CheckDomainTransferabilityResponse' 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:
--
-- 'transferability', 'checkDomainTransferabilityResponse_transferability' - A complex type that contains information about whether the specified
-- domain can be transferred to Route 53.
--
-- 'httpStatus', 'checkDomainTransferabilityResponse_httpStatus' - The response's http status code.
newCheckDomainTransferabilityResponse ::
  -- | 'httpStatus'
  Prelude.Int ->
  CheckDomainTransferabilityResponse
newCheckDomainTransferabilityResponse :: Int -> CheckDomainTransferabilityResponse
newCheckDomainTransferabilityResponse Int
pHttpStatus_ =
  CheckDomainTransferabilityResponse'
    { $sel:transferability:CheckDomainTransferabilityResponse' :: Maybe DomainTransferability
transferability =
        forall a. Maybe a
Prelude.Nothing,
      $sel:httpStatus:CheckDomainTransferabilityResponse' :: Int
httpStatus = Int
pHttpStatus_
    }

-- | A complex type that contains information about whether the specified
-- domain can be transferred to Route 53.
checkDomainTransferabilityResponse_transferability :: Lens.Lens' CheckDomainTransferabilityResponse (Prelude.Maybe DomainTransferability)
checkDomainTransferabilityResponse_transferability :: Lens'
  CheckDomainTransferabilityResponse (Maybe DomainTransferability)
checkDomainTransferabilityResponse_transferability = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\CheckDomainTransferabilityResponse' {Maybe DomainTransferability
transferability :: Maybe DomainTransferability
$sel:transferability:CheckDomainTransferabilityResponse' :: CheckDomainTransferabilityResponse -> Maybe DomainTransferability
transferability} -> Maybe DomainTransferability
transferability) (\s :: CheckDomainTransferabilityResponse
s@CheckDomainTransferabilityResponse' {} Maybe DomainTransferability
a -> CheckDomainTransferabilityResponse
s {$sel:transferability:CheckDomainTransferabilityResponse' :: Maybe DomainTransferability
transferability = Maybe DomainTransferability
a} :: CheckDomainTransferabilityResponse)

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

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