{-# 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.CloudSearch.DefineSuggester
-- Copyright   : (c) 2013-2023 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
--
-- Configures a suggester for a domain. A suggester enables you to display
-- possible matches before users finish typing their queries. When you
-- configure a suggester, you must specify the name of the text field you
-- want to search for possible matches and a unique name for the suggester.
-- For more information, see
-- <http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-suggestions.html Getting Search Suggestions>
-- in the /Amazon CloudSearch Developer Guide/.
module Amazonka.CloudSearch.DefineSuggester
  ( -- * Creating a Request
    DefineSuggester (..),
    newDefineSuggester,

    -- * Request Lenses
    defineSuggester_domainName,
    defineSuggester_suggester,

    -- * Destructuring the Response
    DefineSuggesterResponse (..),
    newDefineSuggesterResponse,

    -- * Response Lenses
    defineSuggesterResponse_httpStatus,
    defineSuggesterResponse_suggester,
  )
where

import Amazonka.CloudSearch.Types
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

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

-- |
-- Create a value of 'DefineSuggester' 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', 'defineSuggester_domainName' - Undocumented member.
--
-- 'suggester', 'defineSuggester_suggester' - Undocumented member.
newDefineSuggester ::
  -- | 'domainName'
  Prelude.Text ->
  -- | 'suggester'
  Suggester ->
  DefineSuggester
newDefineSuggester :: Text -> Suggester -> DefineSuggester
newDefineSuggester Text
pDomainName_ Suggester
pSuggester_ =
  DefineSuggester'
    { $sel:domainName:DefineSuggester' :: Text
domainName = Text
pDomainName_,
      $sel:suggester:DefineSuggester' :: Suggester
suggester = Suggester
pSuggester_
    }

-- | Undocumented member.
defineSuggester_domainName :: Lens.Lens' DefineSuggester Prelude.Text
defineSuggester_domainName :: Lens' DefineSuggester Text
defineSuggester_domainName = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DefineSuggester' {Text
domainName :: Text
$sel:domainName:DefineSuggester' :: DefineSuggester -> Text
domainName} -> Text
domainName) (\s :: DefineSuggester
s@DefineSuggester' {} Text
a -> DefineSuggester
s {$sel:domainName:DefineSuggester' :: Text
domainName = Text
a} :: DefineSuggester)

-- | Undocumented member.
defineSuggester_suggester :: Lens.Lens' DefineSuggester Suggester
defineSuggester_suggester :: Lens' DefineSuggester Suggester
defineSuggester_suggester = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DefineSuggester' {Suggester
suggester :: Suggester
$sel:suggester:DefineSuggester' :: DefineSuggester -> Suggester
suggester} -> Suggester
suggester) (\s :: DefineSuggester
s@DefineSuggester' {} Suggester
a -> DefineSuggester
s {$sel:suggester:DefineSuggester' :: Suggester
suggester = Suggester
a} :: DefineSuggester)

instance Core.AWSRequest DefineSuggester where
  type
    AWSResponse DefineSuggester =
      DefineSuggesterResponse
  request :: (Service -> Service) -> DefineSuggester -> Request DefineSuggester
request Service -> Service
overrides =
    forall a. ToRequest a => Service -> a -> Request a
Request.postQuery (Service -> Service
overrides Service
defaultService)
  response :: forall (m :: * -> *).
MonadResource m =>
(ByteStringLazy -> IO ByteStringLazy)
-> Service
-> Proxy DefineSuggester
-> ClientResponse ClientBody
-> m (Either Error (ClientResponse (AWSResponse DefineSuggester)))
response =
    forall (m :: * -> *) a.
MonadResource m =>
Text
-> (Int
    -> ResponseHeaders -> [Node] -> Either String (AWSResponse a))
-> (ByteStringLazy -> IO ByteStringLazy)
-> Service
-> Proxy a
-> ClientResponse ClientBody
-> m (Either Error (ClientResponse (AWSResponse a)))
Response.receiveXMLWrapper
      Text
"DefineSuggesterResult"
      ( \Int
s ResponseHeaders
h [Node]
x ->
          Int -> SuggesterStatus -> DefineSuggesterResponse
DefineSuggesterResponse'
            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.<*> ([Node]
x forall a. FromXML a => [Node] -> Text -> Either String a
Data..@ Text
"Suggester")
      )

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

instance Prelude.NFData DefineSuggester where
  rnf :: DefineSuggester -> ()
rnf DefineSuggester' {Text
Suggester
suggester :: Suggester
domainName :: Text
$sel:suggester:DefineSuggester' :: DefineSuggester -> Suggester
$sel:domainName:DefineSuggester' :: DefineSuggester -> Text
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Text
domainName
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Suggester
suggester

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

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

instance Data.ToQuery DefineSuggester where
  toQuery :: DefineSuggester -> QueryString
toQuery DefineSuggester' {Text
Suggester
suggester :: Suggester
domainName :: Text
$sel:suggester:DefineSuggester' :: DefineSuggester -> Suggester
$sel:domainName:DefineSuggester' :: DefineSuggester -> Text
..} =
    forall a. Monoid a => [a] -> a
Prelude.mconcat
      [ ByteString
"Action"
          forall a. ToQuery a => ByteString -> a -> QueryString
Data.=: (ByteString
"DefineSuggester" :: Prelude.ByteString),
        ByteString
"Version"
          forall a. ToQuery a => ByteString -> a -> QueryString
Data.=: (ByteString
"2013-01-01" :: Prelude.ByteString),
        ByteString
"DomainName" forall a. ToQuery a => ByteString -> a -> QueryString
Data.=: Text
domainName,
        ByteString
"Suggester" forall a. ToQuery a => ByteString -> a -> QueryString
Data.=: Suggester
suggester
      ]

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

-- |
-- Create a value of 'DefineSuggesterResponse' 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', 'defineSuggesterResponse_httpStatus' - The response's http status code.
--
-- 'suggester', 'defineSuggesterResponse_suggester' - Undocumented member.
newDefineSuggesterResponse ::
  -- | 'httpStatus'
  Prelude.Int ->
  -- | 'suggester'
  SuggesterStatus ->
  DefineSuggesterResponse
newDefineSuggesterResponse :: Int -> SuggesterStatus -> DefineSuggesterResponse
newDefineSuggesterResponse Int
pHttpStatus_ SuggesterStatus
pSuggester_ =
  DefineSuggesterResponse'
    { $sel:httpStatus:DefineSuggesterResponse' :: Int
httpStatus = Int
pHttpStatus_,
      $sel:suggester:DefineSuggesterResponse' :: SuggesterStatus
suggester = SuggesterStatus
pSuggester_
    }

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

-- | Undocumented member.
defineSuggesterResponse_suggester :: Lens.Lens' DefineSuggesterResponse SuggesterStatus
defineSuggesterResponse_suggester :: Lens' DefineSuggesterResponse SuggesterStatus
defineSuggesterResponse_suggester = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DefineSuggesterResponse' {SuggesterStatus
suggester :: SuggesterStatus
$sel:suggester:DefineSuggesterResponse' :: DefineSuggesterResponse -> SuggesterStatus
suggester} -> SuggesterStatus
suggester) (\s :: DefineSuggesterResponse
s@DefineSuggesterResponse' {} SuggesterStatus
a -> DefineSuggesterResponse
s {$sel:suggester:DefineSuggesterResponse' :: SuggesterStatus
suggester = SuggesterStatus
a} :: DefineSuggesterResponse)

instance Prelude.NFData DefineSuggesterResponse where
  rnf :: DefineSuggesterResponse -> ()
rnf DefineSuggesterResponse' {Int
SuggesterStatus
suggester :: SuggesterStatus
httpStatus :: Int
$sel:suggester:DefineSuggesterResponse' :: DefineSuggesterResponse -> SuggesterStatus
$sel:httpStatus:DefineSuggesterResponse' :: DefineSuggesterResponse -> 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 SuggesterStatus
suggester