Spec-Zone.ru › AWS CLI v2

[ aws . cloudsearch ]

describe-expressions

Описание

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

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

Синтаксис

  describe-expressions
--domain-name <value>
[--expression-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 (строка)

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

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

Ограничивает ответ `` DescribeExpressions`` указанными выражениями. Если не указано, отображаются все выражения.

(строка)

Имена должны начинаться с буквы и могут содержать следующие символы: 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
  • текст
  • таблица
  • 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 версии 1, и двоичные значения должны передаваться буквально. При предоставлении содержимого файла, которое соответствует двоичным данным, fileb:// всегда будет обрабатываться как двоичное и будет использовать содержимое файла напрямую независимо от настройки cli-binary-format. При использовании file:// содержимое файла должно быть должным образом отформатировано для настроенного cli-binary-format.

  • base64
  • raw-in-base64-out

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

Отключить страницу CLI для вывода.

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

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

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

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

Вывод

Expressions -> (список)

Настроенные для домена выражения.

(структура)

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

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

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

ExpressionName -> (строка)

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

ExpressionValue -> (строка)

Выражение, которое оценивается для сортировки при обработке запроса поиска. Синтаксис Expression основан на выражениях JavaScript. Дополнительную информацию см. в разделе Настройка выражений в руководстве разработчика Amazon CloudSearch .

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

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

CreationDate -> (метка времени)

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

UpdateDate -> (метка времени)

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

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

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

State -> (строка)

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

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

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

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

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

Spec-Zone.ru

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