Struct aws_sdk_qconnect::types::KnowledgeBaseSummary

#[non_exhaustive]
pub struct KnowledgeBaseSummary {
    pub knowledge_base_id: String,
    pub knowledge_base_arn: String,
    pub name: String,
    pub knowledge_base_type: KnowledgeBaseType,
    pub status: KnowledgeBaseStatus,
    pub source_configuration: Option<SourceConfiguration>,
    pub rendering_configuration: Option<RenderingConfiguration>,
    pub server_side_encryption_configuration: Option<ServerSideEncryptionConfiguration>,
    pub description: Option<String>,
    pub tags: Option<HashMap<String, String>>,
}

Summary information about the knowledge base.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

knowledge_base_id: String

The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Amazon Q Content resource to it.

knowledge_base_arn: String

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

name: String

The name of the knowledge base.

knowledge_base_type: KnowledgeBaseType

The type of knowledge base.

status: KnowledgeBaseStatus

The status of the knowledge base summary.

source_configuration: Option<SourceConfiguration>

Configuration information about the external data source.

rendering_configuration: Option<RenderingConfiguration>

Information about how to render the content.

server_side_encryption_configuration: Option<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.

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

description: Option<String>

The description of the knowledge base.

tags: Option<HashMap<String, String>>

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

Implementations

impl KnowledgeBaseSummary

pub fn knowledge_base_id(&self) -> &str

The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Amazon Q Content resource to it.

pub fn knowledge_base_arn(&self) -> &str

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

pub fn name(&self) -> &str

The name of the knowledge base.

pub fn knowledge_base_type(&self) -> &KnowledgeBaseType

The type of knowledge base.

pub fn status(&self) -> &KnowledgeBaseStatus

The status of the knowledge base summary.

pub fn source_configuration(&self) -> Option<&SourceConfiguration>

Configuration information about the external data source.

pub fn rendering_configuration(&self) -> Option<&RenderingConfiguration>

Information about how to render the content.

pub fn server_side_encryption_configuration( &self ) -> Option<&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.

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

pub fn description(&self) -> Option<&str>

The description of the knowledge base.

pub fn tags(&self) -> Option<&HashMap<String, String>>

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

impl KnowledgeBaseSummary

pub fn builder() -> KnowledgeBaseSummaryBuilder

Creates a new builder-style object to manufacture KnowledgeBaseSummary.

Trait Implementations

impl Clone for KnowledgeBaseSummary

fn clone(&self) -> KnowledgeBaseSummary

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for KnowledgeBaseSummary

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for KnowledgeBaseSummary

fn eq(&self, other: &KnowledgeBaseSummary) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for KnowledgeBaseSummary