Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . wisdom ]

get-knowledge-base

Description

Retrieves information about the knowledge base.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  get-knowledge-base
--knowledge-base-id <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--knowledge-base-id (string)

The the identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

knowledgeBase -> (structure)

The knowledge base.

description -> (string)

The description.

knowledgeBaseArn -> (string)

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

knowledgeBaseId -> (string)

The the identifier of the knowledge base.

knowledgeBaseType -> (string)

The type of knowledge base.

lastContentModificationTime -> (timestamp)

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.

name -> (string)

The name of the knowledge base.

renderingConfiguration -> (structure)

Information about how to render the content.

templateUri -> (string)

A URI template containing exactly one variable in ${variableName} format. This can only be set for EXTERNAL knowledge bases. For Salesforce and ServiceNow, 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
<p>The variable is replaced with the actual value for a piece of content when calling <a href="https://docs.aws.amazon.com/wisdom/latest/APIReference/API_GetContent.html">GetContent</a>. </p>

serverSideEncryptionConfiguration -> (structure)

The KMS key used for encryption.

kmsKeyId -> (string)

The KMS key. For information about valid ID values, see Key identifiers (KeyId) in the AWS Key Management Service Developer Guide .

sourceConfiguration -> (structure)

Source configuration information about the knowledge base.

appIntegrations -> (structure)

Configuration information for Amazon AppIntegrations to automatically ingest content.

appIntegrationArn -> (string)

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

objectFields -> (list)

The fields from the source that are made available to your agents in Wisdom.

  • For Salesforce , you must include at least Id , ArticleNumber , VersionNumber , Title , PublishStatus , and IsDeleted .
  • For ServiceNow , you must include at least number , short_description , sys_mod_count , workflow_state , and active .

Make sure to include additional field(s); these are indexed and used to source recommendations.

(string)

status -> (string)

The status of the knowledge base.

tags -> (map)

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

key -> (string)

value -> (string)