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
            }
        },
        '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
        },
        '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 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. All connector types share the following top-level keys. The value of type and the contents of connectionConfiguration vary by connector type.

            • type – (Required) The connector type of the data source. This value identifies the connector. Valid values: S3V2, WEBCRAWLERV3, GOOGLEDRIVEV3, ONEDRIVEV3, SHAREPOINTV3. For the fields required by each connector, see the connector-specific list that follows.

            • connectionConfiguration – (Required) The connection details for the data source. The keys in this object vary by connector type; see the connector-specific list that follows.

            • filterConfiguration – (Optional) Rules that determine which content is crawled, such as inclusion and exclusion prefixes, patterns, or file-size limits.

            • accessControlConfiguration – (Optional) Document-level access control (ACL) settings. Supported by all connector types except Web Crawler ( WEBCRAWLERV3). The available fields depend on the connector type.

            • deletionProtectionConfiguration – (Optional) Deletion-protection settings, supported by all connector types. Contains enableDeletionProtection (Boolean) and deletionProtectionThreshold (String; a value from 1 to 100).

            The following list describes the valid type value, the connectionConfiguration contents, and any connector-specific fields for each connector type:

            • Amazon S3 ( type: S3V2) – The type value must be S3V2. connectionConfiguration is required and contains:

              • bucketName – (Required) The name of the Amazon S3 bucket to crawl. Type: String. Length: 3–63 characters. Pattern: ^[a-z0-9][.\-a-z0-9]{1,61}[a-z0-9]$.

              • bucketOwnerAccountId – (Required) The ID of the AWS account that owns the bucket. Type: String. Pattern: ^\d{12}$.

            Amazon S3 supports the following optional filterConfiguration fields:

            • inclusionPrefixes or exclusionPrefixes – Amazon S3 key prefixes to include or exclude. Type: Array of String. Up to 350 items, each 1–1,024 characters.

            • inclusionPatterns or exclusionPatterns – Patterns to include or exclude objects. Type: Array of String. Up to 350 items, each 1–1,024 characters.

            • maxFileSizeInMegaBytes – The maximum size, in MB, of a file to ingest. Type: String. Pattern: ^\d+$.

            For Amazon S3, accessControlConfiguration supports the following fields:

            • crawlAcl – Specifies whether the connector crawls and enforces document access control lists (ACLs). Type: Boolean. When set to true, provide ACLs either in a global ACL configuration file ( aclConfigurationFilePath) or in per-document metadata files.

            • aclConfigurationFilePath – The Amazon S3 URI of the global ACL configuration file. Type: String. Length: 1–1,024 characters. Optional. If you don’t provide a global ACL configuration file, define ACLs in per-document metadata files.

            • defaultAccessType – The access behavior applied to Amazon S3 prefixes that are not listed in the ACL configuration. Type: String. The only supported value is ALLOW.

            metadataFilesPrefix – (Optional) The Amazon S3 prefix under which per-document metadata files are stored. Each metadata file describes a single source document and its indexable attributes. This is not the global ACL configuration file. For a single global ACL file, use accessControlConfiguration.aclConfigurationFilePath. Type: String. Length: 1–1,024 characters.

            • Google Drive ( type: GOOGLEDRIVEV3) – Requires connectionConfiguration with authType set to SERVICE_ACCOUNT. Supports dataEntityConfiguration with crawlMyDrive, crawlSharedWithMe, and crawlSharedDrives.

            • OneDrive ( type: 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 ( type: SHAREPOINTV3) – Requires connectionConfiguration with tenantId in UUID format. Supports dataEntityConfiguration with siteUrls, crawlFiles, and crawlPages.

            • Web Crawler ( type: 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.

            Enabling document-level access control for Amazon S3

            For an Amazon S3 ( S3V2) knowledge base, document-level access control is governed by two settings that must both be enabled:

            • In this template, set accessControlConfiguration.crawlAcl to true. Define ACLs either in a global ACL configuration file, referenced by accessControlConfiguration.aclConfigurationFilePath, or in per-document metadata files. To control access for prefixes that are not listed in the ACL file, you can also set accessControlConfiguration.defaultAccessType.

            • In the CreateKnowledgeBase or UpdateKnowledgeBase request, set the top-level AccessControlConfiguration.isACLEnabled to true.

      • 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.

      • AccessControlConfiguration (dict) –

        The access control configuration for the knowledge base.

        • isACLEnabled (boolean) –

          Specifies whether ACLs are enabled for the knowledge base.

          This setting works together with the data source connector’s ACL crawling. To enforce document-level access control end to end, set isACLEnabled to true and enable ACL crawling on the connector. For example, for an Amazon S3 data source, set accessControlConfiguration.crawlAcl to true in the connector template. For more information, see KbTemplateConfiguration. Enabling only one of the two settings does not produce a fully ACL-enforced knowledge base.

      • 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) –

        Specifies 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