Skip to content

Updates the properties of an existing knowledge base

Description

Updates the properties of an existing knowledge base.

Usage

quicksight_update_knowledge_base(AwsAccountId, KnowledgeBaseId, Name,
  Description, KnowledgeBaseConfiguration, MediaExtractionConfiguration,
  IsEmailNotificationOptedForIngestionFailures,
  AccessControlConfiguration)

Arguments

  • AwsAccountId

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

  • KnowledgeBaseId

    [required] The unique identifier for the knowledge base.

  • Name

    The name of the knowledge base. If you don't specify a name, the existing name is retained.

  • Description

    A description for the knowledge base. If you don't specify a description, the existing description is retained.

  • KnowledgeBaseConfiguration

    The configuration settings for a knowledge base.

  • MediaExtractionConfiguration

    The configuration for media extraction from knowledge base documents.

  • IsEmailNotificationOptedForIngestionFailures

    Specifies whether email notifications are enabled for ingestion failures.

  • AccessControlConfiguration

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

Value

A list with the following syntax:

list(
  KnowledgeBaseArn = "string",
  KnowledgeBaseId = "string",
  RequestId = "string",
  Status = 123
)

Request syntax

svc$update_knowledge_base(
  AwsAccountId = "string",
  KnowledgeBaseId = "string",
  Name = "string",
  Description = "string",
  KnowledgeBaseConfiguration = list(
    templateConfiguration = list(
      template = list()
    )
  ),
  MediaExtractionConfiguration = list(
    imageExtractionConfiguration = list(
      imageExtractionStatus = "ENABLED"|"DISABLED"
    ),
    audioExtractionConfiguration = list(
      audioExtractionStatus = "ENABLED"|"DISABLED"
    ),
    videoExtractionConfiguration = list(
      videoExtractionStatus = "ENABLED"|"DISABLED",
      videoExtractionType = "AUDIO_TRANSCRIPTION_ONLY"|"VISUAL_CONTENT_AND_AUDIO_TRANSCRIPTION"
    )
  ),
  IsEmailNotificationOptedForIngestionFailures = TRUE|FALSE,
  AccessControlConfiguration = list(
    isACLEnabled = TRUE|FALSE
  )
)