Skip to content

start_ingestion_job

Operation

start_ingestion_job

start_ingestion_job(request: StartIngestionJobInput | StartIngestionJobInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[StartIngestionJobInputDict]) -> 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
request StartIngestionJobInput | StartIngestionJobInputDict | 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[StartIngestionJobInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
StartIngestionJobOutput

An instance of StartIngestionJobOutput.

start_ingestion_job async

start_ingestion_job(request: StartIngestionJobInput | StartIngestionJobInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[StartIngestionJobInputDict]) -> 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
request StartIngestionJobInput | StartIngestionJobInputDict | 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[StartIngestionJobInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
StartIngestionJobOutput

An instance of StartIngestionJobOutput.

Input

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

StartIngestionJobInputDict

Bases: TypedDict

Dictionary form of StartIngestionJobInput.

Attributes

client_token instance-attribute
client_token: str | 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.

This field is autopopulated if not provided.

data_source_id instance-attribute
data_source_id: Required[str]

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

description instance-attribute
description: str | None

A description of the data ingestion job.

knowledge_base_id instance-attribute
knowledge_base_id: Required[str]

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

StartIngestionJobInput dataclass

Bases: _SerdeShape

Dataclass for StartIngestionJobInput structure.

Attributes

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

This field is autopopulated if not provided.

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

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

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

A description of the data ingestion job.

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

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

Output

StartIngestionJobOutput dataclass

Bases: _SerdeShape

Dataclass for StartIngestionJobOutput structure.

Attributes

ingestion_job instance-attribute
ingestion_job: IngestionJob

Contains information about the 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.