Spec-Zone.ru › AWS CLI v2

[ aws . cloudwatch . wait ]

alarm-exists

Описание

Ожидание, пока длина запроса JMESPath (MetricAlarms[]) будет больше 0 и возвращает True при опросе с помощью describe-alarms. Будет производиться опрос каждые 5 секунд до достижения успешного состояния. Код возврата будет 255 после 40 неудачных проверок.

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

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

Синтаксис

  alarm-exists
[--alarm-names <value>]
[--alarm-name-prefix <value>]
[--alarm-types <value>]
[--children-of-alarm-name <value>]
[--parents-of-alarm-name <value>]
[--state-value <value>]
[--action-prefix <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]

Параметры

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

Имена тревог, о которых требуется получить информацию.

(строка)

Синтаксис:

"string" "string" ...

--alarm-name-prefix (строка)

Префикс имени тревоги. Если вы указываете этот параметр, вы получаете информацию обо всех тревогах, имена которых начинаются с этого префикса.

Если этот параметр указан, вы не можете указать AlarmNames.

--alarm-types (список)

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

Например, если вы опустите этот параметр или укажете MetricAlarms, операция вернёт только список метрических тревог. Она не вернёт составные тревоги, даже если они существуют в аккаунте.

Если вы укажете CompositeAlarms, операция вернёт только список составных тревог и не вернёт метрических тревог.

(строка)

Синтаксис:

"string" "string" ...

Where valid values are:
  CompositeAlarm
  MetricAlarm

--children-of-alarm-name (строка)

Если вы используете этот параметр и указываете имя составной тревоги, операция возвращает информацию о «дочерних» тревогах указанной тревоги. Это метрические тревоги и составные тревоги, указанные в поле AlarmRule составной тревоги, которую вы указываете в ChildrenOfAlarmName. Информация о составной тревоге, которую вы указываете в ChildrenOfAlarmName, не возвращается.

Если вы указываете ChildrenOfAlarmName, вы не можете указывать другие параметры в запросе, кроме MaxRecords и NextToken. В противном случае вы получите ошибку валидации.

Примечание

Только информация Alarm Name, ARN, StateValue (OK/ALARM/INSUFFICIENT_DATA) и StateUpdatedTimestamp возвращаются этой операцией при использовании этого параметра. Чтобы получить полную информацию об этих тревогах, выполните другую операцию DescribeAlarms и укажите имена родительских тревог в параметре AlarmNames.

--parents-of-alarm-name (строка)

Если вы используете этот параметр и указываете имя метрической или составной тревоги, операция возвращает информацию о «родительских» тревогах указанной тревоги. Это составные тревоги, которые имеют параметры AlarmRule, которые ссылаются на тревогу, имя которой указано в ParentsOfAlarmName. Информация о тревоге, которую вы указываете в ParentsOfAlarmName, не возвращается.

Если вы указываете ParentsOfAlarmName, вы не можете указывать другие параметры в запросе, кроме MaxRecords и NextToken. В противном случае вы получите ошибку валидации.

Примечание

Только имя и ARN тревоги возвращаются этой операцией при использовании этого параметра. Чтобы получить полную информацию об этих тревогах, выполните другую операцию DescribeAlarms и укажите имена родительских тревог в параметре AlarmNames.

--state-value (строка)

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

Возможные значения:

  • OK
  • ALARM
  • INSUFFICIENT_DATA

--action-prefix (строка)

Используйте этот параметр для фильтрации результатов операции до тех тревог, которые используют определённое действие тревоги. Например, вы можете указать ARN темы SNS, чтобы найти все тревоги, которые отправляют уведомления в эту тему.

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

--query (строка)

Запрос JMESPath для фильтрации данных ответа.

--profile (строка)

Использование определённого профиля из файла учетных данных.

--region (строка)

Используемый регион. Переопределяет настройки конфигурации/среды.

--version (строка)

Отображение версии этого инструмента.

--color (строка)

Включение/выключение цветного вывода.

  • on
  • off
  • auto

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

Примеры

Примечание

Для использования следующих примеров необходимо иметь установленный и настроенный AWS CLI. См. руководство по началу работы в Руководстве пользователя AWS CLI для получения дополнительной информации.

За исключением случаев, когда указано иное, все примеры имеют unix-подобные правила цитирования. Эти примеры необходимо адаптировать к правилам цитирования вашей терминальной оболочки. См. «Использование кавычек со строками» в Руководстве пользователя AWS CLI.

Ожидание существования тревоги

Следующий wait alarm-exists пример приостанавливает и возобновляет выполнение только после подтверждения существования указанной тревоги CloudWatch.

aws cloudwatch wait alarm-exists \
    --alarm-names demo

Эта команда не генерирует вывод.

Вывод

Нет

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

Spec-Zone.ru

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