Skip to content

Creates a knowledge base from a specified data source

Description

Creates a knowledge base from a specified data source. Supported data source connector types include:

  • S3_KNOWLEDGE_BASE – Uses an Amazon S3 bucket as the data source.
  • WEB_CRAWLER – Uses web pages indexed by the built-in web crawler as the data source.
  • GOOGLE_DRIVE – Uses Google Drive as the data source. Supports service account authentication only.
  • SHAREPOINT – Uses SharePoint as the data source. Supports two-legged OAuth only.
  • ONE_DRIVE – Uses OneDrive as the data source. Supports two-legged OAuth only.

Usage

quicksight_create_knowledge_base(AwsAccountId, KnowledgeBaseId, Name,
  DataSourceArn, KnowledgeBaseConfiguration, Description, Permissions,
  MediaExtractionConfiguration, AccessControlConfiguration,
  PrimaryOwnerArn, Tags)

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

[required] The name of the knowledge base.

  • DataSourceArn

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

  • KnowledgeBaseConfiguration

[required] The configuration settings for a knowledge base.

  • Description

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

  • Permissions

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.

  • MediaExtractionConfiguration

The configuration for media extraction from knowledge base documents.

  • AccessControlConfiguration

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

  • PrimaryOwnerArn

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 create_knowledge_base 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

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

Value

A list with the following syntax:

list(
  KnowledgeBaseArn = "string",
  KnowledgeBaseId = "string",
  CreationStatus = "CREATING"|"UPDATING"|"ACTIVE"|"FAILED"|"DELETING",
  RequestId = "string",
  Status = 123
)

Request syntax

svc$create_knowledge_base(
  AwsAccountId = "string",
  KnowledgeBaseId = "string",
  Name = "string",
  DataSourceArn = "string",
  KnowledgeBaseConfiguration = list(
    templateConfiguration = list(
      template = list()
    )
  ),
  Description = "string",
  Permissions = list(
    list(
      Principal = "string",
      Actions = list(
        "string"
      )
    )
  ),
  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"
    )
  ),
  AccessControlConfiguration = list(
    isACLEnabled = TRUE|FALSE
  ),
  PrimaryOwnerArn = "string",
  Tags = list(
    list(
      Key = "string",
      Value = "string"
    )
  )
)