QuickSight / Client / update_knowledge_base

update_knowledge_base

QuickSight.Client.update_knowledge_base(**kwargs)

Updates the properties of an existing knowledge base.

See also: AWS API Documentation

Request Syntax

response = client.update_knowledge_base(
    AwsAccountId='string',
    KnowledgeBaseId='string',
    Name='string',
    Description='string',
    KnowledgeBaseConfiguration={
        'templateConfiguration': {
            'template': {...}|[...]|123|123.4|'string'|True|None
        }
    },
    MediaExtractionConfiguration={
        'imageExtractionConfiguration': {
            'imageExtractionStatus': 'ENABLED'|'DISABLED'
        },
        'audioExtractionConfiguration': {
            'audioExtractionStatus': 'ENABLED'|'DISABLED'
        },
        'videoExtractionConfiguration': {
            'videoExtractionStatus': 'ENABLED'|'DISABLED',
            'videoExtractionType': 'AUDIO_TRANSCRIPTION_ONLY'|'VISUAL_CONTENT_AND_AUDIO_TRANSCRIPTION'
        }
    },
    IsEmailNotificationOptedForIngestionFailures=True|False,
    AccessControlConfiguration={
        'isACLEnabled': True|False
    }
)
Parameters:

  • AwsAccountId (string) –

    [REQUIRED]

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

  • KnowledgeBaseId (string) –

    [REQUIRED]

    The unique identifier for the knowledge base.

  • Name (string) – The name of the knowledge base. If you don’t specify a name, the existing name is retained.

  • Description (string) – A description for the knowledge base. If you don’t specify a description, the existing description is retained.

  • KnowledgeBaseConfiguration (dict) –

    The configuration settings for a knowledge base.

    • templateConfiguration (dict) –

      The template configuration that defines how the data source connector crawls and indexes data for the knowledge base. The template structure varies by connector type. See KbTemplateConfiguration for connector-specific details.

      • template (document) –

        The connector configuration for the knowledge base data source. The structure depends on the connector type of the data source referenced by DataSourceArn.

        The template must be a JSON object. The required fields vary by connector type:

        • Amazon S3 ( S3V2) – Requires connectionConfiguration with bucketName. Supports filterConfiguration for inclusion and exclusion prefixes and patterns. Supports accessControlConfiguration and deletionProtectionConfiguration.

        • Google Drive ( GOOGLEDRIVEV3) – Requires connectionConfiguration with authType set to SERVICE_ACCOUNT. Supports dataEntityConfiguration with crawlMyDrive, crawlSharedWithMe, and crawlSharedDrives.

        • OneDrive ( ONEDRIVEV3) – Requires authType at the template root level set to TWO_LEGGED_OAUTH. Requires connectionConfiguration with tenantId in UUID format. Supports dataEntityConfiguration with crawlPersonalDrives and crawlSharedWithMe.

        • SharePoint ( SHAREPOINTV3) – Requires connectionConfiguration with tenantId in UUID format. Supports dataEntityConfiguration with siteUrls, crawlFiles, and crawlPages.

        • Web Crawler ( WEBCRAWLERV3) – Requires connectionConfiguration with seedUrls or siteMapUrls (mutually exclusive) and authType. Supports crawlConfiguration for crawl depth, rate limits, and scope. Supports filterConfiguration for file size limits and URL patterns. Valid values for authType: NO_AUTH, BASIC_AUTH, FORM, SAML.

        The optional deletionProtectionConfiguration object is supported by all connector types. It contains enableDeletionProtection and deletionProtectionThreshold.

  • MediaExtractionConfiguration (dict) –

    The configuration for media extraction from knowledge base documents.

    • imageExtractionConfiguration (dict) –

      The configuration for image extraction.

      • imageExtractionStatus (string) – [REQUIRED]

        The status of image extraction. Valid values are ENABLED and DISABLED.

    • audioExtractionConfiguration (dict) –

      The configuration for audio extraction.

      • audioExtractionStatus (string) – [REQUIRED]

        The status of audio extraction. Valid values are ENABLED and DISABLED.

    • videoExtractionConfiguration (dict) –

      The configuration for video extraction.

      • videoExtractionStatus (string) – [REQUIRED]

        The status of video extraction. Valid values are ENABLED and DISABLED.

      • videoExtractionType (string) –

        The type of video extraction to perform.

  • IsEmailNotificationOptedForIngestionFailures (boolean) – Specifies whether email notifications are enabled for ingestion failures.

  • AccessControlConfiguration (dict) –

    The access control configuration for the knowledge base. If you don’t specify this parameter, the existing setting is retained.

    • isACLEnabled (boolean) –

      Specifies whether ACLs are enabled for the knowledge base.

Return type:

dict

Returns:

Response Syntax

{
    'KnowledgeBaseArn': 'string',
    'KnowledgeBaseId': 'string',
    'RequestId': 'string',
    'Status': 123
}

Response Structure

  • (dict) –

    • KnowledgeBaseArn (string) –

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

    • KnowledgeBaseId (string) –

      The unique identifier for the knowledge base.

    • RequestId (string) –

      The Amazon Web Services request ID for this operation.

    • Status (integer) –

      The HTTP status of the request.

Exceptions