Class: Aws::QConnect::Types::KnowledgeBaseSummary

Inherits:

Struct

• Object
• Struct
• Aws::QConnect::Types::KnowledgeBaseSummary

Includes:

Structure

Defined in:

lib/aws-sdk-qconnect/types.rb

Overview

Summary information about the knowledge base.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #description ⇒ String

  The description of the knowledge base.

• #knowledge_base_arn ⇒ String

  The Amazon Resource Name (ARN) of the knowledge base.

• #knowledge_base_id ⇒ String

  The identifier of the knowledge base.

• #knowledge_base_type ⇒ String

  The type of knowledge base.

• #name ⇒ String

  The name of the knowledge base.

• #rendering_configuration ⇒ Types::RenderingConfiguration

  Information about how to render the content.

• #server_side_encryption_configuration ⇒ Types::ServerSideEncryptionConfiguration

  The configuration information for the customer managed key used for encryption.

• #source_configuration ⇒ Types::SourceConfiguration

  Configuration information about the external data source.

• #status ⇒ String

  The status of the knowledge base summary.

• #tags ⇒ Hash<String,String>

  The tags used to organize, track, or control access for this resource.

• #vector_ingestion_configuration ⇒ Types::VectorIngestionConfiguration

  Contains details about how to ingest the documents in a data source.

Instance Attribute Details

#description ⇒ String

The description of the knowledge base.

Returns:

• (String)

# File 'lib/aws-sdk-qconnect/types.rb', line 6261

class KnowledgeBaseSummary < Struct.new(
  :knowledge_base_id,
  :knowledge_base_arn,
  :name,
  :knowledge_base_type,
  :status,
  :source_configuration,
  :vector_ingestion_configuration,
  :rendering_configuration,
  :server_side_encryption_configuration,
  :description,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#knowledge_base_arn ⇒ String

The Amazon Resource Name (ARN) of the knowledge base.

Returns:

• (String)

# File 'lib/aws-sdk-qconnect/types.rb', line 6261

class KnowledgeBaseSummary < Struct.new(
  :knowledge_base_id,
  :knowledge_base_arn,
  :name,
  :knowledge_base_type,
  :status,
  :source_configuration,
  :vector_ingestion_configuration,
  :rendering_configuration,
  :server_side_encryption_configuration,
  :description,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#knowledge_base_id ⇒ String

The identifier of the knowledge base.

Returns:

• (String)

# File 'lib/aws-sdk-qconnect/types.rb', line 6261

class KnowledgeBaseSummary < Struct.new(
  :knowledge_base_id,
  :knowledge_base_arn,
  :name,
  :knowledge_base_type,
  :status,
  :source_configuration,
  :vector_ingestion_configuration,
  :rendering_configuration,
  :server_side_encryption_configuration,
  :description,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#knowledge_base_type ⇒ String

The type of knowledge base.

Returns:

• (String)

# File 'lib/aws-sdk-qconnect/types.rb', line 6261

class KnowledgeBaseSummary < Struct.new(
  :knowledge_base_id,
  :knowledge_base_arn,
  :name,
  :knowledge_base_type,
  :status,
  :source_configuration,
  :vector_ingestion_configuration,
  :rendering_configuration,
  :server_side_encryption_configuration,
  :description,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name of the knowledge base.

Returns:

• (String)

# File 'lib/aws-sdk-qconnect/types.rb', line 6261

class KnowledgeBaseSummary < Struct.new(
  :knowledge_base_id,
  :knowledge_base_arn,
  :name,
  :knowledge_base_type,
  :status,
  :source_configuration,
  :vector_ingestion_configuration,
  :rendering_configuration,
  :server_side_encryption_configuration,
  :description,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#rendering_configuration ⇒ Types::RenderingConfiguration

Information about how to render the content.

Returns:

• (Types::RenderingConfiguration)

# File 'lib/aws-sdk-qconnect/types.rb', line 6261

class KnowledgeBaseSummary < Struct.new(
  :knowledge_base_id,
  :knowledge_base_arn,
  :name,
  :knowledge_base_type,
  :status,
  :source_configuration,
  :vector_ingestion_configuration,
  :rendering_configuration,
  :server_side_encryption_configuration,
  :description,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#server_side_encryption_configuration ⇒ Types::ServerSideEncryptionConfiguration

The configuration information for the customer managed key used for encryption.

This KMS key must have a policy that allows ‘kms:CreateGrant`, `kms:DescribeKey`, `kms:Decrypt`, and `kms:GenerateDataKey*` permissions to the IAM identity using the key to invoke Amazon Q in Connect.

For more information about setting up a customer managed key for Amazon Q in Connect, see [Enable Amazon Q in Connect for your instance].

[1]: docs.aws.amazon.com/connect/latest/adminguide/enable-q.html

Returns:

• (Types::ServerSideEncryptionConfiguration)

# File 'lib/aws-sdk-qconnect/types.rb', line 6261

class KnowledgeBaseSummary < Struct.new(
  :knowledge_base_id,
  :knowledge_base_arn,
  :name,
  :knowledge_base_type,
  :status,
  :source_configuration,
  :vector_ingestion_configuration,
  :rendering_configuration,
  :server_side_encryption_configuration,
  :description,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#source_configuration ⇒ Types::SourceConfiguration

Configuration information about the external data source.

Returns:

• (Types::SourceConfiguration)

# File 'lib/aws-sdk-qconnect/types.rb', line 6261

class KnowledgeBaseSummary < Struct.new(
  :knowledge_base_id,
  :knowledge_base_arn,
  :name,
  :knowledge_base_type,
  :status,
  :source_configuration,
  :vector_ingestion_configuration,
  :rendering_configuration,
  :server_side_encryption_configuration,
  :description,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

The status of the knowledge base summary.

Returns:

• (String)

# File 'lib/aws-sdk-qconnect/types.rb', line 6261

class KnowledgeBaseSummary < Struct.new(
  :knowledge_base_id,
  :knowledge_base_arn,
  :name,
  :knowledge_base_type,
  :status,
  :source_configuration,
  :vector_ingestion_configuration,
  :rendering_configuration,
  :server_side_encryption_configuration,
  :description,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

The tags used to organize, track, or control access for this resource.

Returns:

• (Hash<String,String>)

# File 'lib/aws-sdk-qconnect/types.rb', line 6261

class KnowledgeBaseSummary < Struct.new(
  :knowledge_base_id,
  :knowledge_base_arn,
  :name,
  :knowledge_base_type,
  :status,
  :source_configuration,
  :vector_ingestion_configuration,
  :rendering_configuration,
  :server_side_encryption_configuration,
  :description,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#vector_ingestion_configuration ⇒ Types::VectorIngestionConfiguration

Contains details about how to ingest the documents in a data source.

Returns:

• (Types::VectorIngestionConfiguration)

# File 'lib/aws-sdk-qconnect/types.rb', line 6261

class KnowledgeBaseSummary < Struct.new(
  :knowledge_base_id,
  :knowledge_base_arn,
  :name,
  :knowledge_base_type,
  :status,
  :source_configuration,
  :vector_ingestion_configuration,
  :rendering_configuration,
  :server_side_encryption_configuration,
  :description,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end