Spec-Zone.ru › AWS CLI v2

[ aws . iotevents ]

создание-модели-тревоги

Описание

Создает модель тревоги для мониторинга входного атрибута AWS IoT Events. Вы можете использовать тревогу для получения уведомлений, когда значение находится вне заданного диапазона. Дополнительная информация приведена в разделе «Создание модели тревоги» в руководстве разработчика AWS IoT Events.

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

Синтаксис

  create-alarm-model
--alarm-model-name <value>
[--alarm-model-description <value>]
--role-arn <value>
[--tags <value>]
[--key <value>]
[--severity <value>]
--alarm-rule <value>
[--alarm-notification <value>]
[--alarm-event-actions <value>]
[--alarm-capabilities <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-description (строка)

Описание, поясняющее, что обнаруживает модель тревоги.

--role-arn (строка)

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

--tags (список)

Список пар ключ-значение, содержащих метаданные для модели тревоги. Теги помогают управлять моделью тревоги. Дополнительную информацию см. в разделе «Применение тегов к ресурсам AWS IoT Events» в руководстве разработчика AWS IoT Events.

Вы можете создать до 50 тегов для одной модели тревоги.

(структура)

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

ключ -> (строка)

Ключ тега.

значение -> (строка)

Значение тега.

Сокращенный синтаксис:

key=string,value=string ...

Синтаксис JSON:

[
  {
    "key": "string",
    "value": "string"
  }
  ...
]

--key (строка)

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

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

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

--alarm-rule (структура)

Определяет, когда вызывается ваша тревога.

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

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

inputProperty -> (строка)

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

comparisonOperator -> (строка)

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

threshold -> (строка)

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

Сокращенный синтаксис:

simpleRule={inputProperty=string,comparisonOperator=string,threshold=string}

Синтаксис JSON:

{
  "simpleRule": {
    "inputProperty": "string",
    "comparisonOperator": "GREATER"|"GREATER_OR_EQUAL"|"LESS"|"LESS_OR_EQUAL"|"EQUAL"|"NOT_EQUAL",
    "threshold": "string"
  }
}

--alarm-notification (структура)

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

notificationActions -> (список)

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

(структура)

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

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

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

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 -> (список)

Содержит конфигурационную информацию email-уведомлений.

(структура)

Содержит конфигурационную информацию email-уведомлений.

from -> (строка)

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

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

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

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

Содержит тему и сообщение email.

subject -> (строка)

Тема письма.

additionalMessage -> (строка)

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

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

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

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

Вы должны добавить пользователей, получающих email, в свое хранилище AWS SSO.

to -> (список)

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

(структура)

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

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

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

identityStoreId -> (строка)

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

userId -> (строка)

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

Синтаксис JSON:

{
  "notificationActions": [
    {
      "action": {
        "lambdaAction": {
          "functionArn": "string",
          "payload": {
            "contentExpression": "string",
            "type": "STRING"|"JSON"
          }
        }
      },
      "smsConfigurations": [
        {
          "senderId": "string",
          "additionalMessage": "string",
          "recipients": [
            {
              "ssoIdentity": {
                "identityStoreId": "string",
                "userId": "string"
              }
            }
            ...
          ]
        }
        ...
      ],
      "emailConfigurations": [
        {
          "from": "string",
          "content": {
            "subject": "string",
            "additionalMessage": "string"
          },
          "recipients": {
            "to": [
              {
                "ssoIdentity": {
                  "identityStoreId": "string",
                  "userId": "string"
                }
              }
              ...
            ]
          }
        }
        ...
      ]
    }
    ...
  ]
}

--alarm-event-actions (структура)

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

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 -> (строка)

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

type -> (строка)

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

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

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

functionArn -> (строка)

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

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

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

contentExpression -> (строка)

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

type -> (строка)

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

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

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

inputName -> (строка)

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

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

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

contentExpression -> (строка)

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

type -> (строка)

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

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

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

queueUrl -> (строка)

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

useBase64 -> (булево)

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

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

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

contentExpression -> (строка)

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

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 -> (строка)

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

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 -> (структура)

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

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

contentExpression -> (строка)

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

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'

Для определения целевого свойства актива в AWS IoT SiteWise необходимо указать либо propertyAlias, либо оба параметра assetId и propertyId.

Дополнительную информацию см. в разделе Выражения в Руководстве разработчика 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'.

Синтаксис JSON:

{
  "alarmActions": [
    {
      "sns": {
        "targetArn": "string",
        "payload": {
          "contentExpression": "string",
          "type": "STRING"|"JSON"
        }
      },
      "iotTopicPublish": {
        "mqttTopic": "string",
        "payload": {
          "contentExpression": "string",
          "type": "STRING"|"JSON"
        }
      },
      "lambda": {
        "functionArn": "string",
        "payload": {
          "contentExpression": "string",
          "type": "STRING"|"JSON"
        }
      },
      "iotEvents": {
        "inputName": "string",
        "payload": {
          "contentExpression": "string",
          "type": "STRING"|"JSON"
        }
      },
      "sqs": {
        "queueUrl": "string",
        "useBase64": true|false,
        "payload": {
          "contentExpression": "string",
          "type": "STRING"|"JSON"
        }
      },
      "firehose": {
        "deliveryStreamName": "string",
        "separator": "string",
        "payload": {
          "contentExpression": "string",
          "type": "STRING"|"JSON"
        }
      },
      "dynamoDB": {
        "hashKeyType": "string",
        "hashKeyField": "string",
        "hashKeyValue": "string",
        "rangeKeyType": "string",
        "rangeKeyField": "string",
        "rangeKeyValue": "string",
        "operation": "string",
        "payloadField": "string",
        "tableName": "string",
        "payload": {
          "contentExpression": "string",
          "type": "STRING"|"JSON"
        }
      },
      "dynamoDBv2": {
        "tableName": "string",
        "payload": {
          "contentExpression": "string",
          "type": "STRING"|"JSON"
        }
      },
      "iotSiteWise": {
        "entryId": "string",
        "assetId": "string",
        "propertyId": "string",
        "propertyAlias": "string",
        "propertyValue": {
          "value": {
            "stringValue": "string",
            "integerValue": "string",
            "doubleValue": "string",
            "booleanValue": "string"
          },
          "timestamp": {
            "timeInSeconds": "string",
            "offsetInNanos": "string"
          },
          "quality": "string"
        }
      }
    }
    ...
  ]
}

--alarm-capabilities (структура)

Содержит конфигурационную информацию о изменениях состояния тревоги.

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

Определяет состояние тревоги по умолчанию. Конфигурация применяется ко всем тревогам, созданным на основе этой модели тревоги.

disabledOnInitialization -> (булево)

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

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

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

enabled -> (булево)

Значение должно быть TRUE или FALSE. Если TRUE, вы получаете уведомление при изменении состояния тревоги. Вы должны подтвердить уведомление, прежде чем состояние тревоги сможет вернуться к состоянию NORMAL. Если FALSE, уведомления не будут отправляться. Тревога автоматически переходит в состояние NORMAL, когда значение входного свойства возвращается в указанный диапазон.

Сокращенный синтаксис:

initializationConfiguration={disabledOnInitialization=boolean},acknowledgeFlow={enabled=boolean}

Синтаксис JSON:

{
  "initializationConfiguration": {
    "disabledOnInitialization": true|false
  },
  "acknowledgeFlow": {
    "enabled": true|false
  }
}

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

Вывод

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

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

alarmModelArn -> (строка)

ARN модели тревоги. Дополнительную информацию см. в разделе Имена ресурсов Amazon (ARN) в Общей справке AWS.

alarmModelVersion -> (строка)

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

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

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

status -> (строка)

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

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

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

Spec-Zone.ru

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