start_data_source_sync_job¶
Operation¶
start_data_source_sync_job
¶
start_data_source_sync_job(request: StartDataSourceSyncJobInput | StartDataSourceSyncJobInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[StartDataSourceSyncJobInputDict]) -> 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 |
|---|---|---|---|
request
|
StartDataSourceSyncJobInput | StartDataSourceSyncJobInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
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
|
**kwargs
|
Unpack[StartDataSourceSyncJobInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
StartDataSourceSyncJobOutput
|
An instance of |
start_data_source_sync_job
async
¶
start_data_source_sync_job(request: StartDataSourceSyncJobInput | StartDataSourceSyncJobInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[StartDataSourceSyncJobInputDict]) -> 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 |
|---|---|---|---|
request
|
StartDataSourceSyncJobInput | StartDataSourceSyncJobInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
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
|
**kwargs
|
Unpack[StartDataSourceSyncJobInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
StartDataSourceSyncJobOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
StartDataSourceSyncJobInputDict
¶
StartDataSourceSyncJobInput
dataclass
¶
Bases: _SerdeShape
Dataclass for StartDataSourceSyncJobInput structure.
Attributes¶
application_id
class-attribute
instance-attribute
¶
application_id: str | None = ...
The identifier of Amazon Q Business application the data source is connected to.
Output¶
StartDataSourceSyncJobOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for StartDataSourceSyncJobOutput structure.
Attributes¶
execution_id
class-attribute
instance-attribute
¶
execution_id: str | None = ...
The identifier for a particular synchronization job.
response_metadata
class-attribute
instance-attribute
¶
Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.