{-# 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.Kendra.ClearQuerySuggestions
-- Copyright   : (c) 2013-2023 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
--
-- Clears existing query suggestions from an index.
--
-- This deletes existing suggestions only, not the queries in the query
-- log. After you clear suggestions, Amazon Kendra learns new suggestions
-- based on new queries added to the query log from the time you cleared
-- suggestions. If you do not see any new suggestions, then please allow
-- Amazon Kendra to collect enough queries to learn new suggestions.
--
-- @ClearQuerySuggestions@ is currently not supported in the Amazon Web
-- Services GovCloud (US-West) region.
module Amazonka.Kendra.ClearQuerySuggestions
  ( -- * Creating a Request
    ClearQuerySuggestions (..),
    newClearQuerySuggestions,

    -- * Request Lenses
    clearQuerySuggestions_indexId,

    -- * Destructuring the Response
    ClearQuerySuggestionsResponse (..),
    newClearQuerySuggestionsResponse,
  )
where

import qualified Amazonka.Core as Core
import qualified Amazonka.Core.Lens.Internal as Lens
import qualified Amazonka.Data as Data
import Amazonka.Kendra.Types
import qualified Amazonka.Prelude as Prelude
import qualified Amazonka.Request as Request
import qualified Amazonka.Response as Response

-- | /See:/ 'newClearQuerySuggestions' smart constructor.
data ClearQuerySuggestions = ClearQuerySuggestions'
  { -- | The identifier of the index you want to clear query suggestions from.
    ClearQuerySuggestions -> Text
indexId :: Prelude.Text
  }
  deriving (ClearQuerySuggestions -> ClearQuerySuggestions -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: ClearQuerySuggestions -> ClearQuerySuggestions -> Bool
$c/= :: ClearQuerySuggestions -> ClearQuerySuggestions -> Bool
== :: ClearQuerySuggestions -> ClearQuerySuggestions -> Bool
$c== :: ClearQuerySuggestions -> ClearQuerySuggestions -> Bool
Prelude.Eq, ReadPrec [ClearQuerySuggestions]
ReadPrec ClearQuerySuggestions
Int -> ReadS ClearQuerySuggestions
ReadS [ClearQuerySuggestions]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [ClearQuerySuggestions]
$creadListPrec :: ReadPrec [ClearQuerySuggestions]
readPrec :: ReadPrec ClearQuerySuggestions
$creadPrec :: ReadPrec ClearQuerySuggestions
readList :: ReadS [ClearQuerySuggestions]
$creadList :: ReadS [ClearQuerySuggestions]
readsPrec :: Int -> ReadS ClearQuerySuggestions
$creadsPrec :: Int -> ReadS ClearQuerySuggestions
Prelude.Read, Int -> ClearQuerySuggestions -> ShowS
[ClearQuerySuggestions] -> ShowS
ClearQuerySuggestions -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [ClearQuerySuggestions] -> ShowS
$cshowList :: [ClearQuerySuggestions] -> ShowS
show :: ClearQuerySuggestions -> String
$cshow :: ClearQuerySuggestions -> String
showsPrec :: Int -> ClearQuerySuggestions -> ShowS
$cshowsPrec :: Int -> ClearQuerySuggestions -> ShowS
Prelude.Show, forall x. Rep ClearQuerySuggestions x -> ClearQuerySuggestions
forall x. ClearQuerySuggestions -> Rep ClearQuerySuggestions x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep ClearQuerySuggestions x -> ClearQuerySuggestions
$cfrom :: forall x. ClearQuerySuggestions -> Rep ClearQuerySuggestions x
Prelude.Generic)

-- |
-- Create a value of 'ClearQuerySuggestions' 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:
--
-- 'indexId', 'clearQuerySuggestions_indexId' - The identifier of the index you want to clear query suggestions from.
newClearQuerySuggestions ::
  -- | 'indexId'
  Prelude.Text ->
  ClearQuerySuggestions
newClearQuerySuggestions :: Text -> ClearQuerySuggestions
newClearQuerySuggestions Text
pIndexId_ =
  ClearQuerySuggestions' {$sel:indexId:ClearQuerySuggestions' :: Text
indexId = Text
pIndexId_}

-- | The identifier of the index you want to clear query suggestions from.
clearQuerySuggestions_indexId :: Lens.Lens' ClearQuerySuggestions Prelude.Text
clearQuerySuggestions_indexId :: Lens' ClearQuerySuggestions Text
clearQuerySuggestions_indexId = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ClearQuerySuggestions' {Text
indexId :: Text
$sel:indexId:ClearQuerySuggestions' :: ClearQuerySuggestions -> Text
indexId} -> Text
indexId) (\s :: ClearQuerySuggestions
s@ClearQuerySuggestions' {} Text
a -> ClearQuerySuggestions
s {$sel:indexId:ClearQuerySuggestions' :: Text
indexId = Text
a} :: ClearQuerySuggestions)

instance Core.AWSRequest ClearQuerySuggestions where
  type
    AWSResponse ClearQuerySuggestions =
      ClearQuerySuggestionsResponse
  request :: (Service -> Service)
-> ClearQuerySuggestions -> Request ClearQuerySuggestions
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 ClearQuerySuggestions
-> ClientResponse ClientBody
-> m (Either
        Error (ClientResponse (AWSResponse ClearQuerySuggestions)))
response =
    forall (m :: * -> *) a.
MonadResource m =>
AWSResponse a
-> (ByteStringLazy -> IO ByteStringLazy)
-> Service
-> Proxy a
-> ClientResponse ClientBody
-> m (Either Error (ClientResponse (AWSResponse a)))
Response.receiveNull ClearQuerySuggestionsResponse
ClearQuerySuggestionsResponse'

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

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

instance Data.ToHeaders ClearQuerySuggestions where
  toHeaders :: ClearQuerySuggestions -> [Header]
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 -> [Header]
Data.=# ( ByteString
"AWSKendraFrontendService.ClearQuerySuggestions" ::
                          Prelude.ByteString
                      ),
            HeaderName
"Content-Type"
              forall a. ToHeader a => HeaderName -> a -> [Header]
Data.=# ( ByteString
"application/x-amz-json-1.1" ::
                          Prelude.ByteString
                      )
          ]
      )

instance Data.ToJSON ClearQuerySuggestions where
  toJSON :: ClearQuerySuggestions -> Value
toJSON ClearQuerySuggestions' {Text
indexId :: Text
$sel:indexId:ClearQuerySuggestions' :: ClearQuerySuggestions -> Text
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [forall a. a -> Maybe a
Prelude.Just (Key
"IndexId" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= Text
indexId)]
      )

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

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

-- | /See:/ 'newClearQuerySuggestionsResponse' smart constructor.
data ClearQuerySuggestionsResponse = ClearQuerySuggestionsResponse'
  {
  }
  deriving (ClearQuerySuggestionsResponse
-> ClearQuerySuggestionsResponse -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: ClearQuerySuggestionsResponse
-> ClearQuerySuggestionsResponse -> Bool
$c/= :: ClearQuerySuggestionsResponse
-> ClearQuerySuggestionsResponse -> Bool
== :: ClearQuerySuggestionsResponse
-> ClearQuerySuggestionsResponse -> Bool
$c== :: ClearQuerySuggestionsResponse
-> ClearQuerySuggestionsResponse -> Bool
Prelude.Eq, ReadPrec [ClearQuerySuggestionsResponse]
ReadPrec ClearQuerySuggestionsResponse
Int -> ReadS ClearQuerySuggestionsResponse
ReadS [ClearQuerySuggestionsResponse]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [ClearQuerySuggestionsResponse]
$creadListPrec :: ReadPrec [ClearQuerySuggestionsResponse]
readPrec :: ReadPrec ClearQuerySuggestionsResponse
$creadPrec :: ReadPrec ClearQuerySuggestionsResponse
readList :: ReadS [ClearQuerySuggestionsResponse]
$creadList :: ReadS [ClearQuerySuggestionsResponse]
readsPrec :: Int -> ReadS ClearQuerySuggestionsResponse
$creadsPrec :: Int -> ReadS ClearQuerySuggestionsResponse
Prelude.Read, Int -> ClearQuerySuggestionsResponse -> ShowS
[ClearQuerySuggestionsResponse] -> ShowS
ClearQuerySuggestionsResponse -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [ClearQuerySuggestionsResponse] -> ShowS
$cshowList :: [ClearQuerySuggestionsResponse] -> ShowS
show :: ClearQuerySuggestionsResponse -> String
$cshow :: ClearQuerySuggestionsResponse -> String
showsPrec :: Int -> ClearQuerySuggestionsResponse -> ShowS
$cshowsPrec :: Int -> ClearQuerySuggestionsResponse -> ShowS
Prelude.Show, forall x.
Rep ClearQuerySuggestionsResponse x
-> ClearQuerySuggestionsResponse
forall x.
ClearQuerySuggestionsResponse
-> Rep ClearQuerySuggestionsResponse x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x.
Rep ClearQuerySuggestionsResponse x
-> ClearQuerySuggestionsResponse
$cfrom :: forall x.
ClearQuerySuggestionsResponse
-> Rep ClearQuerySuggestionsResponse x
Prelude.Generic)

-- |
-- Create a value of 'ClearQuerySuggestionsResponse' 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.
newClearQuerySuggestionsResponse ::
  ClearQuerySuggestionsResponse
newClearQuerySuggestionsResponse :: ClearQuerySuggestionsResponse
newClearQuerySuggestionsResponse =
  ClearQuerySuggestionsResponse
ClearQuerySuggestionsResponse'

instance Prelude.NFData ClearQuerySuggestionsResponse where
  rnf :: ClearQuerySuggestionsResponse -> ()
rnf ClearQuerySuggestionsResponse
_ = ()