Spec-Zone.ru › AWS CLI v2

[ aws . kendra ]

Список списков блокировок для предложений по запросам

Описание

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

Сведения о текущих ограничениях квот для списков блокировок см. в разделе Квоты Amazon Kendra.

ListQuerySuggestionsBlockLists в настоящее время не поддерживается в регионе Amazon Web Services GovCloud (US-West).

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

Синтаксис

  list-query-suggestions-block-lists
--index-id <value>
[--next-token <value>]
[--max-results <value>]
[--cli-input-json | --cli-input-yaml]
[--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]

Параметры

--index-id (строка)

Идентификатор индекса для получения списка всех списков блокировок, существующих для этого индекса.

Сведения о текущих ограничениях квот для списков блокировок см. в разделе Квоты Amazon Kendra.

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

Если предыдущий ответ был неполным (поскольку требуется получение дополнительных данных), Amazon Kendra возвращает маркер пагинации в ответе. Вы можете использовать этот маркер пагинации для получения следующего набора списков блокировок (BlockListSummaryItems).

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

Максимальное количество списков блокировок для возврата.

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

--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 (булево)

Отключить тулбар AWS CLI для вывода.

--cli-auto-prompt (булево)

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

--no-cli-auto-prompt (булево)

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

Вывод

BlockListSummaryItems -> (список)

Сводные данные для списка блокировок.

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

Сведения о текущих ограничениях квот для списков блокировок см. в разделе Квоты Amazon Kendra.

(структура)

Сводная информация о списке блокировок предложений по запросам.

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

Сведения о текущих ограничениях квот для списков блокировок см. в разделе Квоты Amazon Kendra.

Id -> (строка)

Идентификатор списка блокировок.

Name -> (строка)

Имя списка блокировок.

Status -> (строка)

Статус списка блокировок.

CreatedAt -> (временная метка)

Временная метка Unix, когда был создан список блокировок.

UpdatedAt -> (временная метка)

Временная метка Unix, когда список блокировок был последний раз обновлен.

ItemCount -> (целое число)

Количество элементов в файле списка блокировок.

NextToken -> (строка)

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

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

Spec-Zone.ru

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