QuickSight / Client / update_knowledge_base

update_knowledge_base¶

QuickSight.Client.update_knowledge_base(**kwargs)¶

Updates the properties of an existing knowledge base.

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 for the knowledge base.
  - template (document) –
    
    The template document that defines the knowledge base behavior.
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

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
QuickSight.Client.exceptions.ConflictException