QuickSight / Client / describe_knowledge_base

describe_knowledge_base

QuickSight.Client.describe_knowledge_base(**kwargs)

Describes a knowledge base.

See also: AWS API Documentation

Request Syntax

response = client.describe_knowledge_base(
    AwsAccountId='string',
    KnowledgeBaseId='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.

Return type:

dict

Returns:

Response Syntax

{
    'KnowledgeBase': {
        'KnowledgeBaseArn': 'string',
        'KnowledgeBaseId': 'string',
        'Name': 'string',
        'Status': 'CREATING'|'UPDATING'|'ACTIVE'|'FAILED'|'DELETING',
        'DataSourceArn': 'string',
        'KnowledgeBaseConfiguration': {
            'templateConfiguration': {
                'template': {...}|[...]|123|123.4|'string'|True|None
            },
            'eventEnabled': True|False
        },
        'MediaExtractionConfiguration': {
            'imageExtractionConfiguration': {
                'imageExtractionStatus': 'ENABLED'|'DISABLED'
            },
            'audioExtractionConfiguration': {
                'audioExtractionStatus': 'ENABLED'|'DISABLED'
            },
            'videoExtractionConfiguration': {
                'videoExtractionStatus': 'ENABLED'|'DISABLED',
                'videoExtractionType': 'AUDIO_TRANSCRIPTION_ONLY'|'VISUAL_CONTENT_AND_AUDIO_TRANSCRIPTION'
            }
        },
        'Type': 'string',
        'CreatedAt': datetime(2015, 1, 1),
        'UpdatedAt': datetime(2015, 1, 1),
        'Description': 'string',
        'IsEmailNotificationOptedForIngestionFailures': True|False,
        'FirstCompletedIngestionSummary': {
            'IngestionId': 'string',
            'IngestionStatus': 'QUEUED'|'RUNNING'|'FAILED'|'COMPLETED'|'INCOMPLETE'|'CANCELLED'|'CANCELLING'|'TIMEOUT',
            'StartTime': datetime(2015, 1, 1),
            'EndTime': datetime(2015, 1, 1)
        },
        'FirstIncompleteIngestionSummary': {
            'IngestionId': 'string',
            'IngestionStatus': 'QUEUED'|'RUNNING'|'FAILED'|'COMPLETED'|'INCOMPLETE'|'CANCELLED'|'CANCELLING'|'TIMEOUT',
            'StartTime': datetime(2015, 1, 1),
            'EndTime': datetime(2015, 1, 1)
        },
        'LatestIngestionSummary': {
            'IngestionId': 'string',
            'IngestionStatus': 'QUEUED'|'RUNNING'|'FAILED'|'COMPLETED'|'INCOMPLETE'|'CANCELLED'|'CANCELLING'|'TIMEOUT',
            'StartTime': datetime(2015, 1, 1),
            'EndTime': datetime(2015, 1, 1)
        },
        'KnowledgeBaseSizeBytes': 123,
        'DocumentCount': 123,
        'PrimaryOwnerArn': 'string',
        'PrimaryOwnerUsername': 'string'
    },
    'RequestId': 'string',
    'Status': 123
}

Response Structure

• (dict) –

  • KnowledgeBase (dict) –

    The knowledge base.

    • KnowledgeBaseArn (string) –

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

    • KnowledgeBaseId (string) –

      The unique identifier for the knowledge base.

    • Name (string) –

      The name of the knowledge base.

    • Status (string) –

      The status of the knowledge base.

    • DataSourceArn (string) –

      The ARN of the data source associated with the knowledge base.

    • KnowledgeBaseConfiguration (dict) –

      The configuration settings for the knowledge base.

      • templateConfiguration (dict) –

        The template configuration for the knowledge base.

        • template (document) –

          The template document that defines the knowledge base behavior.

      • eventEnabled (boolean) –

        Indicates whether event notifications are enabled for the knowledge base.

    • MediaExtractionConfiguration (dict) –

      The media extraction configuration for the knowledge base.

      • imageExtractionConfiguration (dict) –

        The configuration for image extraction.

        • imageExtractionStatus (string) –

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

      • audioExtractionConfiguration (dict) –

        The configuration for audio extraction.

        • audioExtractionStatus (string) –

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

      • videoExtractionConfiguration (dict) –

        The configuration for video extraction.

        • videoExtractionStatus (string) –

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

        • videoExtractionType (string) –

          The type of video extraction to perform.

    • Type (string) –

      The type of the knowledge base.

    • CreatedAt (datetime) –

      The date and time that the knowledge base was created.

    • UpdatedAt (datetime) –

      The date and time that the knowledge base was last updated.

    • Description (string) –

      The description of the knowledge base.

    • IsEmailNotificationOptedForIngestionFailures (boolean) –

      Indicates whether email notifications are enabled for ingestion failures.

    • FirstCompletedIngestionSummary (dict) –

      A summary of the first completed ingestion for the knowledge base.

      • IngestionId (string) –

        The unique identifier for the ingestion job.

      • IngestionStatus (string) –

        The status of the ingestion job.

      • StartTime (datetime) –

        The start time of the ingestion job.

      • EndTime (datetime) –

        The end time of the ingestion job.

    • FirstIncompleteIngestionSummary (dict) –

      A summary of the first incomplete ingestion for the knowledge base.

      • IngestionId (string) –

        The unique identifier for the ingestion job.

      • IngestionStatus (string) –

        The status of the ingestion job.

      • StartTime (datetime) –

        The start time of the ingestion job.

      • EndTime (datetime) –

        The end time of the ingestion job.

    • LatestIngestionSummary (dict) –

      A summary of the most recent ingestion for the knowledge base.

      • IngestionId (string) –

        The unique identifier for the ingestion job.

      • IngestionStatus (string) –

        The status of the ingestion job.

      • StartTime (datetime) –

        The start time of the ingestion job.

      • EndTime (datetime) –

        The end time of the ingestion job.

    • KnowledgeBaseSizeBytes (integer) –

      The size of the knowledge base in bytes.

    • DocumentCount (integer) –

      The number of documents in the knowledge base.

    • PrimaryOwnerArn (string) –

      The ARN of the primary owner of the knowledge base.

    • PrimaryOwnerUsername (string) –

      The username of the primary owner 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.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