{-# 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.StartDataSourceSyncJob
-- Copyright   : (c) 2013-2023 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
--
-- Starts a synchronization job for a data source connector. If a
-- synchronization job is already in progress, Amazon Kendra returns a
-- @ResourceInUseException@ exception.
module Amazonka.Kendra.StartDataSourceSyncJob
  ( -- * Creating a Request
    StartDataSourceSyncJob (..),
    newStartDataSourceSyncJob,

    -- * Request Lenses
    startDataSourceSyncJob_id,
    startDataSourceSyncJob_indexId,

    -- * Destructuring the Response
    StartDataSourceSyncJobResponse (..),
    newStartDataSourceSyncJobResponse,

    -- * Response Lenses
    startDataSourceSyncJobResponse_executionId,
    startDataSourceSyncJobResponse_httpStatus,
  )
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:/ 'newStartDataSourceSyncJob' smart constructor.
data StartDataSourceSyncJob = StartDataSourceSyncJob'
  { -- | The identifier of the data source connector to synchronize.
    StartDataSourceSyncJob -> Text
id :: Prelude.Text,
    -- | The identifier of the index used with the data source connector.
    StartDataSourceSyncJob -> Text
indexId :: Prelude.Text
  }
  deriving (StartDataSourceSyncJob -> StartDataSourceSyncJob -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: StartDataSourceSyncJob -> StartDataSourceSyncJob -> Bool
$c/= :: StartDataSourceSyncJob -> StartDataSourceSyncJob -> Bool
== :: StartDataSourceSyncJob -> StartDataSourceSyncJob -> Bool
$c== :: StartDataSourceSyncJob -> StartDataSourceSyncJob -> Bool
Prelude.Eq, ReadPrec [StartDataSourceSyncJob]
ReadPrec StartDataSourceSyncJob
Int -> ReadS StartDataSourceSyncJob
ReadS [StartDataSourceSyncJob]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [StartDataSourceSyncJob]
$creadListPrec :: ReadPrec [StartDataSourceSyncJob]
readPrec :: ReadPrec StartDataSourceSyncJob
$creadPrec :: ReadPrec StartDataSourceSyncJob
readList :: ReadS [StartDataSourceSyncJob]
$creadList :: ReadS [StartDataSourceSyncJob]
readsPrec :: Int -> ReadS StartDataSourceSyncJob
$creadsPrec :: Int -> ReadS StartDataSourceSyncJob
Prelude.Read, Int -> StartDataSourceSyncJob -> ShowS
[StartDataSourceSyncJob] -> ShowS
StartDataSourceSyncJob -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [StartDataSourceSyncJob] -> ShowS
$cshowList :: [StartDataSourceSyncJob] -> ShowS
show :: StartDataSourceSyncJob -> String
$cshow :: StartDataSourceSyncJob -> String
showsPrec :: Int -> StartDataSourceSyncJob -> ShowS
$cshowsPrec :: Int -> StartDataSourceSyncJob -> ShowS
Prelude.Show, forall x. Rep StartDataSourceSyncJob x -> StartDataSourceSyncJob
forall x. StartDataSourceSyncJob -> Rep StartDataSourceSyncJob x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep StartDataSourceSyncJob x -> StartDataSourceSyncJob
$cfrom :: forall x. StartDataSourceSyncJob -> Rep StartDataSourceSyncJob x
Prelude.Generic)

-- |
-- Create a value of 'StartDataSourceSyncJob' 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:
--
-- 'id', 'startDataSourceSyncJob_id' - The identifier of the data source connector to synchronize.
--
-- 'indexId', 'startDataSourceSyncJob_indexId' - The identifier of the index used with the data source connector.
newStartDataSourceSyncJob ::
  -- | 'id'
  Prelude.Text ->
  -- | 'indexId'
  Prelude.Text ->
  StartDataSourceSyncJob
newStartDataSourceSyncJob :: Text -> Text -> StartDataSourceSyncJob
newStartDataSourceSyncJob Text
pId_ Text
pIndexId_ =
  StartDataSourceSyncJob'
    { $sel:id:StartDataSourceSyncJob' :: Text
id = Text
pId_,
      $sel:indexId:StartDataSourceSyncJob' :: Text
indexId = Text
pIndexId_
    }

-- | The identifier of the data source connector to synchronize.
startDataSourceSyncJob_id :: Lens.Lens' StartDataSourceSyncJob Prelude.Text
startDataSourceSyncJob_id :: Lens' StartDataSourceSyncJob Text
startDataSourceSyncJob_id = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\StartDataSourceSyncJob' {Text
id :: Text
$sel:id:StartDataSourceSyncJob' :: StartDataSourceSyncJob -> Text
id} -> Text
id) (\s :: StartDataSourceSyncJob
s@StartDataSourceSyncJob' {} Text
a -> StartDataSourceSyncJob
s {$sel:id:StartDataSourceSyncJob' :: Text
id = Text
a} :: StartDataSourceSyncJob)

-- | The identifier of the index used with the data source connector.
startDataSourceSyncJob_indexId :: Lens.Lens' StartDataSourceSyncJob Prelude.Text
startDataSourceSyncJob_indexId :: Lens' StartDataSourceSyncJob Text
startDataSourceSyncJob_indexId = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\StartDataSourceSyncJob' {Text
indexId :: Text
$sel:indexId:StartDataSourceSyncJob' :: StartDataSourceSyncJob -> Text
indexId} -> Text
indexId) (\s :: StartDataSourceSyncJob
s@StartDataSourceSyncJob' {} Text
a -> StartDataSourceSyncJob
s {$sel:indexId:StartDataSourceSyncJob' :: Text
indexId = Text
a} :: StartDataSourceSyncJob)

instance Core.AWSRequest StartDataSourceSyncJob where
  type
    AWSResponse StartDataSourceSyncJob =
      StartDataSourceSyncJobResponse
  request :: (Service -> Service)
-> StartDataSourceSyncJob -> Request StartDataSourceSyncJob
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 StartDataSourceSyncJob
-> ClientResponse ClientBody
-> m (Either
        Error (ClientResponse (AWSResponse StartDataSourceSyncJob)))
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 Text -> Int -> StartDataSourceSyncJobResponse
StartDataSourceSyncJobResponse'
            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
"ExecutionId")
            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 StartDataSourceSyncJob where
  hashWithSalt :: Int -> StartDataSourceSyncJob -> Int
hashWithSalt Int
_salt StartDataSourceSyncJob' {Text
indexId :: Text
id :: Text
$sel:indexId:StartDataSourceSyncJob' :: StartDataSourceSyncJob -> Text
$sel:id:StartDataSourceSyncJob' :: StartDataSourceSyncJob -> Text
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Text
id
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Text
indexId

instance Prelude.NFData StartDataSourceSyncJob where
  rnf :: StartDataSourceSyncJob -> ()
rnf StartDataSourceSyncJob' {Text
indexId :: Text
id :: Text
$sel:indexId:StartDataSourceSyncJob' :: StartDataSourceSyncJob -> Text
$sel:id:StartDataSourceSyncJob' :: StartDataSourceSyncJob -> Text
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Text
id seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Text
indexId

instance Data.ToHeaders StartDataSourceSyncJob where
  toHeaders :: StartDataSourceSyncJob -> 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
"AWSKendraFrontendService.StartDataSourceSyncJob" ::
                          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 StartDataSourceSyncJob where
  toJSON :: StartDataSourceSyncJob -> Value
toJSON StartDataSourceSyncJob' {Text
indexId :: Text
id :: Text
$sel:indexId:StartDataSourceSyncJob' :: StartDataSourceSyncJob -> Text
$sel:id:StartDataSourceSyncJob' :: StartDataSourceSyncJob -> Text
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ forall a. a -> Maybe a
Prelude.Just (Key
"Id" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= Text
id),
            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 StartDataSourceSyncJob where
  toPath :: StartDataSourceSyncJob -> ByteString
toPath = forall a b. a -> b -> a
Prelude.const ByteString
"/"

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

-- | /See:/ 'newStartDataSourceSyncJobResponse' smart constructor.
data StartDataSourceSyncJobResponse = StartDataSourceSyncJobResponse'
  { -- | Identifies a particular synchronization job.
    StartDataSourceSyncJobResponse -> Maybe Text
executionId :: Prelude.Maybe Prelude.Text,
    -- | The response's http status code.
    StartDataSourceSyncJobResponse -> Int
httpStatus :: Prelude.Int
  }
  deriving (StartDataSourceSyncJobResponse
-> StartDataSourceSyncJobResponse -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: StartDataSourceSyncJobResponse
-> StartDataSourceSyncJobResponse -> Bool
$c/= :: StartDataSourceSyncJobResponse
-> StartDataSourceSyncJobResponse -> Bool
== :: StartDataSourceSyncJobResponse
-> StartDataSourceSyncJobResponse -> Bool
$c== :: StartDataSourceSyncJobResponse
-> StartDataSourceSyncJobResponse -> Bool
Prelude.Eq, ReadPrec [StartDataSourceSyncJobResponse]
ReadPrec StartDataSourceSyncJobResponse
Int -> ReadS StartDataSourceSyncJobResponse
ReadS [StartDataSourceSyncJobResponse]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [StartDataSourceSyncJobResponse]
$creadListPrec :: ReadPrec [StartDataSourceSyncJobResponse]
readPrec :: ReadPrec StartDataSourceSyncJobResponse
$creadPrec :: ReadPrec StartDataSourceSyncJobResponse
readList :: ReadS [StartDataSourceSyncJobResponse]
$creadList :: ReadS [StartDataSourceSyncJobResponse]
readsPrec :: Int -> ReadS StartDataSourceSyncJobResponse
$creadsPrec :: Int -> ReadS StartDataSourceSyncJobResponse
Prelude.Read, Int -> StartDataSourceSyncJobResponse -> ShowS
[StartDataSourceSyncJobResponse] -> ShowS
StartDataSourceSyncJobResponse -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [StartDataSourceSyncJobResponse] -> ShowS
$cshowList :: [StartDataSourceSyncJobResponse] -> ShowS
show :: StartDataSourceSyncJobResponse -> String
$cshow :: StartDataSourceSyncJobResponse -> String
showsPrec :: Int -> StartDataSourceSyncJobResponse -> ShowS
$cshowsPrec :: Int -> StartDataSourceSyncJobResponse -> ShowS
Prelude.Show, forall x.
Rep StartDataSourceSyncJobResponse x
-> StartDataSourceSyncJobResponse
forall x.
StartDataSourceSyncJobResponse
-> Rep StartDataSourceSyncJobResponse x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x.
Rep StartDataSourceSyncJobResponse x
-> StartDataSourceSyncJobResponse
$cfrom :: forall x.
StartDataSourceSyncJobResponse
-> Rep StartDataSourceSyncJobResponse x
Prelude.Generic)

-- |
-- Create a value of 'StartDataSourceSyncJobResponse' 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:
--
-- 'executionId', 'startDataSourceSyncJobResponse_executionId' - Identifies a particular synchronization job.
--
-- 'httpStatus', 'startDataSourceSyncJobResponse_httpStatus' - The response's http status code.
newStartDataSourceSyncJobResponse ::
  -- | 'httpStatus'
  Prelude.Int ->
  StartDataSourceSyncJobResponse
newStartDataSourceSyncJobResponse :: Int -> StartDataSourceSyncJobResponse
newStartDataSourceSyncJobResponse Int
pHttpStatus_ =
  StartDataSourceSyncJobResponse'
    { $sel:executionId:StartDataSourceSyncJobResponse' :: Maybe Text
executionId =
        forall a. Maybe a
Prelude.Nothing,
      $sel:httpStatus:StartDataSourceSyncJobResponse' :: Int
httpStatus = Int
pHttpStatus_
    }

-- | Identifies a particular synchronization job.
startDataSourceSyncJobResponse_executionId :: Lens.Lens' StartDataSourceSyncJobResponse (Prelude.Maybe Prelude.Text)
startDataSourceSyncJobResponse_executionId :: Lens' StartDataSourceSyncJobResponse (Maybe Text)
startDataSourceSyncJobResponse_executionId = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\StartDataSourceSyncJobResponse' {Maybe Text
executionId :: Maybe Text
$sel:executionId:StartDataSourceSyncJobResponse' :: StartDataSourceSyncJobResponse -> Maybe Text
executionId} -> Maybe Text
executionId) (\s :: StartDataSourceSyncJobResponse
s@StartDataSourceSyncJobResponse' {} Maybe Text
a -> StartDataSourceSyncJobResponse
s {$sel:executionId:StartDataSourceSyncJobResponse' :: Maybe Text
executionId = Maybe Text
a} :: StartDataSourceSyncJobResponse)

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

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