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

Inherits:

Struct

• Object
• Struct
• Aws::BedrockAgent::Types::IngestionJob

Includes:

Structure

Defined in:

lib/aws-sdk-bedrockagent/types.rb

Overview

Contains details about an ingestion job, which converts a data source to embeddings for a vector store in knowledge base.

This data type is used in the following API operations:

• StartIngestionJob response][1

• GetIngestionJob response][2

• ListIngestionJob response][3

[1]: docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_StartIngestionJob.html#API_agent_StartIngestionJob_ResponseSyntax [2]: docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_GetIngestionJob.html#API_agent_GetIngestionJob_ResponseSyntax [3]: docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_ListIngestionJobs.html#API_agent_ListIngestionJobs_ResponseSyntax

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #data_source_id ⇒ String

  The unique identifier of the ingested data source.

• #description ⇒ String

  The description of the ingestion job.

• #failure_reasons ⇒ Array<String>

  A list of reasons that the ingestion job failed.

• #ingestion_job_id ⇒ String

  The unique identifier of the ingestion job.

• #knowledge_base_id ⇒ String

  The unique identifier of the knowledge base to which the data source is being added.

• #started_at ⇒ Time

  The time at which the ingestion job started.

• #statistics ⇒ Types::IngestionJobStatistics

  Contains statistics about the ingestion job.

• #status ⇒ String

  The status of the ingestion job.

• #updated_at ⇒ Time

  The time at which the ingestion job was last updated.

Instance Attribute Details

#data_source_id ⇒ String

The unique identifier of the ingested data source.

Returns:

• (String)

# File 'lib/aws-sdk-bedrockagent/types.rb', line 2192

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

#description ⇒ String

The description of the ingestion job.

Returns:

• (String)

# File 'lib/aws-sdk-bedrockagent/types.rb', line 2192

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

#failure_reasons ⇒ Array<String>

A list of reasons that the ingestion job failed.

Returns:

• (Array<String>)

# File 'lib/aws-sdk-bedrockagent/types.rb', line 2192

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

#ingestion_job_id ⇒ String

The unique identifier of the ingestion job.

Returns:

• (String)

# File 'lib/aws-sdk-bedrockagent/types.rb', line 2192

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

#knowledge_base_id ⇒ String

The unique identifier of the knowledge base to which the data source is being added.

Returns:

• (String)

# File 'lib/aws-sdk-bedrockagent/types.rb', line 2192

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

#started_at ⇒ Time

The time at which the ingestion job started.

Returns:

• (Time)

# File 'lib/aws-sdk-bedrockagent/types.rb', line 2192

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

#statistics ⇒ Types::IngestionJobStatistics

Contains statistics about the ingestion job.

Returns:

• (Types::IngestionJobStatistics)

# File 'lib/aws-sdk-bedrockagent/types.rb', line 2192

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

#status ⇒ String

The status of the ingestion job.

Returns:

• (String)

# File 'lib/aws-sdk-bedrockagent/types.rb', line 2192

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

#updated_at ⇒ Time

The time at which the ingestion job was last updated.

Returns:

• (Time)

# File 'lib/aws-sdk-bedrockagent/types.rb', line 2192

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