Skip to content

Bedrock Agent  >  Operations  >  list_ingestion_jobs

list_ingestion_jobs

Operation

list_ingestion_jobs async 

list_ingestion_jobs(input: ListIngestionJobsInput, plugins: list[Plugin] | None = None) -> ListIngestionJobsOutput

Lists the data ingestion jobs for a data source. The list also includes information about each job.

Parameters:

Name Type Description Default
input ListIngestionJobsInput

An instance of ListIngestionJobsInput.

 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
ListIngestionJobsOutput

An instance of ListIngestionJobsOutput.

Input

ListIngestionJobsInput dataclass

Dataclass for ListIngestionJobsInput structure.

Attributes

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

The unique identifier of the data source for the list of data ingestion jobs.

filters class-attribute instance-attribute 
filters: list[IngestionJobFilter] | None = None

Contains information about the filters for filtering the data.

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

The unique identifier of the knowledge base for the list of data ingestion jobs.

max_results class-attribute instance-attribute 
max_results: int | None = None

The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.

next_token class-attribute instance-attribute 
next_token: str | None = None

If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.

sort_by class-attribute instance-attribute 
sort_by: IngestionJobSortBy | None = None

Contains details about how to sort the data.

Output

ListIngestionJobsOutput dataclass

Dataclass for ListIngestionJobsOutput structure.

Attributes

ingestion_job_summaries instance-attribute 
ingestion_job_summaries: list[IngestionJobSummary]

A list of data ingestion jobs with information about each job.

next_token class-attribute instance-attribute 
next_token: str | None = None

If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.