создать-правило-темы

Описание

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

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

См. также: AWS API Documentation

Синтаксис

  create-topic-rule
--rule-name <value>
--topic-rule-payload <value>
[--tags <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 (строка)

Название правила.

--topic-rule-payload (структура)

Загрузка правила.

sql -> (строка)

SQL-запрос для получения данных из темы. Дополнительную информацию см. в разделе IoT SQL Reference руководства по разработке IoT.

description -> (строка)

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

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, обратитесь к документации.

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.

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

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

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. (“Action”:”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 на запуск выполнения машины состояний (“Action”:”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-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 -> (строка)

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

longitude -> (строка)

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

ruleDisabled -> (булево)

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

awsIotSqlVersion -> (строка)

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

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

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

token -> (строка)

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

url -> (строка)

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

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.

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

(структура)

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

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.

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

Идентификатор роли IAM, имеющий доступ к OpenSearch.

endpoint -> (строка)

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

index -> (строка)

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

type -> (строка)

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

id -> (строка)

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

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

roleArn -> (строка)

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

trackerName -> (строка)

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

deviceId -> (строка)

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

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

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

value -> (строка)

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

unit -> (строка)

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

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

latitude -> (строка)

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

longitude -> (строка)

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

Синтаксис JSON:

{
  "sql": "string",
  "description": "string",
  "actions": [
    {
      "dynamoDB": {
        "tableName": "string",
        "roleArn": "string",
        "operation": "string",
        "hashKeyField": "string",
        "hashKeyValue": "string",
        "hashKeyType": "STRING"|"NUMBER",
        "rangeKeyField": "string",
        "rangeKeyValue": "string",
        "rangeKeyType": "STRING"|"NUMBER",
        "payloadField": "string"
      },
      "dynamoDBv2": {
        "roleArn": "string",
        "putItem": {
          "tableName": "string"
        }
      },
      "lambda": {
        "functionArn": "string"
      },
      "sns": {
        "targetArn": "string",
        "roleArn": "string",
        "messageFormat": "RAW"|"JSON"
      },
      "sqs": {
        "roleArn": "string",
        "queueUrl": "string",
        "useBase64": true|false
      },
      "kinesis": {
        "roleArn": "string",
        "streamName": "string",
        "partitionKey": "string"
      },
      "republish": {
        "roleArn": "string",
        "topic": "string",
        "qos": integer,
        "headers": {
          "payloadFormatIndicator": "string",
          "contentType": "string",
          "responseTopic": "string",
          "correlationData": "string",
          "messageExpiry": "string",
          "userProperties": [
            {
              "key": "string",
              "value": "string"
            }
            ...
          ]
        }
      },
      "s3": {
        "roleArn": "string",
        "bucketName": "string",
        "key": "string",
        "cannedAcl": "private"|"public-read"|"public-read-write"|"aws-exec-read"|"authenticated-read"|"bucket-owner-read"|"bucket-owner-full-control"|"log-delivery-write"
      },
      "firehose": {
        "roleArn": "string",
        "deliveryStreamName": "string",
        "separator": "string",
        "batchMode": true|false
      },
      "cloudwatchMetric": {
        "roleArn": "string",
        "metricNamespace": "string",
        "metricName": "string",
        "metricValue": "string",
        "metricUnit": "string",
        "metricTimestamp": "string"
      },
      "cloudwatchAlarm": {
        "roleArn": "string",
        "alarmName": "string",
        "stateReason": "string",
        "stateValue": "string"
      },
      "cloudwatchLogs": {
        "roleArn": "string",
        "logGroupName": "string",
        "batchMode": true|false
      },
      "elasticsearch": {
        "roleArn": "string",
        "endpoint": "string",
        "index": "string",
        "type": "string",
        "id": "string"
      },
      "salesforce": {
        "token": "string",
        "url": "string"
      },
      "iotAnalytics": {
        "channelArn": "string",
        "channelName": "string",
        "batchMode": true|false,
        "roleArn": "string"
      },
      "iotEvents": {
        "inputName": "string",
        "messageId": "string",
        "batchMode": true|false,
        "roleArn": "string"
      },
      "iotSiteWise": {
        "putAssetPropertyValueEntries": [
          {
            "entryId": "string",
            "assetId": "string",
            "propertyId": "string",
            "propertyAlias": "string",
            "propertyValues": [
              {
                "value": {
                  "stringValue": "string",
                  "integerValue": "string",
                  "doubleValue": "string",
                  "booleanValue": "string"
                },
                "timestamp": {
                  "timeInSeconds": "string",
                  "offsetInNanos": "string"
                },
                "quality": "string"
              }
              ...
            ]
          }
          ...
        ],
        "roleArn": "string"
      },
      "stepFunctions": {
        "executionNamePrefix": "string",
        "stateMachineName": "string",
        "roleArn": "string"
      },
      "timestream": {
        "roleArn": "string",
        "databaseName": "string",
        "tableName": "string",
        "dimensions": [
          {
            "name": "string",
            "value": "string"
          }
          ...
        ],
        "timestamp": {
          "value": "string",
          "unit": "string"
        }
      },
      "http": {
        "url": "string",
        "confirmationUrl": "string",
        "headers": [
          {
            "key": "string",
            "value": "string"
          }
          ...
        ],
        "auth": {
          "sigv4": {
            "signingRegion": "string",
            "serviceName": "string",
            "roleArn": "string"
          }
        }
      },
      "kafka": {
        "destinationArn": "string",
        "topic": "string",
        "key": "string",
        "partition": "string",
        "clientProperties": {"string": "string"
          ...},
        "headers": [
          {
            "key": "string",
            "value": "string"
          }
          ...
        ]
      },
      "openSearch": {
        "roleArn": "string",
        "endpoint": "string",
        "index": "string",
        "type": "string",
        "id": "string"
      },
      "location": {
        "roleArn": "string",
        "trackerName": "string",
        "deviceId": "string",
        "timestamp": {
          "value": "string",
          "unit": "string"
        },
        "latitude": "string",
        "longitude": "string"
      }
    }
    ...
  ],
  "ruleDisabled": true|false,
  "awsIotSqlVersion": "string",
  "errorAction": {
    "dynamoDB": {
      "tableName": "string",
      "roleArn": "string",
      "operation": "string",
      "hashKeyField": "string",
      "hashKeyValue": "string",
      "hashKeyType": "STRING"|"NUMBER",
      "rangeKeyField": "string",
      "rangeKeyValue": "string",
      "rangeKeyType": "STRING"|"NUMBER",
      "payloadField": "string"
    },
    "dynamoDBv2": {
      "roleArn": "string",
      "putItem": {
        "tableName": "string"
      }
    },
    "lambda": {
      "functionArn": "string"
    },
    "sns": {
      "targetArn": "string",
      "roleArn": "string",
      "messageFormat": "RAW"|"JSON"
    },
    "sqs": {
      "roleArn": "string",
      "queueUrl": "string",
      "useBase64": true|false
    },
    "kinesis": {
      "roleArn": "string",
      "streamName": "string",
      "partitionKey": "string"
    },
    "republish": {
      "roleArn": "string",
      "topic": "string",
      "qos": integer,
      "headers": {
        "payloadFormatIndicator": "string",
        "contentType": "string",
        "responseTopic": "string",
        "correlationData": "string",
        "messageExpiry": "string",
        "userProperties": [
          {
            "key": "string",
            "value": "string"
          }
          ...
        ]
      }
    },
    "s3": {
      "roleArn": "string",
      "bucketName": "string",
      "key": "string",
      "cannedAcl": "private"|"public-read"|"public-read-write"|"aws-exec-read"|"authenticated-read"|"bucket-owner-read"|"bucket-owner-full-control"|"log-delivery-write"
    },
    "firehose": {
      "roleArn": "string",
      "deliveryStreamName": "string",
      "separator": "string",
      "batchMode": true|false
    },
    "cloudwatchMetric": {
      "roleArn": "string",
      "metricNamespace": "string",
      "metricName": "string",
      "metricValue": "string",
      "metricUnit": "string",
      "metricTimestamp": "string"
    },
    "cloudwatchAlarm": {
      "roleArn": "string",
      "alarmName": "string",
      "stateReason": "string",
      "stateValue": "string"
    },
    "cloudwatchLogs": {
      "roleArn": "string",
      "logGroupName": "string",
      "batchMode": true|false
    },
    "elasticsearch": {
      "roleArn": "string",
      "endpoint": "string",
      "index": "string",
      "type": "string",
      "id": "string"
    },
    "salesforce": {
      "token": "string",
      "url": "string"
    },
    "iotAnalytics": {
      "channelArn": "string",
      "channelName": "string",
      "batchMode": true|false,
      "roleArn": "string"
    },
    "iotEvents": {
      "inputName": "string",
      "messageId": "string",
      "batchMode": true|false,
      "roleArn": "string"
    },
    "iotSiteWise": {
      "putAssetPropertyValueEntries": [
        {
          "entryId": "string",
          "assetId": "string",
          "propertyId": "string",
          "propertyAlias": "string",
          "propertyValues": [
            {
              "value": {
                "stringValue": "string",
                "integerValue": "string",
                "doubleValue": "string",
                "booleanValue": "string"
              },
              "timestamp": {
                "timeInSeconds": "string",
                "offsetInNanos": "string"
              },
              "quality": "string"
            }
            ...
          ]
        }
        ...
      ],
      "roleArn": "string"
    },
    "stepFunctions": {
      "executionNamePrefix": "string",
      "stateMachineName": "string",
      "roleArn": "string"
    },
    "timestream": {
      "roleArn": "string",
      "databaseName": "string",
      "tableName": "string",
      "dimensions": [
        {
          "name": "string",
          "value": "string"
        }
        ...
      ],
      "timestamp": {
        "value": "string",
        "unit": "string"
      }
    },
    "http": {
      "url": "string",
      "confirmationUrl": "string",
      "headers": [
        {
          "key": "string",
          "value": "string"
        }
        ...
      ],
      "auth": {
        "sigv4": {
          "signingRegion": "string",
          "serviceName": "string",
          "roleArn": "string"
        }
      }
    },
    "kafka": {
      "destinationArn": "string",
      "topic": "string",
      "key": "string",
      "partition": "string",
      "clientProperties": {"string": "string"
        ...},
      "headers": [
        {
          "key": "string",
          "value": "string"
        }
        ...
      ]
    },
    "openSearch": {
      "roleArn": "string",
      "endpoint": "string",
      "index": "string",
      "type": "string",
      "id": "string"
    },
    "location": {
      "roleArn": "string",
      "trackerName": "string",
      "deviceId": "string",
      "timestamp": {
        "value": "string",
        "unit": "string"
      },
      "latitude": "string",
      "longitude": "string"
    }
  }
}

--tags (строка)

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

Примечание

Для параметров запроса URI используйте формат: …key1=value1&key2=value2…

Для параметра командной строки CLI используйте формат: –tags “key1=value1&key2=value2…”

Для файла cli-input-json используйте формат: “tags”: “key1=value1&key2=value2…”

--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 для получения дополнительной информации.

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

Создание правила, отправляющего оповещение Amazon SNS

Следующий create-topic-rule пример создает правило, отправляющее сообщение Amazon SNS, когда значения влажности почвы, найденные в тени устройства, низкие.

aws iot create-topic-rule \
    --rule-name "LowMoistureRule" \
    --topic-rule-payload file://plant-rule.json

Для примера требуется сохранить следующий код JSON в файл с именем plant-rule.json:

{
    "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.",
    "ruleDisabled": false,
    "awsIotSqlVersion": "2016-03-23",
    "actions": [{
            "sns": {
                "targetArn": "arn:aws:sns:us-west-2:123456789012:MyRPiLowMoistureTopic",
                "roleArn": "arn:aws:iam::123456789012:role/service-role/MyRPiLowMoistureTopicRole",
                "messageFormat": "RAW"
            }
    }]
}

Эта команда не выводит ничего.

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

Вывод

Нет

END_OF_DOCUMENT_MARKER