start_data_source_sync_job¶
Operation¶
async
¶
start_data_source_sync_job(input: StartDataSourceSyncJobInput, plugins: list[Plugin] | None = None) -> StartDataSourceSyncJobOutput
Starts a data source connector synchronization job. If a synchronization
job is already in progress, Amazon Q Business returns a
ConflictException.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
StartDataSourceSyncJobInput
|
An instance of |
required |
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
Returns:
| Type | Description |
|---|---|
StartDataSourceSyncJobOutput
|
An instance of |
Input¶
dataclass
¶
Dataclass for StartDataSourceSyncJobInput structure.
Attributes¶
class-attribute
instance-attribute
¶
application_id: str | None = None
The identifier of Amazon Q Business application the data source is connected to.
class-attribute
instance-attribute
¶
data_source_id: str | None = None
The identifier of the data source connector.
class-attribute
instance-attribute
¶
index_id: str | None = None
The identifier of the index used with the data source connector.