get-topic-rule

Описание

Получает информацию о правиле.

Требуется разрешение на доступ к действию GetTopicRule.

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

Синтаксис

  get-topic-rule
--rule-name <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]

Параметры

--rule-name (строка)

Имя правила.

--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 версии 1, и двоичные значения должны передаваться буквально. При предоставлении содержимого файла, соответствующего двоичному блоку, fileb:// всегда будет обрабатываться как двоичный и использовать содержимое файла напрямую независимо от настройки cli-binary-format. При использовании file:// содержимое файла должно быть должным образом отформатировано для конфигурированного cli-binary-format.

base64
raw-in-base64-out

--no-cli-pager (булево)

Отключить пейджер CLI для вывода.

--cli-auto-prompt (булево)

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

--no-cli-auto-prompt (булево)

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

Примеры

Примечание

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

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

Для получения информации о правиле

Следующий get-topic-rule пример получает информацию о заданном правиле.

aws iot get-topic-rule \
    --rule-name MyRPiLowMoistureAlertRule

Вывод:

{
    "ruleArn": "arn:aws:iot:us-west-2:123456789012:rule/MyRPiLowMoistureAlertRule",
    "rule": {
        "ruleName": "MyRPiLowMoistureAlertRule",
        "sql": "SELECT * FROM '$aws/things/MyRPi/shadow/update/accepted' WHERE state.reported.moisture = 'low'\n                    ",
        "description": "Sends an alert whenever soil moisture level readings are too low.",
        "createdAt": 1558624363.0,
        "actions": [
            {
                "sns": {
                    "targetArn": "arn:aws:sns:us-west-2:123456789012:MyRPiLowMoistureTopic",
                    "roleArn": "arn:aws:iam::123456789012:role/service-role/MyRPiLowMoistureTopicRole",
                    "messageFormat": "RAW"
                }
            }
        ],
        "ruleDisabled": false,
        "awsIotSqlVersion": "2016-03-23"
    }
}

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

Вывод

ruleArn -> (строка)

ARN правила.

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

Правило.

ruleName -> (строка)

Имя правила.

sql -> (строка)

SQL-запрос для получения данных из темы. При использовании SQL-запроса с несколькими строками обязательно экранируйте символы новой строки.

description -> (строка)

Описание правила.

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

Дата и время создания правила.

actions -> (список)

Действия, связанные с правилом.

(структура)

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

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

Запись в таблицу DynamoDB.

tableName -> (строка)

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

roleArn -> (строка)

ARN роли IAM, предоставляющей доступ к таблице DynamoDB.

operation -> (строка)

Тип операции. Следует шаблону подстановки, поэтому может быть ${operation} , но подстановка должна привести к одному из следующих значений: INSERT , UPDATE или DELETE .

hashKeyField -> (строка)

Имя ключа хеширования.

hashKeyValue -> (строка)

Значение ключа хеширования.

hashKeyType -> (строка)

Тип ключа хеширования. Допустимые значения: “STRING” или “NUMBER”.

rangeKeyField -> (строка)

Имя ключа диапазона.

rangeKeyValue -> (строка)

Значение ключа диапазона.

rangeKeyType -> (строка)

Тип ключа диапазона. Допустимые значения: “STRING” или “NUMBER”.

payloadField -> (строка)

Загрузка действия. Это имя можно настроить.

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

Запись в таблицу DynamoDB. Это новая версия действия DynamoDB. Она позволяет записать каждый атрибут в полезной нагрузке сообщения MQTT в отдельный столбец DynamoDB.

roleArn -> (строка)

ARN роли IAM, предоставляющей доступ к таблице DynamoDB.

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

Определяет таблицу DynamoDB, в которую будут записаны данные сообщения. Например:

{ "dynamoDBv2": { "roleArn": "aws:iam:12341251:my-role" "putItem": { "tableName": "my-table" } } }

Каждый атрибут в полезной нагрузке сообщения будет записан в отдельный столбец в базе данных DynamoDB.

tableName -> (строка)

Таблица, в которую будут записаны данные сообщения.

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

Вызов функции Lambda.

functionArn -> (строка)

ARN функции Lambda.

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

Опубликовать в тему Amazon SNS.

targetArn -> (строка)

ARN темы SNS.

roleArn -> (строка)

ARN роли IAM, предоставляющей доступ.

messageFormat -> (строка)

(Необязательно) Формат сообщения для публикации. Допустимые значения: “JSON” и “RAW”. По умолчанию значение атрибута — “RAW”. SNS использует это значение, чтобы определить, нужно ли парсить полезную нагрузку и извлекать соответствующие платформенно-специфические части полезной нагрузки. Для получения дополнительной информации о форматах сообщений SNS см. https://docs.aws.amazon.com/sns/latest/dg/json-formats.html. Обратитесь к их официальной документации.

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

Опубликовать в очередь Amazon SQS.

roleArn -> (строка)

ARN роли IAM, предоставляющей доступ.

queueUrl -> (строка)

URL очереди Amazon SQS.

useBase64 -> (булево)

Указывает, использовать ли кодирование Base64.

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

Запись данных в поток Amazon Kinesis.

roleArn -> (строка)

ARN роли IAM, предоставляющей доступ к потоку Amazon Kinesis.

streamName -> (строка)

Имя потока Amazon Kinesis.

partitionKey -> (строка)

Ключ разбиения.

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

Опубликовать в другую тему MQTT.

roleArn -> (строка)

ARN роли IAM, предоставляющей доступ.

topic -> (строка)

Имя темы MQTT.

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

Уровень качества обслуживания (QoS) для повторной публикации сообщений. Значение по умолчанию — 0.

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

Информация о заголовках MQTT версии 5.0. Дополнительную информацию см. в руководстве разработчика Amazon Web Services IoT Core по MQTT.

payloadFormatIndicator -> (строка)

Значение строки Enum, которое указывает, отформатирована ли полезная нагрузка как UTF-8.

Допустимые значения: UNSPECIFIED_BYTES и UTF8_DATA .

Дополнительную информацию см. в спецификации MQTT версии 5.0 по индикатору формата полезной нагрузки.

Поддерживает шаблоны подстановки.

contentType -> (строка)

Строка UTF-8, описывающая содержимое сообщения для публикации.

Дополнительную информацию см. в спецификации MQTT версии 5.0 по типу содержимого.

Поддерживает шаблоны подстановки.

responseTopic -> (строка)

Строка UTF-8, используемая в качестве имени темы для ответа. Тема ответа используется для описания темы, в которую получатель должен опубликовать ответ в рамках потока запросов-ответов. Тема не должна содержать символов подстановки.

Дополнительную информацию см. в спецификации MQTT версии 5.0 по теме ответа.

Поддерживает шаблоны подстановки.

correlationData -> (строка)

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

Дополнительную информацию см. в спецификации MQTT версии 5.0 по данным корреляции.

Примечание

Эти двоичные данные должны быть закодированы в base64.

Поддерживает шаблоны подстановки.

messageExpiry -> (строка)

Пользовательское целое число, которое сохранит сообщение в брокере сообщений на указанный период времени, чтобы гарантировать, что сообщение истечёт, если оно больше не актуально для подписчика. Значение messageExpiry представляет количество секунд до истечения срока действия. Дополнительную информацию о ограничениях messageExpiry см. в руководстве Amazon Web Services по брокеру сообщений и ограничениям протоколов Amazon Web Services.

Поддерживает шаблоны подстановки.

userProperties -> (список)

Массив пар «ключ-значение», которые вы определяете в заголовке MQTT5.

(структура)

Пара «ключ-значение», которую вы определяете в заголовке. И ключ, и значение являются либо литеральными строками, либо допустимыми шаблонами подстановки.

key -> (строка)

Ключ, который необходимо указать в UserProperty .

value -> (строка)

Значение, которое необходимо указать в UserProperty .

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

Запись в ведро Amazon S3.

roleArn -> (строка)

ARN роли IAM, предоставляющей доступ.

bucketName -> (строка)

Ведро Amazon S3.

key -> (строка)

Ключ объекта. Дополнительную информацию см. в разделе Действия, ресурсы и ключи условий для Amazon S3.

cannedAcl -> (строка)

Предустановленный ACL Amazon S3, который управляет доступом к объекту, идентифицируемому ключом объекта. Дополнительную информацию см. в разделе Предустановленные ACL S3.

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

Запись в поток Amazon Kinesis Firehose.

roleArn -> (строка)

Роль IAM, предоставляющая доступ к потоку Amazon Kinesis Firehose.

deliveryStreamName -> (строка)

Имя потока доставки.

separator -> (строка)

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

batchMode -> (булево)

Выполнять ли доставку потока Kinesis Data Firehose как пакет с помощью ` PutRecordBatch https://docs.aws.amazon.com/firehose/latest/APIReference/API_PutRecordBatch.html`__ . Значение по умолчанию — false .

Когда batchMode равно true, и SQL-запрос правила оценивается как массив, каждый элемент массива образует одну запись в запросе ` PutRecordBatch https://docs.aws.amazon.com/firehose/latest/APIReference/API_PutRecordBatch.html`__ . Результирующий массив не может содержать более 500 записей.

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

Запись метрики CloudWatch.

roleArn -> (строка)

Роль IAM, которая разрешает доступ к метрике CloudWatch.

metricNamespace -> (строка)

Имя пространства имен метрики CloudWatch.

metricName -> (строка)

Имя метрики CloudWatch.

metricValue -> (строка)

Значение метрики CloudWatch.

metricUnit -> (строка)

Единица измерения метрики, поддерживаемой CloudWatch.

metricTimestamp -> (строка)

Необязательная метка времени Unix.

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

Изменить состояние сигнализации CloudWatch.

roleArn -> (строка)

Роль IAM, которая разрешает доступ к сигнализации CloudWatch.

alarmName -> (строка)

Имя сигнализации CloudWatch.

stateReason -> (строка)

Причина изменения состояния.

stateValue -> (строка)

Значение состояния сигнализации. Допустимые значения: OK, ALARM, INSUFFICIENT_DATA.

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

Отправка данных в журналы CloudWatch.

roleArn -> (строка)

Роль IAM, которая разрешает доступ к журналу CloudWatch.

logGroupName -> (строка)

Группа журналов CloudWatch, в которую действие отправляет данные.

batchMode -> (булево)

Указывает, будут ли извлекаться и загружаться в CloudWatch пакеты записей журнала. Допустимые значения: true или false (по умолчанию) .

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

Запись данных в домен Amazon OpenSearch Service.

Примечание

Действие Elasticsearch может использоваться только существующими действиями правил. Чтобы создать новое действие правила или обновить существующее действие правила, используйте действие правила OpenSearch . Дополнительную информацию см. в разделе OpenSearchAction.

roleArn -> (строка)

ARN роли IAM, имеющей доступ к OpenSearch.

endpoint -> (строка)

Конечная точка вашего домена OpenSearch.

index -> (строка)

Индекс, в который вы хотите сохранить данные.

type -> (строка)

Тип документа, который вы храните.

id -> (строка)

Уникальный идентификатор документа, который вы храните.

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

Отправка сообщения в поток ввода Salesforce IoT Cloud.

token -> (строка)

Токен, используемый для аутентификации доступа к потоку ввода Salesforce IoT Cloud. Токен доступен на платформе Salesforce IoT Cloud после создания потока ввода.

url -> (строка)

URL, предоставляемый потоком ввода Salesforce IoT Cloud. URL доступен на платформе Salesforce IoT Cloud после создания потока ввода.

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

Отправляет данные сообщения в канал IoT Analytics.

channelArn -> (строка)

(устарело) ARN канала IoT Analytics, в который будут отправляться данные сообщения.

channelName -> (строка)

Имя канала IoT Analytics, в который будут отправляться данные сообщения.

batchMode -> (булево)

Обрабатывать ли действие как пакет. Значение по умолчанию - false.

Когда batchMode равно true и SQL-выражение правила оценивается в массив, каждый элемент массива доставляется как отдельное сообщение при передаче через ` BatchPutMessage https://docs.aws.amazon.com/iotanalytics/latest/APIReference/API_BatchPutMessage.html`__ в канал IoT Analytics. Результирующий массив не может содержать более 100 сообщений.

roleArn -> (строка)

ARN роли, политика которой предоставляет IoT Analytics разрешение отправлять данные сообщения через IoT Analytics (iotanalytics:BatchPutMessage).

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

Отправляет вход в детектор IoT Events.

inputName -> (строка)

Имя входного элемента IoT Events.

messageId -> (строка)

Идентификатор сообщения. Значение по умолчанию messageId - новое значение UUID.

Когда batchMode равно true, вы не можете указать messageId - будет назначено новое значение UUID.

Присвоение значения этому свойству гарантирует, что только один вход (сообщение) с заданным messageId будет обработан детектором IoT Events.

batchMode -> (булево)

Обрабатывать ли действия события как пакет. Значение по умолчанию - false.

Когда batchMode равно true, вы не можете указать messageId.

Когда batchMode равно true и SQL-выражение правила оценивается в массив, каждый элемент массива обрабатывается как отдельное сообщение при отправке в IoT Events с помощью вызова ` BatchPutMessage https://docs.aws.amazon.com/iotevents/latest/apireference/API_iotevents-data_BatchPutMessage.html`__ . Результирующий массив не может содержать более 10 сообщений.

roleArn -> (строка)

ARN роли, которая предоставляет IoT разрешение отправлять вход в детектор IoT Events. («Действие»: «iotevents:BatchPutMessage»).

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

Отправляет данные из сообщения MQTT, которое вызвало правило, в свойства актива IoT SiteWise.

putAssetPropertyValueEntries -> (список)

Список записей значений свойств актива.

(структура)

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

entryId -> (строка)

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

assetId -> (строка)

Идентификатор актива IoT SiteWise. Вы должны указать либо propertyAlias, либо и aliasId, и propertyId. Поддерживает шаблоны подстановки.

propertyId -> (строка)

Идентификатор свойства актива. Вы должны указать либо propertyAlias, либо и aliasId, и propertyId. Поддерживает шаблоны подстановки.

propertyAlias -> (строка)

Имя псевдонима свойства, связанного с вашим свойством актива. Вы должны указать либо propertyAlias, либо и aliasId, и propertyId. Поддерживает шаблоны подстановки.

propertyValues -> (список)

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

(структура)

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

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

Значение свойства актива.

stringValue -> (строка)

Необязательно. Строковое значение записи значения. Поддерживает шаблоны подстановки.

integerValue -> (строка)

Необязательно. Строка, содержащая целое значение записи значения. Поддерживает шаблоны подстановки.

doubleValue -> (строка)

Необязательно. Строка, содержащая двойное значение записи значения. Поддерживает шаблоны подстановки.

booleanValue -> (строка)

Необязательно. Строка, содержащая логическое значение (true или false) записи значения. Поддерживает шаблоны подстановки.

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

Отметка времени значения свойства актива.

timeInSeconds -> (строка)

Строка, содержащая время в секундах с эпохи. Поддерживает шаблоны подстановки.

offsetInNanos -> (строка)

Необязательно. Строка, содержащая смещение во времени в наносекундах. Поддерживает шаблоны подстановки.

quality -> (строка)

Необязательно. Строка, описывающая качество значения. Поддерживает шаблоны подстановки. Должно быть GOOD, BAD или UNCERTAIN.

roleArn -> (строка)

ARN роли, которая предоставляет IoT разрешение отправлять значение свойства актива в IoT SiteWise. ("Action": "iotsitewise:BatchPutAssetPropertyValue"). Политика доверия может ограничивать доступ к определенным путям иерархии активов.

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

Запускает выполнение машины состояний Step Functions.

executionNamePrefix -> (строка)

(Необязательно) Машине состояний будет присвоено имя, состоящее из этого префикса и UUID. Step Functions автоматически создаёт уникальное имя для каждого выполнения машины состояний, если имя не предоставлено.

stateMachineName -> (строка)

Имя машины состояний Step Functions, выполнение которой необходимо запустить.

roleArn -> (строка)

ARN роли, которая предоставляет IoT разрешение запускать выполнение машины состояний («Действие»: «states:StartExecution»).

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

Действие правила Timestream записывает атрибуты (измерения) из сообщения MQTT в таблицу Amazon Timestream. Дополнительные сведения см. в документации по действию правила Timestream.

roleArn -> (строка)

ARN роли, которая предоставляет разрешение на запись в таблицу базы данных Amazon Timestream.

databaseName -> (строка)

Имя базы данных Amazon Timestream.

tableName -> (строка)

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

dimensions -> (список)

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

(структура)

Атрибуты метаданных временных рядов, записываемые в каждой записи измерения.

name -> (строка)

Имя измерения метаданных. Это имя столбца в записи таблицы базы данных Amazon Timestream.

Измерения не могут быть именованы: measure_name, measure_value или time. Эти имена зарезервированы. Имена измерений не могут начинаться с ts_ или measure_value и не могут содержать символ двоеточия (:).

value -> (строка)

Значение для записи в этот столбец записи базы данных.

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

Указывает определённое приложением значение для замены значения по умолчанию, назначенного отметке времени записи Timestream в столбце time.

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

Если свойство опущено, действие правила темы присваивает отметку времени в миллисекундах в момент обработки правила.

value -> (строка)

Выражение, возвращающее значение долгой эпохи.

unit -> (строка)

Точность значения отметки времени, полученного из выражения, описанного в value.

Допустимые значения: SECONDS | MILLISECONDS | MICROSECONDS | NANOSECONDS. Значение по умолчанию - MILLISECONDS.

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

Отправка данных на конечную точку HTTPS.

url -> (строка)

URL конечной точки. Если в URL используются шаблоны подстановки, необходимо также указать confirmationUrl. Если это новый пункт назначения, новый TopicRuleDestination создаётся, если это возможно.

confirmationUrl -> (строка)

URL, в который IoT отправляет подтверждающее сообщение. Значение URL подтверждения должно быть префиксом URL конечной точки. Если вы не укажете URL подтверждения, IoT использует URL конечной точки в качестве URL подтверждения. Если вы используете шаблоны подстановки в confirmationUrl, необходимо создать и включить пункты назначения правил тем, которые соответствуют каждому возможному значению шаблона подстановки, прежде чем трафик будет разрешён для вашего URL конечной точки.

headers -> (список)

HTTP-заголовки для отправки вместе с данными сообщения.

(структура)

HTTP-заголовок действия.

key -> (строка)

Ключ HTTP-заголовка.

value -> (строка)

Значение HTTP-заголовка. Поддерживаются шаблоны подстановки.

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

Метод проверки подлинности для отправки данных на HTTPS-конечную точку.

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

Использование авторизации Sig V4. Дополнительные сведения см. в разделе Процесс подписи версии 4 подписи.

signingRegion -> (строка)

Регион подписи.

serviceName -> (строка)

Имя службы для использования при подписи с помощью Sig V4.

roleArn -> (строка)

ARN роли подписи.

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

Отправка сообщений в кластер Amazon Managed Streaming for Apache Kafka (Amazon MSK) или в самообслуживаемый кластер Apache Kafka.

destinationArn -> (строка)

ARN VPC TopicRuleDestination действия Kafka.

topic -> (строка)

Тема Kafka для сообщений, которые будут отправлены в брокер Kafka.

key -> (строка)

Ключ сообщения Kafka.

partition -> (строка)

Раздел сообщения Kafka.

clientProperties -> (массив)

Свойства клиента-продюсера Apache Kafka.

key -> (строка)

value -> (строка)

headers -> (список)

Список заголовков Kafka, которые вы указываете.

(структура)

Указывает заголовки Kafka с помощью пар «ключ-значение» при создании действия Kafka правила. Вы можете использовать эти заголовки для маршрутизации данных от клиентов IoT к кластерам Kafka без изменения полезной нагрузки сообщения.

Дополнительные сведения о действии Kafka правила см. в разделе Apache Kafka.

key -> (строка)

Ключ заголовка Kafka.

value -> (строка)

Значение заголовка Kafka.

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

Запись данных в домен Amazon OpenSearch Service.

roleArn -> (строка)

ARN роли IAM, имеющей доступ к OpenSearch.

endpoint -> (строка)

Конечная точка вашего домена OpenSearch.

index -> (строка)

Индекс OpenSearch, в котором вы хотите сохранить данные.

type -> (строка)

Тип документа, который вы храните.

id -> (строка)

Уникальный идентификатор хранимого документа.

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

Действие правила Amazon Location Service отправляет обновления местоположения устройства из сообщения MQTT в ресурс трекера Amazon Location.

roleArn -> (строка)

Роль IAM, предоставляющая разрешение на запись в ресурс Amazon Location.

trackerName -> (строка)

Имя ресурса трекера в Amazon Location, в котором обновляется местоположение.

deviceId -> (строка)

Уникальный идентификатор устройства, предоставляющего данные местоположения.

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

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

value -> (строка)

Выражение, возвращающее значение длинного временного отметки эпохи.

unit -> (строка)

Точность значения временной метки, полученного из выражения, описанного в value.

Допустимые значения: SECONDS | MILLISECONDS | MICROSECONDS | NANOSECONDS. Значение по умолчанию — MILLISECONDS.

latitude -> (строка)

Строка, которая вычисляется в значение типа double, представляющее широту местоположения устройства.

longitude -> (строка)

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

ruleDisabled -> (булево)

Указывает, отключено ли правило.

awsIotSqlVersion -> (строка)

Версия движка SQL правил AWS IoT для использования при оценке правила.

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

Действие, выполняемое при возникновении ошибки.

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

Запись в таблицу DynamoDB.

tableName -> (строка)

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

roleArn -> (строка)

ARN роли IAM, предоставляющей доступ к таблице DynamoDB.

operation -> (строка)

Тип операции. Следует шаблону подстановки, поэтому может быть ${operation}, но подстановка должна привести к одному из следующих значений: INSERT, UPDATE или DELETE.

hashKeyField -> (строка)

Имя ключа хеширования.

hashKeyValue -> (строка)

Значение ключа хеширования.

hashKeyType -> (строка)

Тип ключа хеширования. Допустимые значения: «STRING» или «NUMBER».

rangeKeyField -> (строка)

Имя ключа диапазона.

rangeKeyValue -> (строка)

Значение ключа диапазона.

rangeKeyType -> (строка)

Тип ключа диапазона. Допустимые значения: «STRING» или «NUMBER».

payloadField -> (строка)

Загрузка действия. Это имя можно настроить.

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

Запись в таблицу DynamoDB. Это новая версия действия DynamoDB. Она позволяет записывать каждый атрибут в полезной нагрузке сообщения MQTT в отдельный столбец DynamoDB.

roleArn -> (строка)

ARN роли IAM, предоставляющей доступ к таблице DynamoDB.

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

Указывает таблицу DynamoDB, в которую будут записаны данные сообщения. Например:

{ "dynamoDBv2": { "roleArn": "aws:iam:12341251:my-role" "putItem": { "tableName": "my-table" } } }

Каждый атрибут в полезной нагрузке сообщения будет записан в отдельный столбец базы данных DynamoDB.

tableName -> (строка)

Таблица, в которую будут записаны данные сообщения.

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

Вызов функции Lambda.

functionArn -> (строка)

ARN функции Lambda.

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

Опубликовать в тему Amazon SNS.

targetArn -> (строка)

ARN темы SNS.

roleArn -> (строка)

ARN роли IAM, предоставляющей доступ.

messageFormat -> (строка)

(Необязательно) Формат сообщения для публикации. Допустимые значения «JSON» и «RAW». По умолчанию «RAW». SNS использует это значение для определения того, следует ли анализировать полезную нагрузку и извлекать соответствующие платформенно-специфические части полезной нагрузки. Для получения более подробной информации о форматах сообщений SNS см. https://docs.aws.amazon.com/sns/latest/dg/json-formats.html. Обратитесь к официальной документации.

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

Опубликовать в очередь Amazon SQS.

roleArn -> (строка)

ARN роли IAM, предоставляющей доступ.

queueUrl -> (строка)

URL очереди Amazon SQS.

useBase64 -> (булево)

Указывает, использовать ли кодирование Base64.

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

Записать данные в поток Amazon Kinesis.

roleArn -> (строка)

ARN роли IAM, предоставляющей доступ к потоку Amazon Kinesis.

streamName -> (строка)

Имя потока Amazon Kinesis.

partitionKey -> (строка)

Ключ разбиения.

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

Опубликовать в другую тему MQTT.

roleArn -> (строка)

ARN роли IAM, предоставляющей доступ.

topic -> (строка)

Имя темы MQTT.

qos -> (целое)

Уровень качества обслуживания (QoS) для повторной публикации сообщений. Значение по умолчанию — 0.

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

Информация о заголовках MQTT версии 5.0. Для получения дополнительной информации см. MQTT в руководстве разработчика Amazon Web Services IoT Core.

payloadFormatIndicator -> (строка)

Строковое значение Enum, указывающее, отформатирована ли полезная нагрузка как UTF-8.

Допустимые значения UNSPECIFIED_BYTES и UTF8_DATA.

Для получения дополнительной информации см. Указатель формата полезной нагрузки в спецификации MQTT версии 5.0.

Поддерживает шаблоны подстановки.

contentType -> (строка)

Строка UTF-8, описывающая содержимое сообщения публикации.

Для получения дополнительной информации см. Тип содержимого в спецификации MQTT версии 5.0.

Поддерживает шаблоны подстановки.

responseTopic -> (строка)

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

Для получения дополнительной информации см. Тему ответа в спецификации MQTT версии 5.0.

Поддерживает шаблоны подстановки.

correlationData -> (строка)

Бинарные данные, закодированные в Base64, используемые отправителем сообщения запроса для идентификации запроса, которому принадлежит сообщение ответа при получении.

Для получения дополнительной информации см. Данные корреляции в спецификации MQTT версии 5.0.

Примечание

Эти бинарные данные должны быть закодированы в Base64.

Поддерживает шаблоны подстановки.

messageExpiry -> (строка)

Определенное пользователем целое значение, которое сохранит сообщение в посреднике сообщений на определенное время, чтобы обеспечить истечение срока действия сообщения, если оно больше не актуально для подписчика. Значение messageExpiry представляет количество секунд до истечения срока действия. Для получения более подробной информации о ограничениях messageExpiry см. Ограничения и квоты посредника сообщений и протокола Amazon Web Services IoT Core в справочнике Amazon Web Services.

Поддерживает шаблоны подстановки.

userProperties -> (список)

Массив пар ключ-значение, которые вы определяете в заголовке MQTT5.

(структура)

Пара ключ-значение, которую вы определяете в заголовке. И ключ, и значение являются либо литеральными строками, либо допустимыми шаблонами подстановки.

key -> (строка)

Ключ, который необходимо указать в UserProperty.

value -> (строка)

Значение, которое необходимо указать в UserProperty.

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

Запись в ведро Amazon S3.

roleArn -> (строка)

ARN роли IAM, предоставляющей доступ.

bucketName -> (строка)

Ведро Amazon S3.

key -> (строка)

Ключ объекта. Для получения дополнительной информации см. Действия, ресурсы и ключи условий для Amazon S3.

cannedAcl -> (строка)

Предопределенный ACL Amazon S3, который контролирует доступ к объекту, идентифицируемому ключом объекта. Для получения дополнительной информации см. Предопределенные ACL S3.

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

Запись в поток Amazon Kinesis Firehose.

roleArn -> (строка)

Роль IAM, предоставляющая доступ к потоку Amazon Kinesis Firehose.

deliveryStreamName -> (строка)

Имя потока доставки.

separator -> (строка)

batchMode -> (булево)

Определяет, будет ли поток Kinesis Data Firehose отправляться как пакет с использованием ` PutRecordBatch https://docs.aws.amazon.com/firehose/latest/APIReference/API_PutRecordBatch.html`__ . Значение по умолчанию — false.

Если batchMode имеет значение true, а SQL-запрос правила оценивается как массив, каждый элемент массива образует одну запись в запросе ` PutRecordBatch https://docs.aws.amazon.com/firehose/latest/APIReference/API_PutRecordBatch.html`__ . Полученный массив не может содержать более 500 записей.

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

Запись метрики CloudWatch.

roleArn -> (строка)

Роль IAM, позволяющая доступ к метрике CloudWatch.

metricNamespace -> (строка)

Имя пространства имен метрики CloudWatch.

metricName -> (строка)

Имя метрики CloudWatch.

metricValue -> (строка)

Значение метрики CloudWatch.

metricUnit -> (строка)

Единица измерения метрики, поддерживаемой CloudWatch.

metricTimestamp -> (строка)

Необязательный отметка Unix.

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

Изменить состояние сигнализации CloudWatch.

roleArn -> (строка)

Роль IAM, которая предоставляет доступ к сигнализации CloudWatch.

alarmName -> (строка)

Имя сигнализации CloudWatch.

stateReason -> (строка)

Причина изменения состояния сигнализации.

stateValue -> (строка)

Значение состояния сигнализации. Допустимые значения: OK, ALARM, INSUFFICIENT_DATA.

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

Отправка данных в журналы CloudWatch.

roleArn -> (строка)

Роль IAM, которая предоставляет доступ к журналу CloudWatch.

logGroupName -> (строка)

Группа журналов CloudWatch, в которую действие отправляет данные.

batchMode -> (булево)

Указывает, будут ли извлекаться и загружаться пакеты записей журналов в CloudWatch. Значения: true или false (по умолчанию).

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

Запись данных в домен Amazon OpenSearch Service.

Примечание

Действие Elasticsearch может использоваться только существующими действиями правил. Чтобы создать новое действие правила или обновить существующее, используйте действие правила OpenSearch. Для получения дополнительной информации см. OpenSearchAction.

roleArn -> (строка)

ARN роли IAM, имеющей доступ к OpenSearch.

endpoint -> (строка)

Конечная точка вашего домена OpenSearch.

index -> (строка)

Индекс, в который вы хотите сохранить данные.

type -> (строка)

Тип документа, который вы сохраняете.

id -> (строка)

Уникальный идентификатор документа, который вы сохраняете.

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

Отправка сообщения в поток ввода данных Salesforce IoT Cloud.

token -> (строка)

Токен, используемый для аутентификации доступа к потоку ввода данных Salesforce IoT Cloud. Токен доступен на платформе Salesforce IoT Cloud после создания потока ввода.

url -> (строка)

URL, экспонированный потоком ввода данных Salesforce IoT Cloud. URL доступен на платформе Salesforce IoT Cloud после создания потока ввода.

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

Отправляет данные сообщения в канал IoT Analytics.

channelArn -> (строка)

(устарело) ARN канала IoT Analytics, в который будут отправлены данные сообщения.

channelName -> (строка)

Имя канала IoT Analytics, в который будут отправлены данные сообщения.

batchMode -> (булево)

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

Когда batchMode равно true и оператор SQL правила вычисляет массив, каждый элемент массива передаётся как отдельное сообщение при передаче через ` BatchPutMessage https://docs.aws.amazon.com/iotanalytics/latest/APIReference/API_BatchPutMessage.html`__ в канал IoT Analytics. Результирующий массив не может содержать более 100 сообщений.

roleArn -> (строка)

ARN роли, имеющей политику, которая предоставляет IoT Analytics разрешение на отправку данных сообщений через IoT Analytics (iotanalytics:BatchPutMessage).

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

Отправляет ввод в детектор IoT Events.

inputName -> (строка)

Имя ввода IoT Events.

messageId -> (строка)

Идентификатор сообщения. Значение по умолчанию messageId — новое значение UUID.

Когда batchMode равно true, вы не можете указать messageId — будет назначено новое значение UUID.

Присвоение значения этому свойству гарантирует, что только один ввод (сообщение) с заданным messageId будет обработан детектором IoT Events.

batchMode -> (булево)

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

Когда batchMode равно true, вы не можете указать messageId.

Когда batchMode равно true и оператор SQL правила вычисляет массив, каждый элемент массива обрабатывается как отдельное сообщение при отправке в IoT Events с помощью вызова ` BatchPutMessage https://docs.aws.amazon.com/iotevents/latest/apireference/API_iotevents-data_BatchPutMessage.html`__. Результирующий массив не может содержать более 10 сообщений.

roleArn -> (строка)

ARN роли, предоставляющей IoT разрешение на отправку ввода в детектор IoT Events. («Действие»: «iotevents:BatchPutMessage»).

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

Отправляет данные из MQTT-сообщения, которое вызвало правило, в свойства активов IoT SiteWise.

putAssetPropertyValueEntries -> (список)

Список записей значений свойств активов.

(структура)

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

entryId -> (строка)

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

assetId -> (строка)

Идентификатор актива IoT SiteWise. Необходимо указать либо propertyAlias, либо и aliasId, и propertyId. Поддерживает шаблоны подстановки.

propertyId -> (строка)

Идентификатор свойства актива. Необходимо указать либо propertyAlias, либо и aliasId, и propertyId. Поддерживает шаблоны подстановки.

propertyAlias -> (строка)

Имя псевдонима свойства, связанного с вашим свойством актива. Необходимо указать либо propertyAlias, либо и aliasId, и propertyId. Поддерживает шаблоны подстановки.

propertyValues -> (список)

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

(структура)

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

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

Значение свойства актива.

stringValue -> (строка)

Необязательно. Строковое значение записи значения. Поддерживает шаблоны подстановки.

integerValue -> (строка)

Необязательно. Строка, содержащая целочисленное значение записи значения. Поддерживает шаблоны подстановки.

doubleValue -> (строка)

Необязательно. Строка, содержащая двойное значение записи значения. Поддерживает шаблоны подстановки.

booleanValue -> (строка)

Необязательно. Строка, содержащая булево значение (true или false) записи значения. Поддерживает шаблоны подстановки.

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

Временная метка значения свойства актива.

timeInSeconds -> (строка)

Строка, содержащая время в секундах с момента эпохи. Поддерживает шаблоны подстановки.

offsetInNanos -> (строка)

Необязательно. Строка, содержащая смещение временной метки в наносекундах. Поддерживает шаблоны подстановки.

quality -> (строка)

roleArn -> (строка)

ARN роли, предоставляющей IoT разрешение на отправку значения свойства актива в IoT SiteWise. ("Action": "iotsitewise:BatchPutAssetPropertyValue"). Политика доверия может ограничивать доступ к определённым путям иерархии активов.

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

Запускает выполнение машины состояний Step Functions.

executionNamePrefix -> (строка)

stateMachineName -> (строка)

Имя машины состояний Step Functions, выполнение которой будет запущено.

roleArn -> (строка)

ARN роли, предоставляющей IoT разрешение на запуск выполнения машины состояний («Действие»: «states:StartExecution»).

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

Действие правила Timestream записывает атрибуты (меры) из MQTT-сообщения в таблицу Amazon Timestream. Дополнительную информацию см. в документации по действию правила Timestream.

roleArn -> (строка)

ARN роли, предоставляющей разрешение на запись в базу данных Amazon Timestream.

databaseName -> (строка)

Имя базы данных Amazon Timestream.

tableName -> (строка)

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

dimensions -> (список)

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

(структура)

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

name -> (строка)

Имя метаданных измерения. Это имя столбца в записи таблицы базы данных Amazon Timestream.

Измерения не могут иметь имена: measure_name, measure_value или time. Эти имена зарезервированы. Имена измерений не могут начинаться с ts_ или measure_value, а также не могут содержать знак двоеточия (:).

value -> (строка)

Значение для записи в этом столбце записи базы данных.

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

Указывает определённое приложением значение для замены значения по умолчанию, назначенного временной метке записи Timestream в столбце time.

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

Если опущено, действие правила темы назначает временную метку в миллисекундах в момент обработки правила.

value -> (строка)

Выражение, возвращающее значение длительного времени эпохи.

unit -> (строка)

Точность значения временной метки, полученного из выражения, описанного в value.

Допустимые значения: SECONDS | MILLISECONDS | MICROSECONDS | NANOSECONDS. Значение по умолчанию — MILLISECONDS.

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

Отправка данных на конечную точку HTTPS.

url -> (строка)

URL конечной точки. Если в URL используются шаблоны подстановки, необходимо также указать confirmationUrl. Если это новый пункт назначения, если возможно, создаётся новая TopicRuleDestination.

confirmationUrl -> (строка)

URL, в который IoT отправляет подтверждающее сообщение. Значение URL подтверждения должно быть префиксом URL конечной точки. Если вы не укажете URL подтверждения, IoT использует URL конечной точки в качестве URL подтверждения. Если вы используете шаблоны подстановки в confirmationUrl, необходимо создать и включить пункты назначения правил темы, соответствующие каждому возможному значению шаблона подстановки, прежде чем трафик будет разрешён на ваш URL конечной точки.

headers -> (список)

HTTP-заголовки для отправки с данными сообщения.

(структура)

Заголовок HTTP-действия.

key -> (строка)

Ключ HTTP-заголовка.

value -> (строка)

Значение HTTP-заголовка. Поддерживаются шаблоны подстановки.

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

Метод аутентификации для использования при отправке данных на конечную точку HTTPS.

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

Используйте авторизацию Sig V4. Дополнительную информацию см. в разделе Процесс подписи Signature Version 4.

signingRegion -> (строка)

Регион подписи.

serviceName -> (строка)

Имя службы для использования при подписи с помощью Sig V4.

roleArn -> (строка)

ARN роли подписи.

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

Отправка сообщений на кластер Amazon Managed Streaming for Apache Kafka (Amazon MSK) или на автономный кластер Apache Kafka.

destinationArn -> (строка)

ARN VPC действия Kafka TopicRuleDestination.

topic -> (строка)

Тема Kafka для сообщений, которые будут отправлены на брокер Kafka.

key -> (строка)

Ключ Kafka-сообщения.

partition -> (строка)

Раздел Kafka-сообщения.

clientProperties -> (карта)

Свойства клиента-производителя Apache Kafka.

key -> (строка)

value -> (строка)

headers -> (список)

Список заголовков Kafka, которые вы указываете.

(структура)

Определяет заголовок Kafka с помощью пар ключ-значение при создании действия Kafka правила. Вы можете использовать эти заголовки для маршрутизации данных от клиентов IoT к кластерам Kafka без изменения полезной нагрузки сообщения.

Дополнительную информацию о действии правила Kafka см. в разделе Apache Kafka.

key -> (строка)

Ключ заголовка Kafka.

value -> (строка)

Значение заголовка Kafka.

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

Запись данных в домен Amazon OpenSearch Service.

roleArn -> (строка)

ARN IAM-роли с доступом к OpenSearch.

endpoint -> (строка)

Конечная точка вашего домена OpenSearch.

index -> (строка)

Индекс OpenSearch, в котором вы хотите хранить данные.

type -> (строка)

Тип документа, который вы храните.

id -> (строка)

Уникальный идентификатор хранимого документа.

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

Действие правила Amazon Location Service отправляет обновления местоположения устройства из сообщения MQTT в ресурс отслеживания Amazon Location.

roleArn -> (строка)

IAM-роль, предоставляющая разрешения на запись в ресурс Amazon Location.

trackerName -> (строка)

Имя ресурса отслеживания в Amazon Location, в котором обновляется местоположение.

deviceId -> (строка)

Уникальный идентификатор устройства, предоставляющего данные о местоположении.

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

Время, когда были взяты данные о местоположении. По умолчанию это время обработки сообщения MQTT.

value -> (строка)

Выражение, возвращающее значение целого числа эпохи.

unit -> (строка)

Точность значения отметки времени, полученного в результате выражения, описанного в value .

Допустимые значения: SECONDS | MILLISECONDS | MICROSECONDS | NANOSECONDS. По умолчанию MILLISECONDS.

latitude -> (строка)

Строка, которая вычисляется в значение типа double, представляющее широту местоположения устройства.

longitude -> (строка)

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