1. Registry
  2. Packages
  3. AWS Cloud Control
  4. API Docs
  5. quicksight
  6. KnowledgeBase

We recommend new projects start with resources from the AWS provider.

Viewing docs for AWS Cloud Control v1.86.0
published on Wednesday, Nov 18, 2026 by Pulumi
aws-native logo aws-native logo AWS Cloud Control

We recommend new projects start with resources from the AWS provider.

Viewing docs for AWS Cloud Control v1.86.0
published on Wednesday, Nov 18, 2026 by Pulumi

    Definition of AWS::QuickSight::KnowledgeBase Resource Type

    Create KnowledgeBase Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new KnowledgeBase(name: string, args: KnowledgeBaseArgs, opts?: CustomResourceOptions);
    @overload
    def KnowledgeBase(resource_name: str,
                      args: KnowledgeBaseArgs,
                      opts: Optional[ResourceOptions] = None)
    
    @overload
    def KnowledgeBase(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      aws_account_id: Optional[str] = None,
                      data_source_arn: Optional[str] = None,
                      knowledge_base_configuration: Optional[KnowledgeBaseConfigurationArgs] = None,
                      knowledge_base_id: Optional[str] = None,
                      access_control_configuration: Optional[KnowledgeBaseAccessControlConfigurationArgs] = None,
                      description: Optional[str] = None,
                      is_email_notification_opted_for_ingestion_failures: Optional[bool] = None,
                      media_extraction_configuration: Optional[KnowledgeBaseMediaExtractionConfigurationArgs] = None,
                      name: Optional[str] = None,
                      permissions: Optional[Sequence[KnowledgeBaseResourcePermissionArgs]] = None,
                      primary_owner_arn: Optional[str] = None,
                      tags: Optional[Sequence[_root_inputs.TagArgs]] = None)
    func NewKnowledgeBase(ctx *Context, name string, args KnowledgeBaseArgs, opts ...ResourceOption) (*KnowledgeBase, error)
    public KnowledgeBase(string name, KnowledgeBaseArgs args, CustomResourceOptions? opts = null)
    public KnowledgeBase(String name, KnowledgeBaseArgs args)
    public KnowledgeBase(String name, KnowledgeBaseArgs args, CustomResourceOptions options)
    
    type: aws-native:quicksight:KnowledgeBase
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "aws-native_quicksight_knowledge_base" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args KnowledgeBaseArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args KnowledgeBaseArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args KnowledgeBaseArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args KnowledgeBaseArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args KnowledgeBaseArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    KnowledgeBase Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The KnowledgeBase resource accepts the following input properties:

    Outputs

    All input properties are implicitly available as output properties. Additionally, the KnowledgeBase resource produces the following output properties:

    CreatedAt string
    DocumentCount double
    Id string
    The provider-assigned unique ID for this managed resource.
    KnowledgeBaseArn string
    KnowledgeBaseSizeBytes double
    PrimaryOwnerUsername string
    Status Pulumi.AwsNative.QuickSight.KnowledgeBaseDataSetStatus
    Type string
    UpdatedAt string
    CreatedAt string
    DocumentCount float64
    Id string
    The provider-assigned unique ID for this managed resource.
    KnowledgeBaseArn string
    KnowledgeBaseSizeBytes float64
    PrimaryOwnerUsername string
    Status KnowledgeBaseDataSetStatus
    Type string
    UpdatedAt string
    created_at string
    document_count number
    id string
    The provider-assigned unique ID for this managed resource.
    knowledge_base_arn string
    knowledge_base_size_bytes number
    primary_owner_username string
    status "CREATING" | "UPDATING" | "ACTIVE" | "FAILED" | "DELETING"
    type string
    updated_at string
    createdAt String
    documentCount Double
    id String
    The provider-assigned unique ID for this managed resource.
    knowledgeBaseArn String
    knowledgeBaseSizeBytes Double
    primaryOwnerUsername String
    status KnowledgeBaseDataSetStatus
    type String
    updatedAt String
    createdAt string
    documentCount number
    id string
    The provider-assigned unique ID for this managed resource.
    knowledgeBaseArn string
    knowledgeBaseSizeBytes number
    primaryOwnerUsername string
    status KnowledgeBaseDataSetStatus
    type string
    updatedAt string
    created_at str
    document_count float
    id str
    The provider-assigned unique ID for this managed resource.
    knowledge_base_arn str
    knowledge_base_size_bytes float
    primary_owner_username str
    status KnowledgeBaseDataSetStatus
    type str
    updated_at str
    createdAt String
    documentCount Number
    id String
    The provider-assigned unique ID for this managed resource.
    knowledgeBaseArn String
    knowledgeBaseSizeBytes Number
    primaryOwnerUsername String
    status "CREATING" | "UPDATING" | "ACTIVE" | "FAILED" | "DELETING"
    type String
    updatedAt String

    Look up Existing KnowledgeBase Resource

    Get an existing KnowledgeBase resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, opts?: CustomResourceOptions): KnowledgeBase
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None) -> KnowledgeBase
    func GetKnowledgeBase(ctx *Context, name string, id IDInput, state *KnowledgeBaseState, opts ...ResourceOption) (*KnowledgeBase, error)
    public static KnowledgeBase Get(string name, Input<string> id, CustomResourceOptions? opts = null)
    public static KnowledgeBase get(String name, Output<String> id, CustomResourceOptions options)
    resources:  existingKnowledgeBase:    type: aws-native:quicksight:KnowledgeBase    get:      id: ${id}
    import {
      to = aws-native_quicksight_knowledge_base.example
      id = "${id}"
    }
    
    name string
    The unique name of the resulting resource.
    id Input<ID>
    The unique provider ID of the resource to look up.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resulting resource.
    id str
    The unique provider ID of the resource to look up.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resulting resource.
    id IDInput
    The unique provider ID of the resource to look up.
    state KnowledgeBaseState
    Pass nil. This resource has no state arguments.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resulting resource.
    id Input<string>
    The unique provider ID of the resource to look up.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resulting resource.
    id Output<String>
    The unique provider ID of the resource to look up.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Supporting Types

    KnowledgeBaseAccessControlConfiguration, KnowledgeBaseAccessControlConfigurationArgs

    isAclEnabled Boolean
    isAclEnabled boolean
    isAclEnabled Boolean

    KnowledgeBaseAudioExtractionConfiguration, KnowledgeBaseAudioExtractionConfigurationArgs

    KnowledgeBaseAudioExtractionStatus

    NameValue
    EnabledENABLED
    DisabledDISABLED
    NameValue
    KnowledgeBaseAudioExtractionStatusEnabledENABLED
    KnowledgeBaseAudioExtractionStatusDisabledDISABLED
    Value
    ENABLED
    DISABLED
    NameValue
    EnabledENABLED
    DisabledDISABLED
    NameValue
    EnabledENABLED
    DisabledDISABLED
    NameValue
    ENABLEDENABLED
    DISABLEDDISABLED
    Value
    ENABLED
    DISABLED

    KnowledgeBaseConfiguration, KnowledgeBaseConfigurationArgs

    KnowledgeBaseDataSetStatus

    NameValue
    CreatingCREATING
    UpdatingUPDATING
    ActiveACTIVE
    FailedFAILED
    DeletingDELETING
    NameValue
    KnowledgeBaseDataSetStatusCreatingCREATING
    KnowledgeBaseDataSetStatusUpdatingUPDATING
    KnowledgeBaseDataSetStatusActiveACTIVE
    KnowledgeBaseDataSetStatusFailedFAILED
    KnowledgeBaseDataSetStatusDeletingDELETING
    Value
    CREATING
    UPDATING
    ACTIVE
    FAILED
    DELETING
    NameValue
    CreatingCREATING
    UpdatingUPDATING
    ActiveACTIVE
    FailedFAILED
    DeletingDELETING
    NameValue
    CreatingCREATING
    UpdatingUPDATING
    ActiveACTIVE
    FailedFAILED
    DeletingDELETING
    NameValue
    CREATINGCREATING
    UPDATINGUPDATING
    ACTIVEACTIVE
    FAILEDFAILED
    DELETINGDELETING
    Value
    CREATING
    UPDATING
    ACTIVE
    FAILED
    DELETING

    KnowledgeBaseImageExtractionConfiguration, KnowledgeBaseImageExtractionConfigurationArgs

    KnowledgeBaseImageExtractionStatus

    NameValue
    EnabledENABLED
    DisabledDISABLED
    NameValue
    KnowledgeBaseImageExtractionStatusEnabledENABLED
    KnowledgeBaseImageExtractionStatusDisabledDISABLED
    Value
    ENABLED
    DISABLED
    NameValue
    EnabledENABLED
    DisabledDISABLED
    NameValue
    EnabledENABLED
    DisabledDISABLED
    NameValue
    ENABLEDENABLED
    DISABLEDDISABLED
    Value
    ENABLED
    DISABLED

    KnowledgeBaseKbTemplateConfiguration, KnowledgeBaseKbTemplateConfigurationArgs

    Template object
    Template interface{}
    template Object

    KnowledgeBaseMediaExtractionConfiguration, KnowledgeBaseMediaExtractionConfigurationArgs

    KnowledgeBaseResourcePermission, KnowledgeBaseResourcePermissionArgs

    Actions List<string>
    Principal string
    Resource string
    Actions []string
    Principal string
    Resource string
    actions list(string)
    principal string
    resource string
    actions List<String>
    principal String
    resource String
    actions string[]
    principal string
    resource string
    actions Sequence[str]
    principal str
    resource str
    actions List<String>
    principal String
    resource String

    KnowledgeBaseVideoExtractionConfiguration, KnowledgeBaseVideoExtractionConfigurationArgs

    KnowledgeBaseVideoExtractionStatus

    NameValue
    EnabledENABLED
    DisabledDISABLED
    NameValue
    KnowledgeBaseVideoExtractionStatusEnabledENABLED
    KnowledgeBaseVideoExtractionStatusDisabledDISABLED
    Value
    ENABLED
    DISABLED
    NameValue
    EnabledENABLED
    DisabledDISABLED
    NameValue
    EnabledENABLED
    DisabledDISABLED
    NameValue
    ENABLEDENABLED
    DISABLEDDISABLED
    Value
    ENABLED
    DISABLED

    KnowledgeBaseVideoExtractionType

    NameValue
    AudioTranscriptionOnlyAUDIO_TRANSCRIPTION_ONLY
    VisualContentAndAudioTranscriptionVISUAL_CONTENT_AND_AUDIO_TRANSCRIPTION
    NameValue
    KnowledgeBaseVideoExtractionTypeAudioTranscriptionOnlyAUDIO_TRANSCRIPTION_ONLY
    KnowledgeBaseVideoExtractionTypeVisualContentAndAudioTranscriptionVISUAL_CONTENT_AND_AUDIO_TRANSCRIPTION
    Value
    AUDIO_TRANSCRIPTION_ONLY
    VISUAL_CONTENT_AND_AUDIO_TRANSCRIPTION
    NameValue
    AudioTranscriptionOnlyAUDIO_TRANSCRIPTION_ONLY
    VisualContentAndAudioTranscriptionVISUAL_CONTENT_AND_AUDIO_TRANSCRIPTION
    NameValue
    AudioTranscriptionOnlyAUDIO_TRANSCRIPTION_ONLY
    VisualContentAndAudioTranscriptionVISUAL_CONTENT_AND_AUDIO_TRANSCRIPTION
    NameValue
    AUDIO_TRANSCRIPTION_ONLYAUDIO_TRANSCRIPTION_ONLY
    VISUAL_CONTENT_AND_AUDIO_TRANSCRIPTIONVISUAL_CONTENT_AND_AUDIO_TRANSCRIPTION
    Value
    AUDIO_TRANSCRIPTION_ONLY
    VISUAL_CONTENT_AND_AUDIO_TRANSCRIPTION

    Tag, TagArgs

    A set of tags to apply to the resource.

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo aws-native logo AWS Cloud Control

    We recommend new projects start with resources from the AWS provider.

    Viewing docs for AWS Cloud Control v1.86.0
    published on Wednesday, Nov 18, 2026 by Pulumi

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial