Spec-Zone.ru › AWS CLI v2

[ aws . iotevents-data ]

list-alarms

Описание

Перечисляет один или несколько срабатываний. Операция возвращает только метаданные, связанные с каждым срабатыванием.

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

Синтаксис

  list-alarms
--alarm-model-name <value>
[--next-token <value>]
[--max-results <value>]
[--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]

Параметры

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

Имя модели срабатывания.

--next-token (строка)

Токен, который можно использовать для возвращения следующего набора результатов.

--max-results (целое число)

Максимальное количество результатов, возвращаемых за один запрос.

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

Вывод

alarmSummaries -> (список)

Список, обобщающий каждое срабатывание.

(структура)

Содержит сводку о срабатывании.

alarmModelName -> (строка)

Имя модели срабатывания.

alarmModelVersion -> (строка)

Версия модели срабатывания.

keyValue -> (строка)

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

stateName -> (строка)

Имя состояния срабатывания. Имя состояния может быть одним из следующих значений:

  • DISABLED - Когда срабатывание находится в состоянии DISABLED, оно не готово к оценке данных. Чтобы включить срабатывание, необходимо изменить его состояние на NORMAL.
  • NORMAL - Когда срабатывание находится в состоянии NORMAL, оно готово к оценке данных.
  • ACTIVE - Если срабатывание находится в состоянии ACTIVE, срабатывание выполнено.
  • ACKNOWLEDGED - Когда срабатывание находится в состоянии ACKNOWLEDGED, срабатывание было выполнено, и вы подтвердили срабатывание.
  • SNOOZE_DISABLED - Когда срабатывание находится в состоянии SNOOZE_DISABLED, срабатывание отключено на определенный период времени. По истечении времени отсрочки срабатывание автоматически переходит в состояние NORMAL.
  • LATCHED - Когда срабатывание находится в состоянии LATCHED, срабатывание было выполнено. Однако данные, которые срабатывание в настоящее время оценивает, находятся в заданном диапазоне. Чтобы изменить состояние срабатывания на NORMAL, необходимо подтвердить срабатывание.

creationTime -> (временная метка)

Время создания срабатывания в формате эпохи Unix.

lastUpdateTime -> (временная метка)

Время последнего обновления срабатывания в формате эпохи Unix.

nextToken -> (строка)

Токен, который можно использовать для возвращения следующего набора результатов, или null, если больше результатов нет.

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

Spec-Zone.ru

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