Skip to content

KnowledgeBaseSummary

Source code in docs_src/capo_wisdom/types/knowledge_base_summary.py 
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
class KnowledgeBaseSummary(TypedDict, closed=True):
    knowledge_base_id: "capo_wisdom.types.uuid.Uuid"
    """<p>The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Wisdom Content resource to it.</p>"""
    knowledge_base_arn: "capo_wisdom.types.arn.Arn"
    """<p>The Amazon Resource Name (ARN) of the knowledge base.</p>"""
    name: "capo_wisdom.types.name.Name"
    """<p>The name of the knowledge base.</p>"""
    knowledge_base_type: "capo_wisdom.types.knowledge_base_type.KnowledgeBaseType"
    """<p>The type of knowledge base.</p>"""
    status: "capo_wisdom.types.knowledge_base_status.KnowledgeBaseStatus"
    """<p>The status of the knowledge base summary.</p>"""
    source_configuration: NotRequired[
        "capo_wisdom.types.source_configuration.SourceConfiguration"
    ]
    """<p>Configuration information about the external data source.</p>"""
    rendering_configuration: NotRequired[
        "capo_wisdom.types.rendering_configuration.RenderingConfiguration"
    ]
    """<p>Information about how to render the content.</p>"""
    server_side_encryption_configuration: NotRequired[
        "capo_wisdom.types.server_side_encryption_configuration.ServerSideEncryptionConfiguration"
    ]
    """<p>The configuration information for the customer managed key used for encryption. </p> <p>This KMS key must have a policy that allows <code>kms:CreateGrant</code>, <code>kms:DescribeKey</code>, <code>kms:Decrypt/kms:GenerateDataKey</code> permissions to the IAM identity using the key to invoke Wisdom. </p> <p>For more information about setting up a customer managed key for Wisdom, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/enable-wisdom.html">Enable Amazon Connect Wisdom for your instance</a>.</p>"""
    description: NotRequired["capo_wisdom.types.description.Description"]
    """<p>The description of the knowledge base.</p>"""
    tags: NotRequired["capo_wisdom.types.tags.Tags"]
    """<p>The tags used to organize, track, or control access for this resource.</p>"""

description instance-attribute 

description: NotRequired[Description]

The description of the knowledge base.

knowledge_base_arn instance-attribute 

knowledge_base_arn: Arn

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

knowledge_base_id instance-attribute 

knowledge_base_id: Uuid

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

knowledge_base_type instance-attribute 

knowledge_base_type: KnowledgeBaseType

The type of knowledge base.

name instance-attribute 

name: Name

The name of the knowledge base.

rendering_configuration instance-attribute 

rendering_configuration: NotRequired[RenderingConfiguration]

Information about how to render the content.

server_side_encryption_configuration instance-attribute 

server_side_encryption_configuration: NotRequired[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/kms:GenerateDataKey permissions to the IAM identity using the key to invoke Wisdom.

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

source_configuration instance-attribute 

source_configuration: NotRequired[SourceConfiguration]

Configuration information about the external data source.

status instance-attribute 

status: KnowledgeBaseStatus

The status of the knowledge base summary.

tags instance-attribute 

tags: NotRequired[Tags]

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