Spec-Zone.ru › AWS CLI v2

[ aws . wisdom ]

Поиск контента

Описание

Ищет контент в указанной базе знаний. Может использоваться для получения конкретного ресурса контента по его имени.

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

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

Синтаксис

  search-content
--knowledge-base-id <value>
--search-expression <value>
[--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]

Параметры

--knowledge-base-id (строка)

Идентификатор базы знаний. Это не должно быть база знаний типа QUICK_RESPONSES, если вы храните в ней ресурс контента Wisdom. Может быть либо ID, либо ARN. В URL не могут содержаться ARN.

--search-expression (структура)

Выражение поиска для фильтрации результатов.

filters -> (список)

Фильтры выражения поиска.

(структура)

Фильтр поиска.

field -> (строка)

Поле, по которому следует отфильтровать.

operator -> (строка)

Оператор, используемый для сравнения значения поля с предоставленным значением.

value -> (строка)

Желаемое значение поля, по которому следует отфильтровать.

Сокращенный синтаксис:

filters=[{field=string,operator=string,value=string},{field=string,operator=string,value=string}]

Синтаксис JSON:

{
  "filters": [
    {
      "field": "NAME",
      "operator": "EQUALS",
      "value": "string"
    }
    ...
  ]
}

--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
  • текст
  • таблица
  • 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.

Вывод

contentSummaries -> (список)

Сводная информация о содержимом.

(структура)

Сводная информация о содержимом.

contentArn -> (строка)

Amazon Resource Name (ARN) содержимого.

contentId -> (строка)

Идентификатор содержимого.

contentType -> (строка)

Тип носителя содержимого.

knowledgeBaseArn -> (строка)

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

knowledgeBaseId -> (строка)

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

metadata -> (словарь)

Словарь ключ/значение для хранения атрибутов без влияния на тегирование или рекомендации. Например, при синхронизации данных между внешней системой и Wisdom вы можете сохранить идентификатор внешней версии в качестве метаданных, чтобы использовать его для определения отклонения.

key -> (строка)

value -> (строка)

name -> (строка)

Имя содержимого.

revisionId -> (строка)

Идентификатор ревизии содержимого.

status -> (строка)

Статус содержимого.

tags -> (словарь)

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

key -> (строка)

value -> (строка)

title -> (строка)

Название содержимого.

nextToken -> (строка)

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

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

Spec-Zone.ru

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