[ aws . cloudwatch . wait ]
composite-alarm-exists
Описание
Ожидайте, пока длина запроса JMESPath(CompositeAlarms[]) > 0 вернёт True при опросе с помощью describe-alarms. Он будет опрашивать каждые 5 секунд, пока не будет достигнут успешный статус. Этот процесс завершится с кодом возврата 255 после 40 неудачных проверок.
См. также: Документация API AWS
composite-alarm-exists является постраничной операцией. Для получения всего набора результатов могут быть вызваны несколько API-запросов. Вы можете отключить постраничную обработку, предоставив аргумент --no-paginate. При использовании --output text и аргумента --query в ответ на постраничную обработку аргумент --query должен извлечь данные из результатов следующих выражений запроса: MetricAlarms, CompositeAlarms
Синтаксис
composite-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 (строка)
Укажите этот параметр, чтобы получить информацию только о тревогах, которые находятся в указанном состоянии.
Возможные значения:
OKALARMINSUFFICIENT_DATA
--action-prefix (строка)
--cli-input-json | --cli-input-yaml (строка) Считывает аргументы из предоставленной JSON-строки. JSON-строка соответствует формату, предоставленному --generate-cli-skeleton. Если другие аргументы предоставлены в командной строке, эти значения переопределят значения, предоставленные JSON. Невозможно передавать произвольные двоичные значения с помощью JSON-значения, так как строка будет воспринята буквально. Это не может быть указано вместе с --cli-input-yaml.
--starting-token (строка)
Токен для указания точки начала постраничной обработки. Это NextToken из ранее усечённого ответа.
Примеры использования см. в разделе Постраничная обработка в руководстве пользователя AWS CLI.
--page-size (целое число)
Размер каждой страницы при вызове AWS-сервиса. Это не влияет на количество элементов, возвращаемых в выводе команды. Установка меньшего размера страницы приводит к большему количеству вызовов AWS-сервиса, извлекая меньшее количество элементов в каждом вызове. Это может помочь предотвратить таймаут вызовов AWS-сервиса.
Примеры использования см. в разделе Постраничная обработка в руководстве пользователя AWS CLI.
--max-items (целое число)
Общее количество элементов, которое должно быть возвращено в выводе команды. Если общее количество доступных элементов больше указанного значения, в выводе команды предоставляется NextToken. Чтобы возобновить постраничную обработку, предоставьте значение NextToken в аргументе starting-token последующей команды. **Не** используйте элемент ответа NextToken непосредственно за пределами AWS CLI.
Примеры использования см. в разделе Постраничная обработка в руководстве пользователя AWS CLI.
--generate-cli-skeleton (строка) Выводит JSON-скелет в стандартный вывод без отправки API-запроса. Если предоставлено значение null или значение 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.
Примеры
Примечание
Для использования следующих примеров необходимо установить и настроить AWS CLI. Дополнительную информацию см. в руководстве «Начало работы» в руководстве пользователя AWS CLI.
Если не указано иное, все примеры используют правила цитирования Unix-подобных систем. Эти примеры необходимо адаптировать к правилам цитирования вашей оболочки. См. раздел Использование кавычек со строками в руководстве пользователя AWS CLI.
Чтобы дождаться существования составной тревоги
Следующий wait composite-alarm-exists пример приостанавливается и возобновляется только после подтверждения существования указанной тревоги CloudWatch.
aws cloudwatch wait composite-alarm-exists \
--alarm-names demo \
--alarm-types CompositeAlarm
Эта команда не производит вывод.
Вывод
Нет
© Copyright 2025, Amazon Web Services. Created using Sphinx.