Class: Aws::BedrockAgent::Types::IngestionJob

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/types.rb

Overview

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

This data type is used in the following API operations:

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#data_source_id ⇒ String

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

Returns:

  • (String) 


6204
6205
6206
6207
6208
6209
6210
6211
6212
6213
6214
6215
6216
6217
 
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/types.rb', line 6204

class IngestionJob < Struct.new(
  :knowledge_base_id,
  :data_source_id,
  :ingestion_job_id,
  :description,
  :status,
  :statistics,
  :failure_reasons,
  :started_at,
  :updated_at,
  :text_ready_at)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

The description of the data ingestion job.

Returns:

  • (String) 


6204
6205
6206
6207
6208
6209
6210
6211
6212
6213
6214
6215
6216
6217
 
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/types.rb', line 6204

class IngestionJob < Struct.new(
  :knowledge_base_id,
  :data_source_id,
  :ingestion_job_id,
  :description,
  :status,
  :statistics,
  :failure_reasons,
  :started_at,
  :updated_at,
  :text_ready_at)
  SENSITIVE = []
  include Aws::Structure
end

#failure_reasons ⇒ Array<String>

A list of reasons that the data ingestion job failed.

Returns:

  • (Array<String>) 


6204
6205
6206
6207
6208
6209
6210
6211
6212
6213
6214
6215
6216
6217
 
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/types.rb', line 6204

class IngestionJob < Struct.new(
  :knowledge_base_id,
  :data_source_id,
  :ingestion_job_id,
  :description,
  :status,
  :statistics,
  :failure_reasons,
  :started_at,
  :updated_at,
  :text_ready_at)
  SENSITIVE = []
  include Aws::Structure
end

#ingestion_job_id ⇒ String

The unique identifier of the data ingestion job.

Returns:

  • (String) 


6204
6205
6206
6207
6208
6209
6210
6211
6212
6213
6214
6215
6216
6217
 
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/types.rb', line 6204

class IngestionJob < Struct.new(
  :knowledge_base_id,
  :data_source_id,
  :ingestion_job_id,
  :description,
  :status,
  :statistics,
  :failure_reasons,
  :started_at,
  :updated_at,
  :text_ready_at)
  SENSITIVE = []
  include Aws::Structure
end

#knowledge_base_id ⇒ String

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

Returns:

  • (String) 


6204
6205
6206
6207
6208
6209
6210
6211
6212
6213
6214
6215
6216
6217
 
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/types.rb', line 6204

class IngestionJob < Struct.new(
  :knowledge_base_id,
  :data_source_id,
  :ingestion_job_id,
  :description,
  :status,
  :statistics,
  :failure_reasons,
  :started_at,
  :updated_at,
  :text_ready_at)
  SENSITIVE = []
  include Aws::Structure
end

#started_at ⇒ 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.

Returns:

  • (Time) 


6204
6205
6206
6207
6208
6209
6210
6211
6212
6213
6214
6215
6216
6217
 
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/types.rb', line 6204

class IngestionJob < Struct.new(
  :knowledge_base_id,
  :data_source_id,
  :ingestion_job_id,
  :description,
  :status,
  :statistics,
  :failure_reasons,
  :started_at,
  :updated_at,
  :text_ready_at)
  SENSITIVE = []
  include Aws::Structure
end

#statistics ⇒ Types::IngestionJobStatistics

Contains statistics about the data ingestion job.

Returns:



6204
6205
6206
6207
6208
6209
6210
6211
6212
6213
6214
6215
6216
6217
 
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/types.rb', line 6204

class IngestionJob < Struct.new(
  :knowledge_base_id,
  :data_source_id,
  :ingestion_job_id,
  :description,
  :status,
  :statistics,
  :failure_reasons,
  :started_at,
  :updated_at,
  :text_ready_at)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

The status of the data ingestion job.

Returns:

  • (String) 


6204
6205
6206
6207
6208
6209
6210
6211
6212
6213
6214
6215
6216
6217
 
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/types.rb', line 6204

class IngestionJob < Struct.new(
  :knowledge_base_id,
  :data_source_id,
  :ingestion_job_id,
  :description,
  :status,
  :statistics,
  :failure_reasons,
  :started_at,
  :updated_at,
  :text_ready_at)
  SENSITIVE = []
  include Aws::Structure
end

#text_ready_at ⇒ Time

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.

Returns:

  • (Time) 


6204
6205
6206
6207
6208
6209
6210
6211
6212
6213
6214
6215
6216
6217
 
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/types.rb', line 6204

class IngestionJob < Struct.new(
  :knowledge_base_id,
  :data_source_id,
  :ingestion_job_id,
  :description,
  :status,
  :statistics,
  :failure_reasons,
  :started_at,
  :updated_at,
  :text_ready_at)
  SENSITIVE = []
  include Aws::Structure
end

#updated_at ⇒ 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.

Returns:

  • (Time) 


6204
6205
6206
6207
6208
6209
6210
6211
6212
6213
6214
6215
6216
6217
 
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/types.rb', line 6204

class IngestionJob < Struct.new(
  :knowledge_base_id,
  :data_source_id,
  :ingestion_job_id,
  :description,
  :status,
  :statistics,
  :failure_reasons,
  :started_at,
  :updated_at,
  :text_ready_at)
  SENSITIVE = []
  include Aws::Structure
end