Spec-Zone.ru › AWS CLI v2

[ aws . iotevents ]

describe-detector-model

Описание

Описывает модель детектора. Если параметр version не указан, возвращается информация о последней версии.

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

Синтаксис

  describe-detector-model
--detector-model-name <value>
[--detector-model-version <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Параметры

--detector-model-name (строка)

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

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

Версия модели детектора.

--cli-input-json | --cli-input-yaml (строка) Читает аргументы из предоставленной JSON-строки. JSON-строка следует формату, предоставленному --generate-cli-skeleton. Если другие аргументы предоставлены в командной строке, эти значения переопределят значения, предоставленные в JSON. Невозможно передать произвольные двоичные значения с помощью предоставленного JSON-значения, так как строка будет воспринята буквально. Это не может быть указано вместе с --cli-input-yaml.

--generate-cli-skeleton (строка) Выводит JSON-скелет в стандартный вывод без отправки запроса API. Если предоставлено значение без значения или со значением input, выводит пример JSON-ввода, который может быть использован в качестве аргумента для --cli-input-json. Аналогично, если предоставлено значение yaml-input, выведет пример YAML-ввода, который может быть использован с --cli-input-yaml. Если предоставлено значение output, он валидирует входные данные команды и возвращает JSON-пример выходных данных для этой команды. Сгенерированный JSON-скелет нестабилен между версиями AWS CLI, и нет гарантий обратной совместимости в сгенерированном JSON-скелете.

Глобальные параметры

--debug (логическое значение)

Включить отладочную запись в журнал.

--endpoint-url (строка)

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

--no-verify-ssl (логическое значение)

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

--no-paginate (логическое значение)

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

--output (строка)

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

  • json
  • текст
  • таблица
  • 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.

Примеры

Примечание

Чтобы использовать следующие примеры, у вас должен быть установлен и настроен AWS CLI. См. руководство «Начало работы» в руководстве пользователя AWS CLI для получения дополнительной информации.

Если не указано иное, все примеры имеют правила кавычек в стиле Unix. Эти примеры потребуется адаптировать к правилам кавычек вашей терминальной среды. См. Использование кавычек со строками в руководстве пользователя AWS CLI .

Чтобы получить информацию о модели детектора

Следующий describe-detector-model пример отображает подробности для указанной модели детектора. Поскольку параметр version не указан, возвращается информация о последней версии.

aws iotevents describe-detector-model \
    --detector-model-name motorDetectorModel

Вывод:

{
    "detectorModel": {
        "detectorModelConfiguration": {
            "status": "ACTIVE",
            "lastUpdateTime": 1560796816.077,
            "roleArn": "arn:aws:iam::123456789012:role/IoTEventsRole",
            "creationTime": 1560796816.077,
            "detectorModelArn": "arn:aws:iotevents:us-west-2:123456789012:detectorModel/motorDetectorModel",
            "key": "motorid",
            "detectorModelName": "motorDetectorModel",
            "detectorModelVersion": "1"
        },
        "detectorModelDefinition": {
            "states": [
                {
                    "onInput": {
                        "transitionEvents": [
                            {
                                "eventName": "Overpressurized",
                                "actions": [
                                    {
                                        "setVariable": {
                                            "variableName": "pressureThresholdBreached",
                                            "value": "$variable.pressureThresholdBreached + 3"
                                        }
                                    }
                                ],
                                "condition": "$input.PressureInput.sensorData.pressure > 70",
                                "nextState": "Dangerous"
                            }
                        ],
                        "events": []
                    },
                    "stateName": "Normal",
                    "onEnter": {
                        "events": [
                            {
                                "eventName": "init",
                                "actions": [
                                    {
                                        "setVariable": {
                                            "variableName": "pressureThresholdBreached",
                                            "value": "0"
                                        }
                                    }
                                ],
                                "condition": "true"
                            }
                        ]
                    },
                    "onExit": {
                        "events": []
                    }
                },
                {
                    "onInput": {
                        "transitionEvents": [
                            {
                                "eventName": "BackToNormal",
                                "actions": [],
                                "condition": "$input.PressureInput.sensorData.pressure <= 70 && $variable.pressureThresholdBreached <= 1",
                                "nextState": "Normal"
                            }
                        ],
                        "events": [
                            {
                                "eventName": "Overpressurized",
                                "actions": [
                                    {
                                        "setVariable": {
                                            "variableName": "pressureThresholdBreached",
                                            "value": "3"
                                        }
                                    }
                                ],
                                "condition": "$input.PressureInput.sensorData.pressure > 70"
                            },
                            {
                                "eventName": "Pressure Okay",
                                "actions": [
                                    {
                                        "setVariable": {
                                            "variableName": "pressureThresholdBreached",
                                            "value": "$variable.pressureThresholdBreached - 1"
                                        }
                                    }
                                ],
                                "condition": "$input.PressureInput.sensorData.pressure <= 70"
                            }
                        ]
                    },
                    "stateName": "Dangerous",
                    "onEnter": {
                        "events": [
                            {
                                "eventName": "Pressure Threshold Breached",
                                "actions": [
                                    {
                                        "sns": {
                                            "targetArn": "arn:aws:sns:us-east-1:123456789012:underPressureAction"
                                        }
                                    }
                                ],
                                "condition": "$variable.pressureThresholdBreached > 1"
                            }
                        ]
                    },
                    "onExit": {
                        "events": [
                            {
                                "eventName": "Normal Pressure Restored",
                                "actions": [
                                    {
                                        "sns": {
                                            "targetArn": "arn:aws:sns:us-east-1:123456789012:pressureClearedAction"
                                        }
                                    }
                                ],
                                "condition": "true"
                            }
                        ]
                    }
                }
            ],
            "initialStateName": "Normal"
        }
    }
}

Для получения дополнительной информации см. DescribeDetectorModel в справочнике по API AWS IoT Events.

Вывод

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

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

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

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

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.

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. Допустимый диапазон — от 1 до 31556889864403199.

offsetInNanos -> (строка)

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

quality -> (строка)

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

transitionEvents -> (список)

Определяет действия, выполняемые и следующее состояние, вступающее в силу, когда condition оценивается как ИСТИНА.

(структура)

Определяет действия, выполняемые и следующее состояние, вступающее в силу, когда condition оценивается как ИСТИНА.

eventName -> (строка)

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

condition -> (строка)

Обязательное. Булево выражение, которое при значении ИСТИНА вызывает выполнение действий и вступление в силу nextState.

actions -> (список)

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

(структура)

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

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

nextState -> (строка)

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

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

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

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.

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

Имя потока доставки 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' .

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

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

events -> (список)

Указывает actions, которые выполняются при выходе из состояния, и если 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 -> (структура)

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

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. Допустимый диапазон — от 1 до 31556889864403199.

offsetInNanos -> (строка)

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

quality -> (строка)

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

initialStateName -> (строка)

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

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

Информация о конфигурации детектора.

detectorModelName -> (строка)

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

detectorModelVersion -> (строка)

Версия модели детектора.

detectorModelDescription -> (строка)

Краткое описание модели детектора.

detectorModelArn -> (строка)

ARN модели детектора.

roleArn -> (строка)

ARN роли, предоставляющей разрешения AWS IoT Events для выполнения своих операций.

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

Время создания модели детектора.

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

Время последнего обновления модели детектора.

status -> (строка)

Статус модели детектора.

key -> (строка)

Значение, используемое для идентификации экземпляра детектора. При отправке устройствами или системами входных данных создается новый экземпляр детектора с уникальным значением ключа. AWS IoT Events может продолжать маршрутизировать входные данные к соответствующему экземпляру детектора на основе этой идентификационной информации.

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

evaluationMethod -> (строка)

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

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

Spec-Zone.ru

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