publish

Описание

Опубликовывает сообщение MQTT.

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

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

Дополнительную информацию о затратах на сообщения см. в документации по ценообразованию Amazon Web Services IoT Core - Сообщения.

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

Примечание

Для кода в рабочей среде настоятельно рекомендуется использовать пользовательский конечный пункт для вашей учетной записи (доступный с помощью команды iot describe-endpoint) для обеспечения наилучшей доступности и достижимости сервиса. Значения по умолчанию для конечных пунктов (предназначенные только для целей тестирования) можно найти по адресу https://docs.aws.amazon.com/general/latest/gr/iot-core.html#iot-core-data-plane-endpoints

Синтаксис

  publish
--topic <value>
[--qos <value>]
[--retain | --no-retain]
[--payload <value>]
[--user-properties <value>]
[--payload-format-indicator <value>]
[--content-type <value>]
[--response-topic <value>]
[--correlation-data <value>]
[--message-expiry <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]

Параметры

--topic (строка)

Имя темы MQTT.

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

Уровень качества обслуживания (QoS). По умолчанию уровень QoS равен 0.

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

Логическое значение, определяющее, следует ли устанавливать флаг RETAIN при публикации сообщения.

Установка флага RETAIN приводит к сохранению сообщения и его отправке новым подписчикам на тему.

Допустимые значения: true | false

Значение по умолчанию: false

--payload (байтовый массив)

Тело сообщения. MQTT принимает текстовые, двоичные и пустые (null) полезные данные сообщений.

Опубликование пустого (null) содержимого с retain = true удаляет сохраненное сообщение, идентифицированное по topic, из Amazon Web Services IoT Core.

--user-properties (JSON)

Строка JSON, содержащая массив JSON-объектов. Если вы не используете Amazon Web Services SDK или CLI, вам необходимо закодировать строку JSON в формате base64 перед добавлением ее в заголовок HTTP. userProperties — это значение заголовка HTTP в API.

Следующий пример userProperties параметра — строка JSON, представляющая два пользовательских свойства. Обратите внимание, что ее необходимо закодировать в base64:

[{"deviceName": "alpha"}, {"deviceCnt": "45"}]

--payload-format-indicator (строка)

Строковое значение Enum, указывающее, отформатированы ли полезные данные в формате UTF-8. payloadFormatIndicator — это значение заголовка HTTP в API.

Возможные значения:

UNSPECIFIED_BYTES
UTF8_DATA

--content-type (строка)

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

--response-topic (строка)

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

--correlation-data (строка)

Данные в формате base64, используемые отправителем сообщения запроса для идентификации запроса, которому принадлежит сообщение ответа при его получении. correlationData — это значение заголовка HTTP в API.

--message-expiry (длинное целое число)

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

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

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

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

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

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

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

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

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

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

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

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

--output (строка)

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

json
текст
таблица
yaml
yaml-поток

--query (строка)

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

--profile (строка)

Использовать конкретный профиль из файла аутентификации.

--region (строка)

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

--version (строка)

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

--color (строка)

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

вкл
выкл
авто

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

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

--ca-bundle (строка)

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

--cli-read-timeout (целое число)

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

--cli-connect-timeout (целое число)

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

--cli-binary-format (строка)

Стиль форматирования, используемый для двоичных блоков. По умолчанию используется формат base64. Формат base64 ожидает, что двоичные блоки будут предоставлены в виде закодированной строки base64. Формат raw-in-base64-out сохраняет совместимость с поведением AWS CLI V1, и двоичные значения должны быть переданы буквально. При предоставлении содержимого из файла, сопоставляемого с двоичным блоком, fileb:// всегда будет обрабатываться как двоичное и использовать содержимое файла непосредственно независимо от настройки cli-binary-format. При использовании file:// содержимое файла необходимо правильно отформатировать для настроенного cli-binary-format.

base64
raw-in-base64-out

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

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

--cli-auto-prompt (логическое значение)

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

--no-cli-auto-prompt (логическое значение)

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

Вывод

Нет