Class: Aws::BedrockAgent::Types::KnowledgeBase

Inherits:

Struct

• Object
• Struct
• Aws::BedrockAgent::Types::KnowledgeBase

Includes:

Structure

Defined in:

lib/aws-sdk-bedrockagent/types.rb

Overview

Contains the information of a knowledge base.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #created_at ⇒ Time

  Time Stamp.

• #description ⇒ String

  Description of the Resource.

• #failure_reasons ⇒ Array<String>

  Failure Reasons for Error.

• #knowledge_base_arn ⇒ String

  ARN of a KnowledgeBase.

• #knowledge_base_configuration ⇒ Types::KnowledgeBaseConfiguration

  Configures a bedrock knowledge base.

• #knowledge_base_id ⇒ String

  Identifier for a resource.

• #name ⇒ String

  Name for a resource.

• #role_arn ⇒ String

  ARN of a IAM role.

• #status ⇒ String

  The status of a knowledge base.

• #storage_configuration ⇒ Types::StorageConfiguration

  Configures the physical storage of ingested data in a knowledge base.

• #updated_at ⇒ Time

  Time Stamp.

Instance Attribute Details

#created_at ⇒ Time

Time Stamp.

Returns:

• (Time)

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

class KnowledgeBase < Struct.new(
  :knowledge_base_id,
  :name,
  :knowledge_base_arn,
  :description,
  :role_arn,
  :knowledge_base_configuration,
  :storage_configuration,
  :status,
  :created_at,
  :updated_at,
  :failure_reasons)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

Description of the Resource.

Returns:

• (String)

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

class KnowledgeBase < Struct.new(
  :knowledge_base_id,
  :name,
  :knowledge_base_arn,
  :description,
  :role_arn,
  :knowledge_base_configuration,
  :storage_configuration,
  :status,
  :created_at,
  :updated_at,
  :failure_reasons)
  SENSITIVE = []
  include Aws::Structure
end

#failure_reasons ⇒ Array<String>

Failure Reasons for Error.

Returns:

• (Array<String>)

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

class KnowledgeBase < Struct.new(
  :knowledge_base_id,
  :name,
  :knowledge_base_arn,
  :description,
  :role_arn,
  :knowledge_base_configuration,
  :storage_configuration,
  :status,
  :created_at,
  :updated_at,
  :failure_reasons)
  SENSITIVE = []
  include Aws::Structure
end

#knowledge_base_arn ⇒ String

ARN of a KnowledgeBase

Returns:

• (String)

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

class KnowledgeBase < Struct.new(
  :knowledge_base_id,
  :name,
  :knowledge_base_arn,
  :description,
  :role_arn,
  :knowledge_base_configuration,
  :storage_configuration,
  :status,
  :created_at,
  :updated_at,
  :failure_reasons)
  SENSITIVE = []
  include Aws::Structure
end

#knowledge_base_configuration ⇒ Types::KnowledgeBaseConfiguration

Configures a bedrock knowledge base.

Returns:

• (Types::KnowledgeBaseConfiguration)

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

class KnowledgeBase < Struct.new(
  :knowledge_base_id,
  :name,
  :knowledge_base_arn,
  :description,
  :role_arn,
  :knowledge_base_configuration,
  :storage_configuration,
  :status,
  :created_at,
  :updated_at,
  :failure_reasons)
  SENSITIVE = []
  include Aws::Structure
end

#knowledge_base_id ⇒ String

Identifier for a resource.

Returns:

• (String)

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

class KnowledgeBase < Struct.new(
  :knowledge_base_id,
  :name,
  :knowledge_base_arn,
  :description,
  :role_arn,
  :knowledge_base_configuration,
  :storage_configuration,
  :status,
  :created_at,
  :updated_at,
  :failure_reasons)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

Name for a resource.

Returns:

• (String)

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

class KnowledgeBase < Struct.new(
  :knowledge_base_id,
  :name,
  :knowledge_base_arn,
  :description,
  :role_arn,
  :knowledge_base_configuration,
  :storage_configuration,
  :status,
  :created_at,
  :updated_at,
  :failure_reasons)
  SENSITIVE = []
  include Aws::Structure
end

#role_arn ⇒ String

ARN of a IAM role.

Returns:

• (String)

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

class KnowledgeBase < Struct.new(
  :knowledge_base_id,
  :name,
  :knowledge_base_arn,
  :description,
  :role_arn,
  :knowledge_base_configuration,
  :storage_configuration,
  :status,
  :created_at,
  :updated_at,
  :failure_reasons)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

The status of a knowledge base.

Returns:

• (String)

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

class KnowledgeBase < Struct.new(
  :knowledge_base_id,
  :name,
  :knowledge_base_arn,
  :description,
  :role_arn,
  :knowledge_base_configuration,
  :storage_configuration,
  :status,
  :created_at,
  :updated_at,
  :failure_reasons)
  SENSITIVE = []
  include Aws::Structure
end

#storage_configuration ⇒ Types::StorageConfiguration

Configures the physical storage of ingested data in a knowledge base.

Returns:

• (Types::StorageConfiguration)

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

class KnowledgeBase < Struct.new(
  :knowledge_base_id,
  :name,
  :knowledge_base_arn,
  :description,
  :role_arn,
  :knowledge_base_configuration,
  :storage_configuration,
  :status,
  :created_at,
  :updated_at,
  :failure_reasons)
  SENSITIVE = []
  include Aws::Structure
end

#updated_at ⇒ Time

Time Stamp.

Returns:

• (Time)

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

class KnowledgeBase < Struct.new(
  :knowledge_base_id,
  :name,
  :knowledge_base_arn,
  :description,
  :role_arn,
  :knowledge_base_configuration,
  :storage_configuration,
  :status,
  :created_at,
  :updated_at,
  :failure_reasons)
  SENSITIVE = []
  include Aws::Structure
end