describe-alarm-model

Описание

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

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

Синтаксис

  describe-alarm-model
--alarm-model-name <value>
[--alarm-model-version <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 (строка)

Имя модели тревоги.

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

Версия модели тревоги.

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

Вывод

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

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

alarmModelArn -> (строка)

ARN модели тревоги. Для получения дополнительной информации см. Amazon Resource Names (ARN) в разделе AWS General Reference.

alarmModelVersion -> (строка)

Версия модели тревоги.

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

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

status -> (строка)

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

ACTIVE - Модель тревоги активна и готова к оценке данных.
ACTIVATING - AWS IoT Events активирует вашу модель тревоги. Активация модели тревоги может занять до нескольких минут.
INACTIVE - Модель тревоги неактивна, поэтому она не готова к оценке данных. Проверьте информацию о модели тревоги и обновите её.
FAILED - Не удалось создать или обновить модель тревоги. Проверьте информацию о модели тревоги и повторите попытку.

statusMessage -> (строка)

Содержит информацию о состоянии модели тревоги.

alarmModelName -> (строка)

Имя модели тревоги.

alarmModelDescription -> (строка)

Описание модели тревоги.

roleArn -> (строка)

ARN IAM-роли, позволяющей тревоге выполнять действия и получать доступ к AWS-ресурсам. Для получения дополнительной информации см. Amazon Resource Names (ARN) в разделе AWS General Reference.

key -> (строка)

Атрибут ввода, используемый в качестве ключа для создания тревоги. AWS IoT Events маршрутизирует вводы, связанные с этим ключом, в тревогу.

severity -> (целое число)

Целое неотрицательное число, отражающее уровень серьезности тревоги.

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

Определяет, когда ваша тревога инициируется.

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

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

inputProperty -> (строка)

Значение слева от оператора сравнения. Вы можете указать атрибут ввода AWS IoT Events как свойство ввода.

comparisonOperator -> (строка)

Оператор сравнения.

threshold -> (строка)

Значение справа от оператора сравнения. Вы можете ввести число или указать атрибут ввода AWS IoT Events.

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

Содержит информацию об одном или нескольких действиях уведомления.

notificationActions -> (список)

Содержит настройки уведомления модели тревоги. Настройки применяются ко всем тревогам, созданным на основе этой модели тревоги.

(структура)

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

Указывает AWS Lambda-функцию для управления уведомлениями о тревоге. Вы можете создать одну или использовать предоставленную AWS IoT Events AWS Lambda-функцию.

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

Вызывает Lambda-функцию, передавая информацию о модели экземпляра детектора и событии, которое инициировало действие.

functionArn -> (строка)

ARN Lambda-функции, которая выполняется.

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

Вы можете настроить содержимое полезной нагрузки при отправке сообщения в Lambda-функцию.

contentExpression -> (строка)

Содержимое полезной нагрузки. Вы можете использовать строковое выражение, включающее строковые литералы ('<string>'), переменные ($variable.<variable-name>), значения ввода ($input.<input-name>.<path-to-datum>), конкатенации строк и строковые литералы, содержащие ${} в качестве содержимого. Рекомендуемый максимальный размер выражения содержимого - 1 КБ.

type -> (строка)

Значение типа полезной нагрузки может быть либо STRING, либо JSON.

smsConfigurations -> (список)

Содержит конфигурационную информацию об SMS-уведомлениях.

(структура)

Содержит конфигурационную информацию об SMS-уведомлениях.

senderId -> (строка)

Идентификатор отправителя.

additionalMessage -> (строка)

Сообщение, которое вы хотите отправить. Сообщение может быть длиной до 200 символов.

recipients -> (список)

Указывает одного или нескольких получателей, которые получат сообщение.

Предупреждение

Вы должны добавить пользователей, которые получают SMS-сообщения, в свой магазин AWS SSO.

(структура)

Информация, идентифицирующая получателя.

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

Информация об аутентификации AWS Single Sign-On (AWS SSO).

identityStoreId -> (строка)

Идентификатор хранилища идентичности AWS SSO.

userId -> (строка)

Идентификатор пользователя.

emailConfigurations -> (список)

Содержит конфигурационную информацию об электронных письмах.

(структура)

Содержит конфигурационную информацию об электронных письмах.

from -> (строка)

Адрес электронной почты, отправляющий электронные письма.

Предупреждение

Если вы используете управляемую AWS IoT Events AWS Lambda-функцию для управления электронными письмами, вы должны верифицировать адрес электронной почты, отправляющий электронные письма в Amazon SES.

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

Содержит тему и сообщение электронного письма.

subject -> (строка)

Тема электронного письма.

additionalMessage -> (строка)

Сообщение, которое вы хотите отправить. Сообщение может быть длиной до 200 символов.

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

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

Предупреждение

Вы должны добавить пользователей, которые получают электронные письма, в свой магазин AWS SSO.

to -> (список)

Указывает одного или нескольких получателей, которые получат электронное письмо.

(структура)

Информация, идентифицирующая получателя.

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

Информация об аутентификации AWS Single Sign-On (AWS SSO).

identityStoreId -> (строка)

Идентификатор хранилища идентичности AWS SSO.

userId -> (строка)

Идентификатор пользователя.

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

Содержит информацию об одном или нескольких действиях тревоги.

alarmActions -> (список)

Указывает одно или несколько поддерживаемых действий для получения уведомлений при изменении состояния тревоги.

(структура)

Указывает одно из следующих действий для получения уведомлений при изменении состояния тревоги.

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

Информация, необходимая для публикации сообщения Amazon SNS.

targetArn -> (строка)

ARN целевого объекта Amazon SNS, куда отправляется сообщение.

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

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

contentExpression -> (строка)

Содержание полезной нагрузки. Вы можете использовать строковое выражение, которое включает в себя строковые литералы ('<string>'), переменные ($variable.<variable-name>), значения входных данных ($input.<input-name>.<path-to-datum>), конкатенацию строк и строковые литералы, содержащие ${} в качестве содержимого. Рекомендуемый максимальный размер выражения для содержимого — 1 КБ.

type -> (строка)

Значение типа полезной нагрузки может быть либо STRING, либо JSON.

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

Информация, необходимая для публикации MQTT-сообщения через брокер сообщений AWS IoT.

mqttTopic -> (строка)

MQTT-тема сообщения. Вы можете использовать строковое выражение, которое включает в себя переменные ($variable.<variable-name>) и значения входных данных ($input.<input-name>.<path-to-datum>) в качестве строки темы.

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

Вы можете настроить полезную нагрузку действия при публикации сообщения в тему AWS IoT Core.

contentExpression -> (строка)

type -> (строка)

Значение типа полезной нагрузки может быть либо STRING, либо JSON.

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

Вызывает функцию Lambda, передавая информацию о экземпляре модели детектора и событии, которое вызвало действие.

functionArn -> (строка)

ARN вызываемой функции Lambda.

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

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

contentExpression -> (строка)

type -> (строка)

Значение типа полезной нагрузки может быть либо STRING, либо JSON.

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

Отправляет входные данные AWS IoT Events, передавая информацию о экземпляре модели детектора и событии, которое вызвало действие.

inputName -> (строка)

Имя входных данных AWS IoT Events, куда отправляются данные.

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

Вы можете настроить полезную нагрузку действия при отправке сообщения в входные данные AWS IoT Events.

contentExpression -> (строка)

type -> (строка)

Значение типа полезной нагрузки может быть либо STRING, либо JSON.

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

Отправляет информацию об экземпляре модели детектора и событии, которое вызвало действие, в очередь Amazon SQS.

queueUrl -> (строка)

URL очереди SQS, куда записываются данные.

useBase64 -> (булево)

Установите значение TRUE, если вы хотите, чтобы данные были закодированы в base64 перед записью в очередь. В противном случае установите значение FALSE.

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

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

contentExpression -> (строка)

type -> (строка)

Значение типа полезной нагрузки может быть либо STRING, либо JSON.

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

Отправляет информацию об экземпляре модели детектора и событии, которое вызвало действие, в поток доставки Amazon Kinesis Data Firehose.

deliveryStreamName -> (строка)

Имя потока доставки Kinesis Data Firehose, куда записываются данные.

separator -> (строка)

Разделитель, используемый для разделения записей, записываемых в поток доставки Kinesis Data Firehose. Допустимые значения: ‘n’ (новая строка), ‘t’ (табуляция), ‘rn’ (новая строка Windows), ‘,’ (запятая).

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

Вы можете настроить полезную нагрузку действия при отправке сообщения в поток доставки Amazon Kinesis Data Firehose.

contentExpression -> (строка)

type -> (строка)

Значение типа полезной нагрузки может быть либо STRING, либо JSON.

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

Определяет действие для записи в таблицу Amazon DynamoDB, которую вы создали. Стандартная полезная нагрузка действия содержит всю информацию об экземпляре модели детектора и событии, которое вызвало действие. Вы можете настроить полезную нагрузку. Один столбец таблицы DynamoDB получает все пары атрибут-значение в полезной нагрузке, которую вы указываете.

Вы должны использовать выражения для всех параметров в DynamoDBAction. Выражения принимают литералы, операторы, функции, ссылки и шаблоны подстановки.

Примеры

Для литеральных значений выражения должны содержать одинарные кавычки. Например, значение параметра hashKeyType может быть 'STRING'.
Для ссылок вы должны указать переменные или входные значения. Например, значение параметра hashKeyField может быть $input.GreenhouseInput.name.
Для шаблона подстановки вы должны использовать ${}, и шаблон должен быть в одинарных кавычках. Шаблон подстановки также может содержать комбинацию литералов, операторов, функций, ссылок и шаблонов подстановки. В следующем примере значение параметра hashKeyValue использует шаблон подстановки. '${$input.GreenhouseInput.temperature * 6 / 5 + 32} in Fahrenheit'
Для конкатенации строк вы должны использовать +. Конкатенация строк также может содержать комбинацию литералов, операторов, функций, ссылок и шаблонов подстановки. В следующем примере значение параметра tableName использует конкатенацию строк. 'GreenhouseTemperatureTable ' + $input.GreenhouseInput.date

Дополнительную информацию см. в разделе Выражения в руководстве разработчика AWS IoT Events.

Если определенный тип полезной нагрузки — строка, DynamoDBAction записывает данные, не являющиеся JSON, в таблицу DynamoDB в виде двоичных данных. Консоль DynamoDB отображает данные как текст в кодировке Base64. Значение параметра payloadField равно <payload-field>_raw.

hashKeyType -> (строка)

Тип данных для хэш-ключа (также называемого ключом раздела). Вы можете указать следующие значения:

'STRING' — хэш-ключ — строка.
'NUMBER' — хэш-ключ — число.

Если вы не указываете hashKeyType, значение по умолчанию — 'STRING'.

hashKeyField -> (строка)

Имя хэш-ключа (также называемого ключом раздела). Значение hashKeyField должно соответствовать ключу раздела целевой таблицы DynamoDB.

hashKeyValue -> (строка)

Значение хэш-ключа (также называемого ключом раздела).

rangeKeyType -> (строка)

Тип данных для ключа диапазона (также называемого сортировочным ключом). Вы можете указать следующие значения:

'STRING' — ключ диапазона — строка.
'NUMBER' — ключ диапазона — число.

Если вы не указываете rangeKeyField, значение по умолчанию — 'STRING'.

rangeKeyField -> (строка)

Имя ключа диапазона (также называемого сортировочным ключом). Значение rangeKeyField должно соответствовать сортировочному ключу целевой таблицы DynamoDB.

rangeKeyValue -> (строка)

Значение ключа диапазона (также называемого сортировочным ключом).

operation -> (строка)

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

'INSERT' — вставка данных как нового элемента в таблицу DynamoDB. Этот элемент использует указанный хэш-ключ в качестве ключа раздела. Если вы указали ключ диапазона, элемент использует ключ диапазона в качестве сортировочного ключа.
'UPDATE' — обновление существующего элемента таблицы DynamoDB с новыми данными. Ключ раздела этого элемента должен соответствовать указанному хэш-ключу. Если вы указали ключ диапазона, ключ диапазона должен соответствовать сортировочному ключу элемента.
'DELETE' — удаление существующего элемента из таблицы DynamoDB. Ключ раздела этого элемента должен соответствовать указанному хэш-ключу. Если вы указали ключ диапазона, ключ диапазона должен соответствовать сортировочному ключу элемента.

Если этот параметр не указан, AWS IoT Events выполняет операцию 'INSERT'.

payloadField -> (строка)

Имя столбца DynamoDB, который получает полезную нагрузку действия.

Если этот параметр не указан, имя столбца DynamoDB — payload.

tableName -> (строка)

Имя таблицы DynamoDB. Значение tableName должно соответствовать имени таблицы целевой таблицы DynamoDB.

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

Информация, необходимая для настройки полезной нагрузки.

По умолчанию AWS IoT Events генерирует стандартную полезную нагрузку в формате JSON для любого действия. Эта полезная нагрузка действия содержит все пары атрибут-значение, которые содержат информацию об экземпляре модели детектора и событии, вызвавшем действие. Для настройки полезной нагрузки действия вы можете использовать contentExpression.

contentExpression -> (строка)

Содержимое полезной нагрузки. Вы можете использовать строковое выражение, которое включает в себя строковые литералы ('<string>'), переменные ($variable.<variable-name>), входные значения ($input.<input-name>.<path-to-datum>), конкатенации строк и строковые литералы, которые содержат ${} в качестве содержимого. Рекомендуемый максимальный размер выражения содержимого — 1 КБ.

type -> (строка)

Значение типа полезной нагрузки может быть либо STRING, либо JSON.

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

Определяет действие для записи в таблицу Amazon DynamoDB, которую вы создали. Полезная нагрузка действия по умолчанию содержит всю информацию об экземпляре модели детектора и событии, которое вызвало действие. Вы можете настроить полезную нагрузку. Отдельный столбец таблицы DynamoDB получает одну пару атрибут-значение в полезной нагрузке, которую вы указываете.

Вы должны использовать выражения для всех параметров в DynamoDBv2Action. Выражения принимают литералы, операторы, функции, ссылки и шаблоны подстановки.

Примеры

Для литеральных значений выражения должны содержать одинарные кавычки. Например, значение параметра tableName может быть 'GreenhouseTemperatureTable'.
Для ссылок вы должны указать переменные или входные значения. Например, значение параметра tableName может быть $variable.ddbtableName.
Для шаблона подстановки вы должны использовать ${}, и шаблон должен быть в одинарных кавычках. Шаблон подстановки также может содержать комбинацию литералов, операторов, функций, ссылок и шаблонов подстановки. В следующем примере значение параметра contentExpression в Payload использует шаблон подстановки. '{\"sensorID\": \"${$input.GreenhouseInput.sensor_id}\", \"temperature\": \"${$input.GreenhouseInput.temperature * 9 / 5 + 32}\"}'
Для конкатенации строк вы должны использовать +. Конкатенация строк также может содержать комбинацию литералов, операторов, функций, ссылок и шаблонов подстановки. В следующем примере значение параметра tableName использует конкатенацию строк. 'GreenhouseTemperatureTable ' + $input.GreenhouseInput.date

Значение параметра type в Payload должно быть JSON.

tableName -> (строка)

Имя таблицы DynamoDB.

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

Информация, необходимая для настройки полезной нагрузки.

contentExpression -> (строка)

type -> (строка)

Значение типа полезной нагрузки может быть либо STRING, либо JSON.

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

Отправляет информацию о модели детектора, экземпляре и событии, которое вызвало действие, в указанное свойство актива в AWS IoT SiteWise.

Вы должны использовать выражения для всех параметров в IotSiteWiseAction. Выражения принимают литералы, операторы, функции, ссылки и шаблоны подстановок.

Примеры

Для литеральных значений выражения должны содержать одинарные кавычки. Например, значение для параметра propertyAlias может быть '/company/windfarm/3/turbine/7/temperature'.
Для ссылок вы должны указать либо переменные, либо входные значения. Например, значение для параметра assetId может быть $input.TurbineInput.assetId1.
Для шаблона подстановки вы должны использовать ${}, а шаблон должен быть в одинарных кавычках. Шаблон подстановки также может содержать комбинацию литералов, операторов, функций, ссылок и шаблонов подстановок. В следующем примере значение для параметра propertyAlias использует шаблон подстановки. 'company/windfarm/${$input.TemperatureInput.sensorData.windfarmID}/turbine/ ${$input.TemperatureInput.sensorData.turbineID}/temperature'

Вы должны указать либо propertyAlias, либо оба assetId и propertyId для идентификации целевого свойства актива в AWS IoT SiteWise.

Дополнительную информацию см. в разделе Выражения в руководстве разработчика AWS IoT Events.

entryId -> (строка)

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

assetId -> (строка)

Идентификатор актива, у которого есть указанное свойство.

propertyId -> (строка)

Идентификатор свойства актива.

propertyAlias -> (строка)

Псевдоним свойства актива.

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

Значение, которое нужно отправить в свойство актива. Это значение содержит информацию о времени, качестве и значении (TQV).

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

Значение, которое нужно отправить в свойство актива.

stringValue -> (строка)

Значение свойства актива — строка. Вы должны использовать выражение, и результат вычисления должен быть строкой.

integerValue -> (строка)

Значение свойства актива — целое число. Вы должны использовать выражение, и результат вычисления должен быть целым числом.

doubleValue -> (строка)

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

booleanValue -> (строка)

Значение свойства актива — значение булевого типа, которое должно быть 'TRUE' или 'FALSE'. Вы должны использовать выражение, и результат вычисления должен быть булевым значением.

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

Отметка времени, связанная со значением свойства актива. По умолчанию — текущее время события.

timeInSeconds -> (строка)

Отметка времени в секундах в формате эпохи Unix. Допустимый диапазон от 1 до 31556889864403199.

offsetInNanos -> (строка)

Наносекундный сдвиг, преобразованный из timeInSeconds. Допустимый диапазон от 0 до 999999999.

quality -> (строка)

Качество значения свойства актива. Значение должно быть 'GOOD', 'BAD' или 'UNCERTAIN'.

END_OF_DOCUMENT_MARKER