Qbusiness  >  Operations  >  stop_data_source_sync_job

stop_data_source_sync_job

Operation

stop_data_source_sync_job async

stop_data_source_sync_job(input: StopDataSourceSyncJobInput, plugins: list[Plugin] | None = None) -> StopDataSourceSyncJobOutput

Stops an Amazon Q Business data source connector synchronization job already in progress.

Parameters:

Name	Type	Description	Default
input	StopDataSourceSyncJobInput	An instance of StopDataSourceSyncJobInput.	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
StopDataSourceSyncJobOutput	An instance of StopDataSourceSyncJobOutput.

Input

StopDataSourceSyncJobInput dataclass

Dataclass for StopDataSourceSyncJobInput structure.

Attributes

application_id class-attribute instance-attribute

application_id: str | None = None

The identifier of the Amazon Q Business application that the data source is connected to.

data_source_id class-attribute instance-attribute

data_source_id: str | None = None

The identifier of the data source connector.

index_id class-attribute instance-attribute

index_id: str | None = None

The identifier of the index used with the Amazon Q Business data source connector.

Output

StopDataSourceSyncJobOutput dataclass

Dataclass for StopDataSourceSyncJobOutput structure.