ingestion_jobs

Creates, updates, deletes, gets or lists an ingestion_jobs resource.

Overview

Name	ingestion_jobs
Type	Resource
Id	aws.bedrock_agent.ingestion_jobs

Fields

The following fields are returned by SELECT queries:

get_ingestion_job

Name	Datatype	Description
data_source_id	string	The unique identifier of the data source for the data ingestion job. (pattern: <code>[0-9a-zA-Z]{10}</code>)
description	string	The description of the data ingestion job.
failure_reasons	array	A list of reasons that the data ingestion job failed.
ingestion_job_id	string	The unique identifier of the data ingestion job. (pattern: <code>[0-9a-zA-Z]{10}</code>)
knowledge_base_id	string	The unique identifier of the knowledge for the data ingestion job. (pattern: <code>[0-9a-zA-Z]{10}</code>)
started_at	string (date-time)	The time the data ingestion job started. If you stop a data ingestion job, the startedAt time is the time the job was started before the job was stopped.
statistics	object	Contains statistics about the data ingestion job.
status	string	The status of the data ingestion job. (STARTING, IN_PROGRESS, COMPLETE, FAILED, STOPPING, STOPPED)
updated_at	string (date-time)	The time the data ingestion job was last updated. If you stop a data ingestion job, the updatedAt time is the time the job was stopped.

list_ingestion_jobs

Name	Datatype	Description
data_source_id	string	The unique identifier of the data source for the data ingestion job. (pattern: <code>[0-9a-zA-Z]{10}</code>)
description	string	The description of the data ingestion job.
ingestion_job_id	string	The unique identifier of the data ingestion job. (pattern: <code>[0-9a-zA-Z]{10}</code>)
knowledge_base_id	string	The unique identifier of the knowledge base for the data ingestion job. (pattern: <code>[0-9a-zA-Z]{10}</code>)
started_at	string (date-time)	The time the data ingestion job started.
statistics	object	Contains statistics for the data ingestion job.
status	string	The status of the data ingestion job. (STARTING, IN_PROGRESS, COMPLETE, FAILED, STOPPING, STOPPED)
updated_at	string (date-time)	The time the data ingestion job was last updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_ingestion_job	select	knowledge_base_id, data_source_id, ingestion_job_id, region		Gets information about a data ingestion job. Data sources are ingested into your knowledge base so that Large Language Models (LLMs) can use your data.
list_ingestion_jobs	select	knowledge_base_id, data_source_id, region		Lists the data ingestion jobs for a data source. The list also includes information about each job.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
data_source_id	string	The unique identifier of the data source for the list of data ingestion jobs.
ingestion_job_id	string	The unique identifier of the data ingestion job you want to get information on.
knowledge_base_id	string	The unique identifier of the knowledge base for the list of data ingestion jobs.
region	string	AWS region (default: us-east-1)

SELECT examples

get_ingestion_job

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

SELECT
data_source_id,
description,
failure_reasons,
ingestion_job_id,
knowledge_base_id,
started_at,
statistics,
status,
updated_at
FROM aws.bedrock_agent.ingestion_jobs
WHERE knowledge_base_id = '{{ knowledge_base_id }}' -- required
AND data_source_id = '{{ data_source_id }}' -- required
AND ingestion_job_id = '{{ ingestion_job_id }}' -- required
AND region = '{{ region }}' -- required
;

list_ingestion_jobs

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

SELECT
data_source_id,
description,
ingestion_job_id,
knowledge_base_id,
started_at,
statistics,
status,
updated_at
FROM aws.bedrock_agent.ingestion_jobs
WHERE knowledge_base_id = '{{ knowledge_base_id }}' -- required
AND data_source_id = '{{ data_source_id }}' -- required
AND region = '{{ region }}' -- required
;