Spec-Zone.ru › AWS CLI v2

[ aws . iotevents ]

обновить-модель-сигнализации

Описание

Обновляет модель сигнализации. Любые сигнальные тревоги, созданные на основе предыдущей версии, удаляются, а затем создаются заново по мере поступления новых данных.

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

Синтаксис

  update-alarm-model
--alarm-model-name <value>
[--alarm-model-description <value>]
--role-arn <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 (ARN) в разделе Общие сведения об AWS.

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

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

(структура)

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

from -> (строка)

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

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

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

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

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

subject -> (строка)

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

additionalMessage -> (строка)

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

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

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

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

Вы должны добавить пользователей, получающих электронные письма, в свой хранилище 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 -> (структура)

Вы можете настроить полезную нагрузку действия при отправке сообщения в виде push-уведомления 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, которую вы создали. Стандартная полезная нагрузка действия содержит всю информацию об экземпляре модели детектора и событии, которое вызвало действие. Вы можете настроить полезную нагрузку.

Для всех параметров в 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'

Вы должны указать либо 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' .

Синтаксис 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-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 — Не удалось создать или обновить модель тревоги. Проверьте информацию о вашей модели тревоги и повторите попытку.

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

Spec-Zone.ru

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