Skip to content

stop_data_source_sync_job

Operation

stop_data_source_sync_job

stop_data_source_sync_job(request: StopDataSourceSyncJobInput | StopDataSourceSyncJobInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[StopDataSourceSyncJobInputDict]) -> StopDataSourceSyncJobOutput

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

Parameters:

Name Type Description Default
request StopDataSourceSyncJobInput | StopDataSourceSyncJobInputDict | 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[StopDataSourceSyncJobInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
StopDataSourceSyncJobOutput

An instance of StopDataSourceSyncJobOutput.

stop_data_source_sync_job async

stop_data_source_sync_job(request: StopDataSourceSyncJobInput | StopDataSourceSyncJobInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[StopDataSourceSyncJobInputDict]) -> StopDataSourceSyncJobOutput

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

Parameters:

Name Type Description Default
request StopDataSourceSyncJobInput | StopDataSourceSyncJobInputDict | 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[StopDataSourceSyncJobInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
StopDataSourceSyncJobOutput

An instance of StopDataSourceSyncJobOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

StopDataSourceSyncJobInputDict

Bases: TypedDict

Dictionary form of StopDataSourceSyncJobInput.

Attributes

application_id instance-attribute
application_id: Required[str]

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

data_source_id instance-attribute
data_source_id: Required[str]

The identifier of the data source connector.

index_id instance-attribute
index_id: Required[str]

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

StopDataSourceSyncJobInput dataclass

Bases: _SerdeShape

Dataclass for StopDataSourceSyncJobInput structure.

Attributes

application_id class-attribute instance-attribute
application_id: str | 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 = ...

The identifier of the data source connector.

index_id class-attribute instance-attribute
index_id: str | None = ...

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

Output

StopDataSourceSyncJobOutput dataclass

Bases: _SerdeShape

Dataclass for StopDataSourceSyncJobOutput structure.

Attributes

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

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.