QuickSight / Client / create_knowledge_base

create_knowledge_base¶

QuickSight.Client.create_knowledge_base(**kwargs)¶

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.

Request Syntax

response = client.create_knowledge_base(
    AwsAccountId='string',
    KnowledgeBaseId='string',
    Name='string',
    DataSourceArn='string',
    KnowledgeBaseConfiguration={
        'templateConfiguration': {
            'template': {...}|[...]|123|123.4|'string'|True|None
        }
    },
    Description='string',
    Permissions=[
        {
            'Principal': 'string',
            'Actions': [
                'string',
            ]
        },
    ],
    MediaExtractionConfiguration={
        'imageExtractionConfiguration': {
            'imageExtractionStatus': 'ENABLED'|'DISABLED'
        },
        'audioExtractionConfiguration': {
            'audioExtractionStatus': 'ENABLED'|'DISABLED'
        },
        'videoExtractionConfiguration': {
            'videoExtractionStatus': 'ENABLED'|'DISABLED',
            'videoExtractionType': 'AUDIO_TRANSCRIPTION_ONLY'|'VISUAL_CONTENT_AND_AUDIO_TRANSCRIPTION'
        }
    },
    AccessControlConfiguration={
        'isACLEnabled': True|False
    },
    PrimaryOwnerArn='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)

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) –
[REQUIRED]

The name of the knowledge base.
DataSourceArn (string) –
[REQUIRED]

The Amazon Resource Name (ARN) of the data source for the knowledge base.
KnowledgeBaseConfiguration (dict) –
[REQUIRED]

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.
Description (string) – A description for the knowledge base. If you don’t specify a description, the knowledge base is created without one.
Permissions (list) –
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.
- (dict) –
  
  Permission for the resource.
  - Principal (string) – [REQUIRED]
    
    The Amazon Resource Name (ARN) of the principal. This can be one of the following:
    - The ARN of an Quick Sight user or group associated with a data source or dataset. (This is common.)
    - The ARN of an Quick Sight user, group, or namespace associated with an analysis, dashboard, template, or theme. Namespace sharing is not supported for action connectors. (This is common.)
    - The ARN of an Amazon Web Services account root: This is an IAM ARN rather than a Quick Sight ARN. Use this option only to share resources (templates) across Amazon Web Services accounts. Account root sharing is not supported for action connectors. (This is less common.)
  - Actions (list) – [REQUIRED]
    
    The IAM action to grant or revoke permissions on.
    - (string) –
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.
AccessControlConfiguration (dict) –
The access control configuration for the knowledge base. If you don’t specify this parameter, document-level ACLs are disabled.
- isACLEnabled (boolean) –
  
  Specifies whether ACLs are enabled for the knowledge base.
PrimaryOwnerArn (string) – The Amazon Resource Name (ARN) of the primary owner for the knowledge base. The specified user is always granted owner access, regardless of what is specified in the Permissions field. If you don’t specify a primary owner, the knowledge base is created without one.
Tags (list) –
The tags to assign to the knowledge base. If you don’t specify tags, the knowledge base is created without tags.
- (dict) –
  
  The key or keys of the key-value pairs for the resource tag or tags assigned to the resource.
  - Key (string) – [REQUIRED]
    
    Tag key.
  - Value (string) – [REQUIRED]
    
    Tag value.

Return type:

dict

Returns:

Response Syntax

{
    'KnowledgeBaseArn': 'string',
    'KnowledgeBaseId': 'string',
    'CreationStatus': 'CREATING'|'UPDATING'|'ACTIVE'|'FAILED'|'DELETING',
    '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.
- CreationStatus (string) –
  
  The creation status of the knowledge base.
- RequestId (string) –
  
  The Amazon Web Services request ID for this operation.
- Status (integer) –
  
  The HTTP status of the request.

Exceptions

QuickSight.Client.exceptions.ResourceExistsException
QuickSight.Client.exceptions.ThrottlingException
QuickSight.Client.exceptions.InvalidRequestException
QuickSight.Client.exceptions.InvalidParameterValueException
QuickSight.Client.exceptions.InternalFailureException
QuickSight.Client.exceptions.PreconditionNotMetException
QuickSight.Client.exceptions.ResourceNotFoundException
QuickSight.Client.exceptions.LimitExceededException
QuickSight.Client.exceptions.AccessDeniedException