Skip to content

IngestionJob

Source code in docs_src/capo_bedrock_agent/types/ingestion_job.py 
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
class IngestionJob(TypedDict, closed=True):
    knowledge_base_id: "capo_bedrock_agent.types.id.Id"
    """<p>The unique identifier of the knowledge for the data ingestion job.</p>"""
    data_source_id: "capo_bedrock_agent.types.id.Id"
    """<p>The unique identifier of the data source for the data ingestion job.</p>"""
    ingestion_job_id: "capo_bedrock_agent.types.id.Id"
    """<p>The unique identifier of the data ingestion job.</p>"""
    description: NotRequired["capo_bedrock_agent.types.description.Description"]
    """<p>The description of the data ingestion job.</p>"""
    status: "capo_bedrock_agent.types.ingestion_job_status.IngestionJobStatus"
    """<p>The status of the data ingestion job.</p>"""
    statistics: NotRequired[
        "capo_bedrock_agent.types.ingestion_job_statistics.IngestionJobStatistics"
    ]
    """<p>Contains statistics about the data ingestion job.</p>"""
    failure_reasons: NotRequired[
        "capo_bedrock_agent.types.failure_reasons.FailureReasons"
    ]
    """<p>A list of reasons that the data ingestion job failed.</p>"""
    started_at: "capo_bedrock_agent.types.date_timestamp.DateTimestamp"
    """<p>The time the data ingestion job started.</p> <p>If you stop a data ingestion job, the <code>startedAt</code> time is the time the job was started before the job was stopped.</p>"""
    updated_at: "capo_bedrock_agent.types.date_timestamp.DateTimestamp"
    """<p>The time the data ingestion job was last updated.</p> <p>If you stop a data ingestion job, the <code>updatedAt</code> time is the time the job was stopped.</p>"""
    text_ready_at: NotRequired["capo_bedrock_agent.types.date_timestamp.DateTimestamp"]
    """<p>The time at which all text content in the data ingestion job finished extraction and became available to query.</p> <p>This time isn't returned until text extraction is complete for all the documents in the job.</p>"""

data_source_id instance-attribute 

data_source_id: Id

The unique identifier of the data source for the data ingestion job.

description instance-attribute 

description: NotRequired[Description]

The description of the data ingestion job.

failure_reasons instance-attribute 

failure_reasons: NotRequired[FailureReasons]

A list of reasons that the data ingestion job failed.

ingestion_job_id instance-attribute 

ingestion_job_id: Id

The unique identifier of the data ingestion job.

knowledge_base_id instance-attribute 

knowledge_base_id: Id

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

started_at instance-attribute 

started_at: DateTimestamp

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 instance-attribute 

statistics: NotRequired[IngestionJobStatistics]

Contains statistics about the data ingestion job.

status instance-attribute 

status: IngestionJobStatus

The status of the data ingestion job.

text_ready_at instance-attribute 

text_ready_at: NotRequired[DateTimestamp]

The time at which all text content in the data ingestion job finished extraction and became available to query.

This time isn't returned until text extraction is complete for all the documents in the job.

updated_at instance-attribute 

updated_at: DateTimestamp

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.