Bedrock Agent  >  Operations  >  start_ingestion_job

start_ingestion_job

Operation

start_ingestion_job async

start_ingestion_job(input: StartIngestionJobInput, plugins: list[Plugin] | None = None) -> StartIngestionJobOutput

Begins a data ingestion job. Data sources are ingested into your knowledge base so that Large Language Models (LLMs) can use your data.

Parameters:

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

Input

StartIngestionJobInput dataclass

Dataclass for StartIngestionJobInput structure.

Attributes

client_token class-attribute instance-attribute

client_token: str | None = None

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.

data_source_id class-attribute instance-attribute

data_source_id: str | None = None

The unique identifier of the data source you want to ingest into your knowledge base.

description class-attribute instance-attribute

description: str | None = None

A description of the data ingestion job.

knowledge_base_id class-attribute instance-attribute

knowledge_base_id: str | None = None

The unique identifier of the knowledge base for the data ingestion job.

Output

StartIngestionJobOutput dataclass

Dataclass for StartIngestionJobOutput structure.

Attributes

ingestion_job instance-attribute

ingestion_job: IngestionJob

Contains information about the data ingestion job.