Spec-Zone.ru › AWS CLI v2

[ aws . wisdom ]

list-knowledge-bases

Описание

Отображает список баз знаний.

См. также: Документация API AWS

list-knowledge-bases является постраничной операцией. Для получения всего набора результатов может потребоваться несколько вызовов API. Вы можете отключить постраничный вывод, указав аргумент --no-paginate. При использовании --output text и аргумента --query в ответе с постраничным выводом, аргумент --query должен извлекать данные из результатов следующих выражений запроса: knowledgeBaseSummaries

Синтаксис

  list-knowledge-bases
[--cli-input-json | --cli-input-yaml]
[--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-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Параметры

--cli-input-json | --cli-input-yaml (строка) Считывает аргументы из предоставленной JSON-строки. JSON-строка следует формату, указанному в --generate-cli-skeleton. Если другие аргументы указаны в командной строке, эти значения переопределят значения, полученные из JSON. Невозможно передать произвольные двоичные значения с помощью значения JSON, поскольку строка будет интерпретирована буквально. Этот параметр не может быть указан вместе с --cli-input-yaml.

--starting-token (строка)

Маркер для указания точки начала постраничного вывода. Это NextToken из ранее усеченного ответа.

Примеры использования см. в разделе Постраничный вывод в Руководстве пользователя AWS Command Line Interface.

--page-size (целое число)

Размер каждой страницы, получаемой при вызове AWS-сервиса. Это не влияет на количество элементов, возвращаемых в выводе команды. Установка меньшего размера страницы приводит к большему количеству вызовов AWS-сервиса, получая меньше элементов в каждом вызове. Это может помочь предотвратить истечение времени ожидания вызовов AWS-сервиса.

Примеры использования см. в разделе Постраничный вывод в Руководстве пользователя AWS Command Line Interface.

--max-items (целое число)

Общее количество элементов, которое необходимо вернуть в выводе команды. Если общее количество доступных элементов больше указанного значения, в выводе команды предоставляется NextToken. Для возобновления постраничного вывода укажите значение NextToken в аргументе starting-token последующей команды. Не используйте элемент ответа NextToken напрямую вне AWS CLI.

Примеры использования см. в разделе Постраничный вывод в Руководстве пользователя AWS Command Line Interface.

--generate-cli-skeleton (строка) Выводит JSON-скелет в стандартный вывод без отправки запроса к API. Если предоставлено значение без значения или со значением input, выводит пример входного JSON, который можно использовать в качестве аргумента для --cli-input-json. Аналогично, если предоставлено yaml-input, выведет пример входного YAML, который можно использовать с --cli-input-yaml. Если предоставлено значение output, оно валидирует входные данные команды и возвращает пример выходного JSON для этой команды. Сгенерированный JSON-скелет нестабилен между версиями AWS CLI, и нет гарантии обратной совместимости в сгенерированном JSON-скелете.

Глобальные параметры

--debug (логическое значение)

Включить отладку логирования.

--endpoint-url (строка)

Переопределить URL по умолчанию команды заданным URL.

--no-verify-ssl (логическое значение)

По умолчанию AWS CLI использует SSL при взаимодействии с AWS-сервисами. Для каждого SSL-соединения AWS CLI будет проверять SSL-сертификаты. Этот параметр переопределяет поведение проверки SSL-сертификатов по умолчанию.

--no-paginate (логическое значение)

Отключить автоматический постраничный вывод. Если автоматический постраничный вывод отключен, AWS CLI выполнит только один вызов для первой страницы результатов.

--output (строка)

Стиль форматирования для вывода команды.

  • json
  • text
  • таблица
  • yaml
  • yaml-поток

--query (строка)

Выражение JMESPath для фильтрации данных ответа.

--profile (строка)

Использовать определенный профиль из файла учетных данных.

--region (строка)

Регион для использования. Переопределяет настройки конфигурации/среды.

--version (строка)

Отобразить версию этого инструмента.

--color (строка)

Включить/выключить цветной вывод.

  • включено
  • выключено
  • автоматически

--no-sign-request (логическое значение)

Не подписывать запросы. Учетные данные не будут загружены, если этот аргумент предоставлен.

--ca-bundle (строка)

Файл с набором сертификатов CA для проверки SSL-сертификатов. Переопределяет настройки конфигурации/среды.

--cli-read-timeout (целое число)

Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию составляет 60 секунд.

--cli-connect-timeout (целое число)

Максимальное время подключения сокета в секундах. Если значение установлено в 0, подключение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию составляет 60 секунд.

--cli-binary-format (строка)

Стиль форматирования, используемый для двоичных блоков. Формат по умолчанию — base64. Формат base64 ожидает, что двоичные блоки будут предоставлены как строка, закодированная в base64. Формат raw-in-base64-out сохраняет совместимость с поведением AWS CLI V1, и двоичные значения должны передаваться буквально. При предоставлении содержимого файла, сопоставленного с двоичным блоком, fileb:// всегда будет обрабатываться как двоичный и использовать содержимое файла напрямую независимо от настройки cli-binary-format. При использовании file:// содержимое файла должно быть должным образом отформатировано для настроенного cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (логическое значение)

Отключить постраничный вывод для вывода.

--cli-auto-prompt (логическое значение)

Автоматически запрашивать параметры ввода CLI.

--no-cli-auto-prompt (логическое значение)

Отключить автоматическое запросы параметров ввода CLI.

Вывод

knowledgeBaseSummaries -> (список)

Информация о базах знаний.

(структура)

Сводная информация о базе знаний.

description -> (строка)

Описание базы знаний.

knowledgeBaseArn -> (строка)

Amazon Resource Name (ARN) базы знаний.

knowledgeBaseId -> (строка)

Идентификатор базы знаний. Он не должен быть типом QUICK_RESPONSES, если вы сохраняете в нём ресурсы Wisdom Content.

knowledgeBaseType -> (строка)

Тип базы знаний.

name -> (строка)

Название базы знаний.

renderingConfiguration -> (структура)

Информация о том, как отображать содержимое.

templateUri -> (строка)

Шаблон URI, содержащий ровно одну переменную в формате ${variableName}. Это можно задать только для баз знаний типа EXTERNAL. Для Salesforce, ServiceNow и Zendesk переменная должна быть одной из следующих:

  • Salesforce: Id , ArticleNumber , VersionNumber , Title , PublishStatus или IsDeleted
  • ServiceNow: number , short_description , sys_mod_count , workflow_state или active
  • Zendesk: id , title , updated_at или draft

Переменная заменяется фактическим значением для фрагмента содержимого при вызове GetContent.

serverSideEncryptionConfiguration -> (структура)

Информация о конфигурации для управляемого клиентом ключа, используемого для шифрования.

Этот ключ KMS должен иметь политику, разрешающую kms:CreateGrant , kms:DescribeKey и kms:Decrypt/kms:GenerateDataKey разрешения для идентичности IAM, использующей ключ для вызова Wisdom.

Дополнительную информацию о настройке управляемого клиентом ключа для Wisdom см. в разделе Включить Amazon Connect Wisdom для вашего экземпляра .

kmsKeyId -> (строка)

Используемый управляемый клиентом ключ для шифрования. Дополнительную информацию о настройке управляемого клиентом ключа для Wisdom см. в разделе Включить Amazon Connect Wisdom для вашего экземпляра . Сведения о допустимых значениях ID см. в разделе Идентификаторы ключей (KeyId).

sourceConfiguration -> (структура объединённых тегов)

Конфигурационная информация об внешнем источнике данных.

Примечание

Это структура объединённых тегов. Только один из следующих верхнеуровневых ключей может быть задан: appIntegrations.

appIntegrations -> (структура)

Конфигурационная информация для Amazon AppIntegrations для автоматического извлечения содержимого.

appIntegrationArn -> (строка)

Amazon Resource Name (ARN) интеграции данных AppIntegrations для использования при извлечении содержимого.

  • Для Salesforce ваша интеграция данных AppIntegrations должна иметь ObjectConfiguration, если objectFields не задана, включая по меньшей мере Id , ArticleNumber , VersionNumber , Title , PublishStatus и IsDeleted в качестве исходных полей.
  • Для ServiceNow ваша интеграция данных AppIntegrations должна иметь ObjectConfiguration, если objectFields не задана, включая по меньшей мере number , short_description , sys_mod_count , workflow_state и active в качестве исходных полей.
  • Для Zendesk ваша интеграция данных AppIntegrations должна иметь ObjectConfiguration, если objectFields не задана, включая по меньшей мере id , title , updated_at и draft в качестве исходных полей.
  • Для SharePoint ваша интеграция данных AppIntegrations должна иметь FileConfiguration, включая только расширения файлов, которые находятся среди docx , pdf , html , htm и txt .
  • Для Amazon S3 ObjectConfiguration и FileConfiguration вашей интеграции данных AppIntegrations должны быть null. SourceURI вашей интеграции данных должен использовать следующий формат: s3://your_s3_bucket_name .

Предупреждение

Политика ведра соответствующего ведра S3 должна разрешать Amazon Web Services принципал app-integrations.amazonaws.com выполнять s3:ListBucket , s3:GetObject и s3:GetBucketLocation для ведра.

objectFields -> (список)

Поля из источника, которые предоставляются вашим агентам в Wisdom. Необязательно, если ObjectConfiguration включён в предоставленную интеграцию данных.

  • Для Salesforce вы должны включить по меньшей мере Id , ArticleNumber , VersionNumber , Title , PublishStatus и IsDeleted .
  • Для ServiceNow вы должны включить по меньшей мере number , short_description , sys_mod_count , workflow_state и active .
  • Для Zendesk вы должны включить по меньшей мере id , title , updated_at и draft .

Убедитесь, что вы включили дополнительные поля. Эти поля индексируются и используются для получения рекомендаций.

(строка)

status -> (строка)

Состояние сводки базы знаний.

tags -> (карта)

Теги, используемые для организации, отслеживания или управления доступом к этому ресурсу.

key -> (строка)

value -> (строка)

nextToken -> (строка)

Если существуют дополнительные результаты, это маркер для следующего набора результатов.

© Copyright 2025, Amazon Web Services. Created using Sphinx.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API