Skip to content

list_ingestion_jobs

Operation

list_ingestion_jobs

list_ingestion_jobs(request: ListIngestionJobsInput | ListIngestionJobsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListIngestionJobsInputDict]) -> ListIngestionJobsOutput

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

Parameters:

Name Type Description Default
request ListIngestionJobsInput | ListIngestionJobsInputDict | 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[ListIngestionJobsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
ListIngestionJobsOutput

An instance of ListIngestionJobsOutput.

list_ingestion_jobs async

list_ingestion_jobs(request: ListIngestionJobsInput | ListIngestionJobsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListIngestionJobsInputDict]) -> ListIngestionJobsOutput

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

Parameters:

Name Type Description Default
request ListIngestionJobsInput | ListIngestionJobsInputDict | 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[ListIngestionJobsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
ListIngestionJobsOutput

An instance of ListIngestionJobsOutput.

Input

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

ListIngestionJobsInputDict

Bases: TypedDict

Dictionary form of ListIngestionJobsInput.

Attributes

data_source_id instance-attribute
data_source_id: Required[str]

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

filters instance-attribute

Contains information about the filters for filtering the data.

knowledge_base_id instance-attribute
knowledge_base_id: Required[str]

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

max_results instance-attribute
max_results: int | 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 instance-attribute
next_token: str | 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 instance-attribute

Contains details about how to sort the data.

ListIngestionJobsInput dataclass

Bases: _SerdeShape

Dataclass for ListIngestionJobsInput structure.

Attributes

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

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

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

Contains information about the filters for filtering the data.

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

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 = ...

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 = ...

Contains details about how to sort the data.

Output

ListIngestionJobsOutput dataclass

Bases: _SerdeShape

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 = ...

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.

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.