Spec-Zone.ru › AWS CLI v2

[ aws . cloudsearch ]

describe-availability-options

Описание

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

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

Синтаксис

  describe-availability-options
--domain-name <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 (строка)

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

--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
  • таблица
  • 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 для вывода.

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

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

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

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

Вывод

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

Настроенные параметры доступности для домена. Указывает, включен ли Multi-AZ для домена.

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

Настроенные параметры доступности для домена.

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