Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Kendra.StartDataSourceSyncJob

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Starts a synchronization job for a data source connector. If a synchronization job is already in progress, Amazon Kendra returns a ResourceInUseException exception.

Creating a Request

data StartDataSourceSyncJob Source #

See: newStartDataSourceSyncJob smart constructor.

Constructors

StartDataSourceSyncJob'
Fields id :: Text The identifier of the data source connector to synchronize. indexId :: Text The identifier of the index used with the data source connector.

Instances

Instances details

ToJSON StartDataSourceSyncJob Source #
Instance details Defined in Amazonka.Kendra.StartDataSourceSyncJob Methods toJSON :: StartDataSourceSyncJob -> Value # toEncoding :: StartDataSourceSyncJob -> Encoding # toJSONList :: [StartDataSourceSyncJob] -> Value # toEncodingList :: [StartDataSourceSyncJob] -> Encoding #
ToHeaders StartDataSourceSyncJob Source #
Instance details Defined in Amazonka.Kendra.StartDataSourceSyncJob Methods toHeaders :: StartDataSourceSyncJob -> [Header] #
ToPath StartDataSourceSyncJob Source #
Instance details Defined in Amazonka.Kendra.StartDataSourceSyncJob Methods toPath :: StartDataSourceSyncJob -> ByteString #
ToQuery StartDataSourceSyncJob Source #
Instance details Defined in Amazonka.Kendra.StartDataSourceSyncJob Methods toQuery :: StartDataSourceSyncJob -> QueryString #
AWSRequest StartDataSourceSyncJob Source #
Instance details Defined in Amazonka.Kendra.StartDataSourceSyncJob Associated Types type AWSResponse StartDataSourceSyncJob # Methods request :: (Service -> Service) -> StartDataSourceSyncJob -> Request StartDataSourceSyncJob # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy StartDataSourceSyncJob -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse StartDataSourceSyncJob))) #
Generic StartDataSourceSyncJob Source #
Instance details Defined in Amazonka.Kendra.StartDataSourceSyncJob Associated Types type Rep StartDataSourceSyncJob :: Type -> Type # Methods from :: StartDataSourceSyncJob -> Rep StartDataSourceSyncJob x # to :: Rep StartDataSourceSyncJob x -> StartDataSourceSyncJob #
Read StartDataSourceSyncJob Source #
Instance details Defined in Amazonka.Kendra.StartDataSourceSyncJob Methods readsPrec :: Int -> ReadS StartDataSourceSyncJob # readList :: ReadS [StartDataSourceSyncJob] # readPrec :: ReadPrec StartDataSourceSyncJob # readListPrec :: ReadPrec [StartDataSourceSyncJob] #
Show StartDataSourceSyncJob Source #
Instance details Defined in Amazonka.Kendra.StartDataSourceSyncJob Methods showsPrec :: Int -> StartDataSourceSyncJob -> ShowS # show :: StartDataSourceSyncJob -> String # showList :: [StartDataSourceSyncJob] -> ShowS #
NFData StartDataSourceSyncJob Source #
Instance details Defined in Amazonka.Kendra.StartDataSourceSyncJob Methods rnf :: StartDataSourceSyncJob -> () #
Eq StartDataSourceSyncJob Source #
Instance details Defined in Amazonka.Kendra.StartDataSourceSyncJob Methods (==) :: StartDataSourceSyncJob -> StartDataSourceSyncJob -> Bool # (/=) :: StartDataSourceSyncJob -> StartDataSourceSyncJob -> Bool #
Hashable StartDataSourceSyncJob Source #
Instance details Defined in Amazonka.Kendra.StartDataSourceSyncJob Methods hashWithSalt :: Int -> StartDataSourceSyncJob -> Int # hash :: StartDataSourceSyncJob -> Int #
type AWSResponse StartDataSourceSyncJob Source #
Instance details Defined in Amazonka.Kendra.StartDataSourceSyncJob type AWSResponse StartDataSourceSyncJob = StartDataSourceSyncJobResponse
type Rep StartDataSourceSyncJob Source #
Instance details Defined in Amazonka.Kendra.StartDataSourceSyncJob type Rep StartDataSourceSyncJob = D1 ('MetaData "StartDataSourceSyncJob" "Amazonka.Kendra.StartDataSourceSyncJob" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "StartDataSourceSyncJob'" 'PrefixI 'True) (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "indexId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newStartDataSourceSyncJob Source #

Arguments

:: Text	`StartDataSourceSyncJob`
-> Text	`$sel:indexId:StartDataSourceSyncJob'`
-> StartDataSourceSyncJob

Create a value of StartDataSourceSyncJob with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

StartDataSourceSyncJob, startDataSourceSyncJob_id - The identifier of the data source connector to synchronize.

$sel:indexId:StartDataSourceSyncJob', startDataSourceSyncJob_indexId - The identifier of the index used with the data source connector.

Request Lenses

startDataSourceSyncJob_id :: Lens' StartDataSourceSyncJob Text Source #

The identifier of the data source connector to synchronize.

startDataSourceSyncJob_indexId :: Lens' StartDataSourceSyncJob Text Source #

The identifier of the index used with the data source connector.

Destructuring the Response

data StartDataSourceSyncJobResponse Source #

See: newStartDataSourceSyncJobResponse smart constructor.

Constructors

StartDataSourceSyncJobResponse'
Fields executionId :: Maybe Text Identifies a particular synchronization job. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic StartDataSourceSyncJobResponse Source #
Instance details Defined in Amazonka.Kendra.StartDataSourceSyncJob Associated Types type Rep StartDataSourceSyncJobResponse :: Type -> Type # Methods from :: StartDataSourceSyncJobResponse -> Rep StartDataSourceSyncJobResponse x # to :: Rep StartDataSourceSyncJobResponse x -> StartDataSourceSyncJobResponse #
Read StartDataSourceSyncJobResponse Source #
Instance details Defined in Amazonka.Kendra.StartDataSourceSyncJob Methods readsPrec :: Int -> ReadS StartDataSourceSyncJobResponse # readList :: ReadS [StartDataSourceSyncJobResponse] # readPrec :: ReadPrec StartDataSourceSyncJobResponse # readListPrec :: ReadPrec [StartDataSourceSyncJobResponse] #
Show StartDataSourceSyncJobResponse Source #
Instance details Defined in Amazonka.Kendra.StartDataSourceSyncJob Methods showsPrec :: Int -> StartDataSourceSyncJobResponse -> ShowS # show :: StartDataSourceSyncJobResponse -> String # showList :: [StartDataSourceSyncJobResponse] -> ShowS #
NFData StartDataSourceSyncJobResponse Source #
Instance details Defined in Amazonka.Kendra.StartDataSourceSyncJob Methods rnf :: StartDataSourceSyncJobResponse -> () #
Eq StartDataSourceSyncJobResponse Source #
Instance details Defined in Amazonka.Kendra.StartDataSourceSyncJob Methods (==) :: StartDataSourceSyncJobResponse -> StartDataSourceSyncJobResponse -> Bool # (/=) :: StartDataSourceSyncJobResponse -> StartDataSourceSyncJobResponse -> Bool #
type Rep StartDataSourceSyncJobResponse Source #
Instance details Defined in Amazonka.Kendra.StartDataSourceSyncJob type Rep StartDataSourceSyncJobResponse = D1 ('MetaData "StartDataSourceSyncJobResponse" "Amazonka.Kendra.StartDataSourceSyncJob" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "StartDataSourceSyncJobResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "executionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newStartDataSourceSyncJobResponse Source #

Arguments

:: Int	`$sel:httpStatus:StartDataSourceSyncJobResponse'`
-> StartDataSourceSyncJobResponse

Create a value of StartDataSourceSyncJobResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

StartDataSourceSyncJobResponse, startDataSourceSyncJobResponse_executionId - Identifies a particular synchronization job.

$sel:httpStatus:StartDataSourceSyncJobResponse', startDataSourceSyncJobResponse_httpStatus - The response's http status code.

Response Lenses

startDataSourceSyncJobResponse_executionId :: Lens' StartDataSourceSyncJobResponse (Maybe Text) Source #

Identifies a particular synchronization job.

startDataSourceSyncJobResponse_httpStatus :: Lens' StartDataSourceSyncJobResponse Int Source #

The response's http status code.