[ aws . iotevents-данные ]
describe-alarm
Описание
Получает информацию об тревоге.
См. также: Документацию API AWS
Синтаксис
describe-alarm
--alarm-model-name <value>
[--key-value <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 (строка)
--key-value (строка)
--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.
Вывод
alarm -> (структура)
Содержит информацию об тревоге.
alarmModelName -> (строка)
alarmModelVersion -> (строка)
keyValue -> (строка)
alarmState -> (структура)
Содержит информацию о текущем состоянии тревоги.
stateName -> (строка)
Имя состояния тревоги. Имя состояния может быть одним из следующих значений:
-
DISABLED- Когда тревога находится в состоянииDISABLED, она не готова для оценки данных. Чтобы включить тревогу, необходимо изменить её состояние наNORMAL. -
NORMAL- Когда тревога находится в состоянииNORMAL, она готова для оценки данных. -
ACTIVE- Если тревога находится в состоянииACTIVE, тревога вызвана. -
ACKNOWLEDGED- Когда тревога находится в состоянииACKNOWLEDGED, тревога была вызвана, и вы подтвердили её. -
SNOOZE_DISABLED- Когда тревога находится в состоянииSNOOZE_DISABLED, тревога отключена на определённый период времени. После времени отсрочки тревога автоматически переходит в состояниеNORMAL. -
LATCHED- Когда тревога находится в состоянииLATCHED, тревога была вызвана. Однако данные, которые тревога в данный момент оценивает, находятся в заданном диапазоне. Чтобы изменить состояние тревоги наNORMAL, необходимо подтвердить тревогу.
ruleEvaluation -> (структура)
Информация, необходимая для оценки данных.
simpleRuleEvaluation -> (структура)
Информация, необходимая для сравнения двух значений с оператором сравнения.
inputPropertyValue -> (строка)
operator -> (строка)
thresholdValue -> (строка)
customerAction -> (структура)
Содержит информацию об действии, которое вы можете выполнить для ответа на тревогу.
actionName -> (строка)
Имя действия. Имя действия может быть одним из следующих значений:
-
SNOOZE- Когда вы откладываете тревогу, состояние тревоги меняется наSNOOZE_DISABLED. -
ENABLE- Когда вы включаете тревогу, состояние тревоги меняется наNORMAL. -
DISABLE- Когда вы отключаете тревогу, состояние тревоги меняется наDISABLED. -
ACKNOWLEDGE- Когда вы подтверждаете тревогу, состояние тревоги меняется наACKNOWLEDGED. -
RESET- Когда вы сбрасываете тревогу, состояние тревоги меняется наNORMAL.
Для получения дополнительной информации см. API AlarmState.
snoozeActionConfiguration -> (структура)
Содержит конфигурационную информацию действия отсрочки.
snoozeDuration -> (целое число)
NORMAL после этого периода.note -> (строка)
enableActionConfiguration -> (структура)
Содержит конфигурационную информацию действия включения.
note -> (строка)
disableActionConfiguration -> (структура)
Содержит конфигурационную информацию действия отключения.
note -> (строка)
acknowledgeActionConfiguration -> (структура)
Содержит конфигурационную информацию действия подтверждения.
note -> (строка)
resetActionConfiguration -> (структура)
Содержит конфигурационную информацию действия сброса.
note -> (строка)
systemEvent -> (структура)
Содержит информацию о изменениях состояния тревоги.
eventType -> (строка)
STATE_CHANGE, событие содержит информацию об изменениях состояния тревоги.stateChangeConfiguration -> (структура)
Содержит конфигурационную информацию о изменениях состояния тревоги.
triggerType -> (строка)
SNOOZE_TIMEOUT, время отсрочки заканчивается, и тревога автоматически переходит в состояние NORMAL.severity -> (целое число)
creationTime -> (метка времени)
lastUpdateTime -> (метка времени)
© Copyright 2025, Amazon Web Services. Created using Sphinx.