Spec-Zone.ru › AWS CLI v2

[ aws . iotevents ]

start-detector-model-analysis

Описание

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

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

Синтаксис

  start-detector-model-analysis
--detector-model-definition <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]

Параметры

--detector-model-definition (структура)

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

states -> (список)

Информация о состояниях детектора.

(структура)

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

stateName -> (строка)

Имя состояния.

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

При получении входных данных и значении condition как TRUE, выполните указанное actions.

events -> (список)

Определяет действия, выполняемые, когда condition принимает значение TRUE.

(структура)

Определяет actions, которые необходимо выполнить, когда значение condition равно TRUE.

eventName -> (строка)

Имя события.

condition -> (строка)

Необязательно. Булево выражение, которое, при значении TRUE, вызывает выполнение actions. Если отсутствует, действия выполняются (=TRUE). Если результат выражения не является булевым значением, действия не выполняются (=FALSE).

actions -> (список)

Выполняемые действия.

(структура)

Действие, выполняемое, когда condition имеет значение TRUE.

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

Устанавливает переменную в указанное значение.

variableName -> (строка)

Имя переменной.

value -> (строка)

Новое значение переменной.

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

Отправляет сообщение Amazon SNS.

targetArn -> (строка)

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

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

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

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.

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

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

timerName -> (строка)

Имя таймера.

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

Количество секунд до истечения таймера. Минимальное значение — 60 секунд для обеспечения точности. Максимальное значение — 31622400 секунд.

durationExpression -> (строка)

Продолжительность таймера в секундах. Вы можете использовать строковое выражение, включающее числа, переменные ($variable.<variable-name> ) и значения ввода ($input.<input-name>.<path-to-datum> ) в качестве длительности. Диапазон длительности — от 1 до 31622400 секунд. Для обеспечения точности минимальная длительность составляет 60 секунд. Оценённый результат длительности округляется вниз до ближайшего целого числа.

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

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

timerName -> (строка)

Имя таймера для сброса.

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

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

timerName -> (строка)

Имя таймера для сброса.

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

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

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

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

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.

entryId -> (строка)

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

assetId -> (строка)

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

propertyId -> (строка)

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

propertyAlias -> (строка)

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

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

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

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

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

stringValue -> (строка)

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

integerValue -> (строка)

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

doubleValue -> (строка)

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

booleanValue -> (строка)

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

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

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

timeInSeconds -> (строка)

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

offsetInNanos -> (строка)

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

quality -> (строка)

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

transitionEvents -> (список)

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

(структура)

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

eventName -> (строка)

Название события перехода.

condition -> (строка)

Обязательное. Логическое выражение, которое при значении TRUE вызывает выполнение действий и вхождение в nextState.

actions -> (список)

Действия, которые необходимо выполнить.

(структура)

Действие, которое должно быть выполнено, когда condition равно TRUE.

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

Устанавливает переменную в указанное значение.

variableName -> (строка)

Имя переменной.

value -> (строка)

Новое значение переменной.

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.

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

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

timerName -> (строка)

Имя таймера.

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

Количество секунд до истечения таймера. Минимальное значение составляет 60 секунд для обеспечения точности. Максимальное значение составляет 31622400 секунд.

durationExpression -> (строка)

Продолжительность таймера в секундах. Вы можете использовать строковое выражение, включающее числа, переменные ($variable.<variable-name> ) и значения ввода ($input.<input-name>.<path-to-datum> ) в качестве продолжительности. Диапазон продолжительности составляет от 1 до 31622400 секунд. Для обеспечения точности минимальная продолжительность составляет 60 секунд. Результат оценки продолжительности округляется вниз до ближайшего целого числа.

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

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

timerName -> (строка)

Имя таймера для сброса.

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

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

timerName -> (строка)

Имя таймера для сброса.

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

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

separator -> (строка)

Разделитель символов, используемый для разделения записей, записываемых в поток доставки Amazon 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 -> (структура)

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

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

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

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.

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

nextState -> (строка)

Следующее состояние для перехода.

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

При входе в это состояние выполните эти actions, если condition имеет значение TRUE.

events -> (list)

Определяет действия, которые выполняются при входе в состояние, и если condition имеет значение TRUE.

(structure)

Определяет actions, которые необходимо выполнить, если condition имеет значение TRUE.

eventName -> (string)

Имя события.

condition -> (string)

Необязательно. Булево выражение, которое, при значении TRUE, приводит к выполнению actions. Если отсутствует, действия выполняются (=TRUE). Если результат выражения не является булевым значением, действия не выполняются (=FALSE).

actions -> (list)

Действия, которые необходимо выполнить.

(structure)

Действие, которое необходимо выполнить, если condition имеет значение TRUE.

setVariable -> (structure)

Устанавливает переменную в заданное значение.

variableName -> (string)

Имя переменной.

value -> (string)

Новое значение переменной.

sns -> (structure)

Отправляет сообщение Amazon SNS.

targetArn -> (string)

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

payload -> (structure)

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

contentExpression -> (string)

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

type -> (string)

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

iotTopicPublish -> (structure)

Опубликовывает сообщение MQTT с заданной темой в шлюз сообщений AWS IoT.

mqttTopic -> (string)

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

payload -> (structure)

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

contentExpression -> (string)

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

type -> (string)

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

setTimer -> (structure)

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

timerName -> (string)

Имя таймера.

seconds -> (integer)

Количество секунд до истечения таймера. Минимальное значение — 60 секунд для обеспечения точности. Максимальное значение — 31622400 секунд.

durationExpression -> (string)

Длительность таймера в секундах. Вы можете использовать строковое выражение, которое включает числа, переменные ($variable.<variable-name>) и значения входных данных ($input.<input-name>.<path-to-datum>) в качестве длительности. Диапазон длительности — от 1 до 31622400 секунд. Для обеспечения точности минимальная длительность — 60 секунд. Оценённый результат длительности округляется вниз до ближайшего целого числа.

clearTimer -> (structure)

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

timerName -> (string)

Имя таймера для сброса.

resetTimer -> (structure)

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

timerName -> (string)

Имя таймера для сброса.

lambda -> (structure)

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

functionArn -> (string)

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

payload -> (structure)

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

contentExpression -> (string)

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

type -> (string)

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

iotEvents -> (structure)

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

inputName -> (string)

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

payload -> (structure)

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

contentExpression -> (string)

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

type -> (string)

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

sqs -> (structure)

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

queueUrl -> (string)

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

useBase64 -> (boolean)

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

payload -> (structure)

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

contentExpression -> (string)

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

type -> (string)

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

firehose -> (structure)

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

deliveryStreamName -> (string)

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

separator -> (string)

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

payload -> (structure)

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

contentExpression -> (string)

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

type -> (string)

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

dynamoDB -> (structure)

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

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

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

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.

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

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

При выходе из этого состояния выполните эти actions, если указанное condition равно TRUE.

events -> (список)

Указывает actions, которые выполняются при выходе из состояния, и если condition равно TRUE.

(структура)

Указывает actions, которые необходимо выполнить, когда condition принимает значение ИСТИНА.

eventName -> (строка)

Название события.

condition -> (строка)

Необязательно. Булево выражение, которое, при значении ИСТИНА, вызывает выполнение actions. Если отсутствует, действия выполняются (=ИСТИНА). Если результат выражения не является булевым значением, действия не выполняются (=ЛОЖЬ).

actions -> (список)

Действия, которые необходимо выполнить.

(структура)

Действие, которое необходимо выполнить, когда condition равно ИСТИНА.

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

Устанавливает переменную в указанное значение.

variableName -> (строка)

Имя переменной.

value -> (строка)

Новое значение переменной.

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.

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

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

timerName -> (строка)

Имя таймера.

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

Количество секунд до истечения таймера. Минимальное значение - 60 секунд для обеспечения точности. Максимальное значение - 31622400 секунд.

durationExpression -> (строка)

Продолжительность таймера в секундах. Вы можете использовать строковое выражение, которое включает числа, переменные ($variable.<variable-name>) и значения входных данных ($input.<input-name>.<path-to-datum>) в качестве длительности. Диапазон длительности составляет от 1 до 31622400 секунд. Для обеспечения точности минимальная продолжительность составляет 60 секунд. Оценённый результат длительности округляется вниз до ближайшего целого числа.

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

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

timerName -> (строка)

Имя таймера для очистки.

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

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

timerName -> (строка)

Имя таймера для сброса.

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

contentExpression -> (строка)

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

type -> (строка)

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

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

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

queueUrl -> (строка)

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

useBase64 -> (булево)

Установите значение ИСТИНА, если вы хотите, чтобы данные были закодированы в base64 перед записью в очередь. В противном случае установите значение ЛОЖЬ.

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

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

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

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

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.

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

initialStateName -> (строка)

Состояние, в которое входит каждый детектор (экземпляр) при создании.

JSON Синтаксис:

{
  "states": [
    {
      "stateName": "string",
      "onInput": {
        "events": [
          {
            "eventName": "string",
            "condition": "string",
            "actions": [
              {
                "setVariable": {
                  "variableName": "string",
                  "value": "string"
                },
                "sns": {
                  "targetArn": "string",
                  "payload": {
                    "contentExpression": "string",
                    "type": "STRING"|"JSON"
                  }
                },
                "iotTopicPublish": {
                  "mqttTopic": "string",
                  "payload": {
                    "contentExpression": "string",
                    "type": "STRING"|"JSON"
                  }
                },
                "setTimer": {
                  "timerName": "string",
                  "seconds": integer,
                  "durationExpression": "string"
                },
                "clearTimer": {
                  "timerName": "string"
                },
                "resetTimer": {
                  "timerName": "string"
                },
                "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"
                  }
                }
              }
              ...
            ]
          }
          ...
        ],
        "transitionEvents": [
          {
            "eventName": "string",
            "condition": "string",
            "actions": [
              {
                "setVariable": {
                  "variableName": "string",
                  "value": "string"
                },
                "sns": {
                  "targetArn": "string",
                  "payload": {
                    "contentExpression": "string",
                    "type": "STRING"|"JSON"
                  }
                },
                "iotTopicPublish": {
                  "mqttTopic": "string",
                  "payload": {
                    "contentExpression": "string",
                    "type": "STRING"|"JSON"
                  }
                },
                "setTimer": {
                  "timerName": "string",
                  "seconds": integer,
                  "durationExpression": "string"
                },
                "clearTimer": {
                  "timerName": "string"
                },
                "resetTimer": {
                  "timerName": "string"
                },
                "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"
                  }
                }
              }
              ...
            ],
            "nextState": "string"
          }
          ...
        ]
      },
      "onEnter": {
        "events": [
          {
            "eventName": "string",
            "condition": "string",
            "actions": [
              {
                "setVariable": {
                  "variableName": "string",
                  "value": "string"
                },
                "sns": {
                  "targetArn": "string",
                  "payload": {
                    "contentExpression": "string",
                    "type": "STRING"|"JSON"
                  }
                },
                "iotTopicPublish": {
                  "mqttTopic": "string",
                  "payload": {
                    "contentExpression": "string",
                    "type": "STRING"|"JSON"
                  }
                },
                "setTimer": {
                  "timerName": "string",
                  "seconds": integer,
                  "durationExpression": "string"
                },
                "clearTimer": {
                  "timerName": "string"
                },
                "resetTimer": {
                  "timerName": "string"
                },
                "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"
                  }
                }
              }
              ...
            ]
          }
          ...
        ]
      },
      "onExit": {
        "events": [
          {
            "eventName": "string",
            "condition": "string",
            "actions": [
              {
                "setVariable": {
                  "variableName": "string",
                  "value": "string"
                },
                "sns": {
                  "targetArn": "string",
                  "payload": {
                    "contentExpression": "string",
                    "type": "STRING"|"JSON"
                  }
                },
                "iotTopicPublish": {
                  "mqttTopic": "string",
                  "payload": {
                    "contentExpression": "string",
                    "type": "STRING"|"JSON"
                  }
                },
                "setTimer": {
                  "timerName": "string",
                  "seconds": integer,
                  "durationExpression": "string"
                },
                "clearTimer": {
                  "timerName": "string"
                },
                "resetTimer": {
                  "timerName": "string"
                },
                "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"
                  }
                }
              }
              ...
            ]
          }
          ...
        ]
      }
    }
    ...
  ],
  "initialStateName": "string"
}

--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 (boolean)

Включить отладку.

--endpoint-url (string)

Переопределить URL по умолчанию команды на указанный URL.

--no-verify-ssl (boolean)

По умолчанию AWS CLI использует SSL при общении с AWS-сервисами. Для каждого подключения SSL AWS CLI будет проверять сертификаты SSL. Этот параметр переопределяет поведение проверки сертификатов SSL по умолчанию.

--no-paginate (boolean)

Отключить автоматическую постраничную навигацию. Если автоматическая постраничная навигация отключена, AWS CLI выполнит только один вызов для первой страницы результатов.

--output (string)

Стиль форматирования вывода команд.

  • json
  • text
  • table
  • yaml
  • yaml-stream

--query (string)

Запрос JMESPath для фильтрации данных ответа.

--profile (string)

Использовать определенный профиль из файла учетных данных.

--region (string)

Регион для использования. Переопределяет параметры конфигурации/среды.

--version (string)

Отобразить версию этого инструмента.

--color (string)

Включить/выключить цветной вывод.

  • on
  • off
  • auto

--no-sign-request (boolean)

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

--ca-bundle (string)

Файл сертификатов CA для проверки сертификатов SSL. Переопределяет параметры конфигурации/среды.

--cli-read-timeout (int)

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

--cli-connect-timeout (int)

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

--cli-binary-format (string)

Стиль форматирования для двоичных блоков. Формат по умолчанию — 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 (boolean)

Отключить страницу cli для вывода.

--cli-auto-prompt (boolean)

Автоматически запрашивать параметры ввода CLI.

--no-cli-auto-prompt (boolean)

Отключить автоматическое запросы параметров ввода CLI.

Вывод

analysisId -> (string)

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

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

Spec-Zone.ru

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