Skip to content

CreateKnowledgeBaseRequest

Source code in docs_src/capo_quicksight/types/create_knowledge_base_request.py
class CreateKnowledgeBaseRequest(TypedDict, closed=True):
    aws_account_id: "capo_quicksight.types.kb_aws_account_id.KbAwsAccountId"
    """<p>The ID of the Amazon Web Services account that contains the knowledge base.</p>"""
    knowledge_base_id: "capo_quicksight.types.knowledge_base_id.KnowledgeBaseId"
    """<p>The unique identifier for the knowledge base.</p>"""
    name: "capo_quicksight.types.knowledge_base_name.KnowledgeBaseName"
    """<p>The name of the knowledge base.</p>"""
    data_source_arn: "capo_quicksight.types.data_source_arn.DataSourceArn"
    """<p>The Amazon Resource Name (ARN) of the data source for the knowledge base.</p>"""
    knowledge_base_configuration: (
        "capo_quicksight.types.knowledge_base_configuration.KnowledgeBaseConfiguration"
    )
    description: NotRequired[
        "capo_quicksight.types.knowledge_base_description.KnowledgeBaseDescription"
    ]
    """<p>A description for the knowledge base. If you don't specify a description, the knowledge base is created without one.</p>"""
    permissions: NotRequired[
        "capo_quicksight.types.resource_permission_list.ResourcePermissionList"
    ]
    """<p>A list of resource permissions on the knowledge base. Each entry grants a specified Amazon QuickSight principal either owner or viewer access. If you don't specify permissions, only the primary owner (if provided) receives owner access.</p>"""
    media_extraction_configuration: NotRequired[
        "capo_quicksight.types.media_extraction_configuration.MediaExtractionConfiguration"
    ]
    access_control_configuration: NotRequired[
        "capo_quicksight.types.access_control_configuration.AccessControlConfiguration"
    ]
    """<p>The access control configuration for the knowledge base. If you don't specify this parameter, document-level ACLs are disabled.</p>"""
    primary_owner_arn: NotRequired["capo_quicksight.types.string.String"]
    """<p>The Amazon Resource Name (ARN) of the Amazon QuickSight user or group to set as the primary owner of the knowledge base. The specified principal is always granted owner access, regardless of what is specified in the <code>Permissions</code> field.</p> <p>This must be an Amazon QuickSight principal ARN, not an IAM user or role ARN. The API caller is never assigned as the owner automatically. If you don't specify a primary owner and don't grant owner access in <code>Permissions</code>, the knowledge base is created without an owner, even when you call the operation as an Amazon QuickSight user.</p> <p>When you call <code>CreateKnowledgeBase</code> as an IAM user or an assumed IAM role, specify <code>PrimaryOwnerArn</code> (as an Amazon QuickSight principal ARN) or an owner entry in <code>Permissions</code> so that the knowledge base has an owner. Although optional, specifying a primary owner is recommended.</p>"""
    tags: NotRequired["capo_quicksight.types.tag_list.TagList"]
    """<p>The tags to assign to the knowledge base. If you don't specify tags, the knowledge base is created without tags.</p>"""

access_control_configuration instance-attribute

access_control_configuration: NotRequired[AccessControlConfiguration]

The access control configuration for the knowledge base. If you don't specify this parameter, document-level ACLs are disabled.

aws_account_id instance-attribute

aws_account_id: KbAwsAccountId

The ID of the Amazon Web Services account that contains the knowledge base.

data_source_arn instance-attribute

data_source_arn: DataSourceArn

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

description instance-attribute

description: NotRequired[KnowledgeBaseDescription]

A description for the knowledge base. If you don't specify a description, the knowledge base is created without one.

knowledge_base_configuration instance-attribute

knowledge_base_configuration: KnowledgeBaseConfiguration

knowledge_base_id instance-attribute

knowledge_base_id: KnowledgeBaseId

The unique identifier for the knowledge base.

media_extraction_configuration instance-attribute

media_extraction_configuration: NotRequired[MediaExtractionConfiguration]

name instance-attribute

The name of the knowledge base.

permissions instance-attribute

permissions: NotRequired[ResourcePermissionList]

A list of resource permissions on the knowledge base. Each entry grants a specified Amazon QuickSight principal either owner or viewer access. If you don't specify permissions, only the primary owner (if provided) receives owner access.

primary_owner_arn instance-attribute

primary_owner_arn: NotRequired[String]

The Amazon Resource Name (ARN) of the Amazon QuickSight user or group to set as the primary owner of the knowledge base. The specified principal is always granted owner access, regardless of what is specified in the Permissions field.

This must be an Amazon QuickSight principal ARN, not an IAM user or role ARN. The API caller is never assigned as the owner automatically. If you don't specify a primary owner and don't grant owner access in Permissions, the knowledge base is created without an owner, even when you call the operation as an Amazon QuickSight user.

When you call CreateKnowledgeBase as an IAM user or an assumed IAM role, specify PrimaryOwnerArn (as an Amazon QuickSight principal ARN) or an owner entry in Permissions so that the knowledge base has an owner. Although optional, specifying a primary owner is recommended.

tags instance-attribute

tags: NotRequired[TagList]

The tags to assign to the knowledge base. If you don't specify tags, the knowledge base is created without tags.