Spec-Zone.ru › AWS CLI v2

[ aws . cloudsearch ]

получить-настройку-предложений

Описание

Получает настройки предложений для домена. Предложение позволяет отображать возможные совпадения, прежде чем пользователи закончат вводить свои запросы. Можно ограничиться определёнными предложениями по имени. По умолчанию отображаются все предложения и включаются все ожидаемые изменения конфигурации. Установите опцию Deployed в значение true, чтобы отобразить активную конфигурацию и исключить ожидаемые изменения. Дополнительную информацию см. в разделе Получение поисковых предложений в руководстве разработчика Amazon CloudSearch.

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

Синтаксис

  describe-suggesters
--domain-name <value>
[--suggester-names <value>]
[--deployed | --no-deployed]
[--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]

Параметры

--domain-name (строка)

Имя домена, который нужно описать.

--suggester-names (список)

Предложения, которые нужно описать.

(строка)

Имена должны начинаться с буквы и могут содержать следующие символы: a-z (строчные буквы), 0-9 и _ (нижнее подчеркивание).

Синтаксис:

"string" "string" ...

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

Отображать ли развернутую конфигурацию (true ) или включать ожидаемые изменения (false ). По умолчанию значение false.

--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
  • text
  • table
  • yaml
  • yaml-stream

--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.

Вывод

Предложения -> (список)

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

(структура)

Значение Suggester и его текущий статус.

Параметры -> (структура)

Информация о конфигурации поискового предложения. Каждое предложение имеет уникальное имя и указывает текстовое поле, которое необходимо использовать для предложений. Для предложения можно настроить следующие параметры: FuzzyMatching , SortExpression .

ИмяПредложения -> (строка)

Имена должны начинаться с буквы и могут содержать следующие символы: a-z (строчные буквы), 0-9 и _ (нижнее подчеркивание).

ДокументПредложениеПараметры -> (структура)

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

ПолеИсточника -> (строка)

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

РазмытоеСовпадение -> (строка)

Уровень размытости, допускаемый при подборе совпадений для строки: none , low или high. При значении none заданная строка обрабатывается как точный префикс. При значении low предложения должны отличаться от заданной строки не более чем на один символ. При значении high предложения могут отличаться до двух символов. Значение по умолчанию none.

ВыражениеСортировки -> (строка)

Выражение, которое вычисляет рейтинг каждого предложения для управления порядком их сортировки. Рейтинги округляются до ближайшего целого числа, с нижней границей 0 и верхней границей 2^31-1. Рейтинг релевантности документа не вычисляется для предложений, поэтому выражения сортировки не могут ссылаться на значение _score. Для сортировки предложений с использованием числового поля или существующего выражения просто укажите имя поля или выражения. Если для предложения не настроено выражение, предложения сортируются так, что ближайшие совпадения отображаются в первую очередь.

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

Статус параметра конфигурации домена.

ДатаСоздание -> (временная метка)

Временная метка для момента создания этого параметра.

ДатаОбновления -> (временная метка)

Временная метка для момента последнего обновления этого параметра.

ВерсияОбновления -> (целое число)

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

Состояние -> (строка)

Состояние обработки изменения параметра. Возможные значения:

  • RequiresIndexDocuments : последнее значение параметра не будет развернуто до тех пор, пока не будет вызван IndexDocuments, и индексирование не будет завершено.
  • Processing : последнее значение параметра находится в процессе активации.
  • Active : последнее значение параметра полностью развернуто.
  • FailedToValidate : значение параметра несовместимо с данными домена и не может использоваться для индексирования данных. Необходимо либо изменить значение параметра, либо обновить или удалить несовместимые документы.

ОжидаемоеУдаление -> (логическое значение)

Указывает, что параметр будет удалён после завершения обработки.

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

Spec-Zone.ru

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