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.
Lists the knowledge bases.
See also: AWS API Documentation
list-knowledge-bases
is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate
argument.
When using --output text
and the --query
argument on a paginated response, the --query
argument must extract data from the results of the following query expressions: knowledgeBaseSummaries
list-knowledge-bases
[--cli-input-json <value>]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
--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.
--starting-token
(string)
A token to specify where to start paginating. This is the
NextToken
from a previously truncated response.For usage examples, see Pagination in the AWS Command Line Interface User Guide .
--page-size
(integer)
The size of each page to get in the AWS service call. This does not affect the number of items returned in the command's output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.
For usage examples, see Pagination in the AWS Command Line Interface User Guide .
--max-items
(integer)
The total number of items to return in the command's output. If the total number of items available is more than the value specified, a
NextToken
is provided in the command's output. To resume pagination, provide theNextToken
value in thestarting-token
argument of a subsequent command. Do not use theNextToken
response element directly outside of the AWS CLI.For usage examples, see Pagination in the AWS Command Line Interface User Guide .
--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.
--debug
(boolean)
Turn on debug logging.
--endpoint-url
(string)
Override command's default URL with the given URL.
--no-verify-ssl
(boolean)
By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.
--no-paginate
(boolean)
Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.
--output
(string)
The formatting style for command output.
--query
(string)
A JMESPath query to use in filtering the response data.
--profile
(string)
Use a specific profile from your credential file.
--region
(string)
The region to use. Overrides config/env settings.
--version
(string)
Display the version of this tool.
--color
(string)
Turn on/off color output.
--no-sign-request
(boolean)
Do not sign requests. Credentials will not be loaded if this argument is provided.
--ca-bundle
(string)
The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
--cli-read-timeout
(int)
The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.
--cli-connect-timeout
(int)
The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.
knowledgeBaseSummaries -> (list)
Information about the knowledge bases.
(structure)
Summary information about the knowledge base.
description -> (string)
The description of the knowledge base.knowledgeBaseArn -> (string)
The Amazon Resource Name (ARN) of the knowledge base.knowledgeBaseId -> (string)
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.knowledgeBaseType -> (string)
The type of knowledge base.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 forEXTERNAL
knowledge bases. For Salesforce, ServiceNow, and Zendesk, the variable must be one of the following:
- Salesforce:
Id
,ArticleNumber
,VersionNumber
,Title
,PublishStatus
, orIsDeleted
- ServiceNow:
number
,short_description
,sys_mod_count
,workflow_state
, oractive
- Zendesk:
id
,title
,updated_at
, ordraft
The variable is replaced with the actual value for a piece of content when calling GetContent .
serverSideEncryptionConfiguration -> (structure)
The configuration information for the customer managed key used for encryption.
This KMS key must have a policy that allows
kms:CreateGrant
,kms:DescribeKey
,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 .
kmsKeyId -> (string)
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) .sourceConfiguration -> (tagged union structure)
Configuration information about the external data source.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set:appIntegrations
.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.
- For Salesforce , your AppIntegrations DataIntegration must have an ObjectConfiguration if objectFields is not provided, including at least
Id
,ArticleNumber
,VersionNumber
,Title
,PublishStatus
, andIsDeleted
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
, andactive
as source fields.- For Zendesk , your AppIntegrations DataIntegration must have an ObjectConfiguration if
objectFields
is not provided, including at leastid
,title
,updated_at
, anddraft
as source fields.- For SharePoint , your AppIntegrations DataIntegration must have a FileConfiguration, including only file extensions that are among
docx
,html
,htm
, andtxt
.- 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
.Warning
The bucket policy of the corresponding S3 bucket must allow the Amazon Web Services principalapp-integrations.amazonaws.com
to performs3:ListBucket
,s3:GetObject
, ands3:GetBucketLocation
against the bucket.objectFields -> (list)
The fields from the source that are made available to your agents in Wisdom. Optional if ObjectConfiguration is included in the provided DataIntegration.
- For Salesforce , you must include at least
Id
,ArticleNumber
,VersionNumber
,Title
,PublishStatus
, andIsDeleted
.- For ServiceNow , you must include at least
number
,short_description
,sys_mod_count
,workflow_state
, andactive
.- For Zendesk , you must include at least
id
,title
,updated_at
, anddraft
.Make sure to include additional fields. These fields are indexed and used to source recommendations.
(string)
status -> (string)
The status of the knowledge base summary.tags -> (map)
The tags used to organize, track, or control access for this resource.
key -> (string)
value -> (string)
nextToken -> (string)
If there are additional results, this is the token for the next set of results.