Skip to content

stop_ingestion_job

Operation

stop_ingestion_job

stop_ingestion_job(request: StopIngestionJobInput | StopIngestionJobInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[StopIngestionJobInputDict]) -> StopIngestionJobOutput

Stops a currently running data ingestion job. You can send a StartIngestionJob request again to ingest the rest of your data when you are ready.

Parameters:

Name Type Description Default
request StopIngestionJobInput | StopIngestionJobInputDict | 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[StopIngestionJobInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
StopIngestionJobOutput

An instance of StopIngestionJobOutput.

stop_ingestion_job async

stop_ingestion_job(request: StopIngestionJobInput | StopIngestionJobInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[StopIngestionJobInputDict]) -> StopIngestionJobOutput

Stops a currently running data ingestion job. You can send a StartIngestionJob request again to ingest the rest of your data when you are ready.

Parameters:

Name Type Description Default
request StopIngestionJobInput | StopIngestionJobInputDict | 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[StopIngestionJobInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
StopIngestionJobOutput

An instance of StopIngestionJobOutput.

Input

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

StopIngestionJobInputDict

Bases: TypedDict

Dictionary form of StopIngestionJobInput.

Attributes

data_source_id instance-attribute
data_source_id: Required[str]

The unique identifier of the data source for the data ingestion job you want to stop.

ingestion_job_id instance-attribute
ingestion_job_id: Required[str]

The unique identifier of the data ingestion job you want to stop.

knowledge_base_id instance-attribute
knowledge_base_id: Required[str]

The unique identifier of the knowledge base for the data ingestion job you want to stop.

StopIngestionJobInput dataclass

Bases: _SerdeShape

Dataclass for StopIngestionJobInput structure.

Attributes

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

The unique identifier of the data source for the data ingestion job you want to stop.

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

The unique identifier of the data ingestion job you want to stop.

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

The unique identifier of the knowledge base for the data ingestion job you want to stop.

Output

StopIngestionJobOutput dataclass

Bases: _SerdeShape

Dataclass for StopIngestionJobOutput structure.

Attributes

ingestion_job instance-attribute
ingestion_job: IngestionJob

Contains information about the stopped data ingestion job.

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.