Skip to content
AWS for Query.Farm

aws.wisdom.get_knowledge_base

Example SQL Queries

SELECT * FROM
aws.wisdom.get_knowledge_base
WHERE
"knowledge_base_id" = 'VALUE';

Description

Retrieves information about the knowledge base.

Table Definition

Column NameColumn Data Type
knowledge_base_id Required Input Column

The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Wisdom Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
knowledge_base

The knowledge base.

STRUCT(
    "description" VARCHAR,
    "knowledge_base_arn" VARCHAR,
    "knowledge_base_id" VARCHAR,
    "knowledge_base_type" VARCHAR,
    "last_content_modification_time" TIMESTAMP_S,
    "name" VARCHAR,
    "rendering_configuration" STRUCT(
        "template_uri" VARCHAR
    ),
    "server_side_encryption_configuration" STRUCT(
        "kms_key_id" VARCHAR
    ),
    "source_configuration" STRUCT(
        "app_integrations" STRUCT(
            "app_integration_arn" VARCHAR,
            "object_fields" VARCHAR[]
        )
    ),
    "status" VARCHAR,
    "tags" MAP(VARCHAR, VARCHAR)
)
Show child fields
knowledge_base.description

The description.

knowledge_base.knowledge_base_arn

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

knowledge_base.knowledge_base_id

The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Wisdom Content resource to it.

knowledge_base.knowledge_base_type

The type of knowledge base.

knowledge_base.last_content_modification_time

An epoch timestamp indicating the most recent content modification inside the knowledge base. If no content exists in a knowledge base, this value is unset.

knowledge_base.name

The name of the knowledge base.

knowledge_base.rendering_configuration

Information about how to render the content.

Show child fields
knowledge_base.rendering_configuration.template_uri

A URI template containing exactly one variable in ${variableName} format. This can only be set for EXTERNAL knowledge bases. For Salesforce, ServiceNow, and Zendesk, the variable must be one of the following:

  • Salesforce: Id, ArticleNumber, VersionNumber, Title, PublishStatus, or IsDeleted

  • ServiceNow: number, short_description, sys_mod_count, workflow_state, or active

  • Zendesk: id, title, updated_at, or draft

The variable is replaced with the actual value for a piece of content when calling GetContent.

knowledge_base.server_side_encryption_configuration

The configuration information for the customer managed key used for encryption.

This KMS key must have a policy that allows kms:CreateGrant, kms:DescribeKey, and kms:Decrypt/kms:GenerateDataKey permissions to the IAM identity using the key to invoke Wisdom.

For more information about setting up a customer managed key for Wisdom, see Enable Amazon Connect Wisdom for your instance.

Show child fields
knowledge_base.server_side_encryption_configuration.kms_key_id

The customer managed key used for encryption. For more information about setting up a customer managed key for Wisdom, see Enable Amazon Connect Wisdom for your instance. For information about valid ID values, see Key identifiers (KeyId).

knowledge_base.source_configuration

Source configuration information about the knowledge base.

Show child fields
knowledge_base.source_configuration.app_integrations

Configuration information for Amazon AppIntegrations to automatically ingest content.

Show child fields
knowledge_base.source_configuration.app_integrations.app_integration_arn

The Amazon Resource Name (ARN) of the AppIntegrations DataIntegration to use for ingesting content.

  • For Salesforce, your AppIntegrations DataIntegration must have an ObjectConfiguration if objectFields is not provided, including at least Id, ArticleNumber, VersionNumber, Title, PublishStatus, and IsDeleted as source fields.

  • For ServiceNow, your AppIntegrations DataIntegration must have an ObjectConfiguration if objectFields is not provided, including at least number, short_description, sys_mod_count, workflow_state, and active as source fields.

  • For Zendesk, your AppIntegrations DataIntegration must have an ObjectConfiguration if objectFields is not provided, including at least id, title, updated_at, and draft as source fields.

  • For SharePoint, your AppIntegrations DataIntegration must have a FileConfiguration, including only file extensions that are among docx, pdf, html, htm, and txt.

  • For Amazon S3, the ObjectConfiguration and FileConfiguration of your AppIntegrations DataIntegration must be null. The SourceURI of your DataIntegration must use the following format: s3://your_s3_bucket_name.

    The bucket policy of the corresponding S3 bucket must allow the Amazon Web Services principal app-integrations.amazonaws.com to perform s3:ListBucket, s3:GetObject, and s3:GetBucketLocation against the bucket.
knowledge_base.source_configuration.app_integrations.object_fields[]
knowledge_base.status

The status of the knowledge base.

knowledge_base.tags

The tags used to organize, track, or control access for this resource.