AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Information about the knowledge base.

Inheritance Hierarchy

System.Object
  Amazon.QConnect.Model.KnowledgeBaseData

Namespace: Amazon.QConnect.Model
Assembly: AWSSDK.QConnect.dll
Version: 3.x.y.z

Syntax

C#
public class KnowledgeBaseData

The KnowledgeBaseData type exposes the following members

Constructors

NameDescription
Public Method KnowledgeBaseData()

Properties

NameTypeDescription
Public Property Description System.String

Gets and sets the property Description.

The description.

Public Property IngestionFailureReasons System.Collections.Generic.List<System.String>

Gets and sets the property IngestionFailureReasons.

List of failure reasons on ingestion per file.

Public Property IngestionStatus Amazon.QConnect.SyncStatus

Gets and sets the property IngestionStatus.

Status of ingestion on data source.

Public Property KnowledgeBaseArn System.String

Gets and sets the property KnowledgeBaseArn.

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

Public Property KnowledgeBaseId System.String

Gets and sets the property KnowledgeBaseId.

The identifier of the knowledge base.

Public Property KnowledgeBaseType Amazon.QConnect.KnowledgeBaseType

Gets and sets the property KnowledgeBaseType.

The type of knowledge base.

Public Property LastContentModificationTime System.DateTime

Gets and sets the property LastContentModificationTime.

An epoch timestamp indicating the most recent content modification inside the knowledge base. If no content exists in a knowledge base, this value is unset.

Public Property Name System.String

Gets and sets the property Name.

The name of the knowledge base.

Public Property RenderingConfiguration Amazon.QConnect.Model.RenderingConfiguration

Gets and sets the property RenderingConfiguration.

Information about how to render the content.

Public Property ServerSideEncryptionConfiguration Amazon.QConnect.Model.ServerSideEncryptionConfiguration

Gets and sets the property 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.

Public Property SourceConfiguration Amazon.QConnect.Model.SourceConfiguration

Gets and sets the property SourceConfiguration.

Source configuration information about the knowledge base.

Public Property Status Amazon.QConnect.KnowledgeBaseStatus

Gets and sets the property Status.

The status of the knowledge base.

Public Property Tags System.Collections.Generic.Dictionary<System.String, System.String>

Gets and sets the property Tags.

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

Public Property VectorIngestionConfiguration Amazon.QConnect.Model.VectorIngestionConfiguration

Gets and sets the property VectorIngestionConfiguration.

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

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5