Skip to content

CreateKnowledgeBaseRequest

Source code in docs_src/capo_wisdom/types/create_knowledge_base_request.py
class CreateKnowledgeBaseRequest(TypedDict, closed=True):
    client_token: NotRequired["capo_wisdom.types.non_empty_string.NonEmptyString"]
    """<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</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. Only CUSTOM knowledge bases allow you to upload your own content. EXTERNAL knowledge bases support integrations with third-party systems whose content is synchronized automatically. </p>"""
    source_configuration: NotRequired[
        "capo_wisdom.types.source_configuration.SourceConfiguration"
    ]
    """<p>The source of the knowledge base content. Only set this argument for EXTERNAL knowledge bases.</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>, and <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.</p>"""
    tags: NotRequired["capo_wisdom.types.tags.Tags"]
    """<p>The tags used to organize, track, or control access for this resource.</p>"""

client_token instance-attribute

client_token: NotRequired[NonEmptyString]

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

description instance-attribute

description: NotRequired[Description]

The description.

knowledge_base_type instance-attribute

knowledge_base_type: KnowledgeBaseType

The type of knowledge base. Only CUSTOM knowledge bases allow you to upload your own content. EXTERNAL knowledge bases support integrations with third-party systems whose content is synchronized automatically.

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, and 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]

The source of the knowledge base content. Only set this argument for EXTERNAL knowledge bases.

tags instance-attribute

tags: NotRequired[Tags]

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