Skip to content

/AWS1/IF_IOP=>PUBLISH()

About Publish

Publishes an MQTT message.

Requires permission to access the Publish action.

For more information about MQTT messages, see MQTT Protocol in the IoT Developer Guide.

For more information about messaging costs, see Amazon Web Services IoT Core pricing - Messaging.

Method Signature

METHODS /AWS1/IF_IOP~PUBLISH
  IMPORTING
    !IV_TOPIC TYPE /AWS1/IOPTOPIC OPTIONAL
    !IV_QOS TYPE /AWS1/IOPQOS OPTIONAL
    !IV_RETAIN TYPE /AWS1/IOPRETAIN OPTIONAL
    !IV_PAYLOAD TYPE /AWS1/IOPPAYLOAD OPTIONAL
    !IV_USERPROPERTIES TYPE /AWS1/IOPSYNTHEDJSONUSERPRPS OPTIONAL
    !IV_PAYLOADFORMATINDICATOR TYPE /AWS1/IOPPAYLOADFMTINDICATOR OPTIONAL
    !IV_CONTENTTYPE TYPE /AWS1/IOPCONTENTTYPE OPTIONAL
    !IV_RESPONSETOPIC TYPE /AWS1/IOPRESPONSETOPIC OPTIONAL
    !IV_CORRELATIONDATA TYPE /AWS1/IOPCORRELATIONDATA OPTIONAL
    !IV_MESSAGEEXPIRY TYPE /AWS1/IOPMESSAGEEXPIRY OPTIONAL
  RAISING
    /AWS1/CX_IOPINTERNALFAILUREEX
    /AWS1/CX_IOPINVALIDREQUESTEX
    /AWS1/CX_IOPMETHODNOTALLOWEDEX
    /AWS1/CX_IOPTHROTTLINGEX
    /AWS1/CX_IOPUNAUTHORIZEDEX
    /AWS1/CX_IOPCLIENTEXC
    /AWS1/CX_IOPSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_topic TYPE /AWS1/IOPTOPIC /AWS1/IOPTOPIC

The name of the MQTT topic.

Optional arguments:

iv_qos TYPE /AWS1/IOPQOS /AWS1/IOPQOS

The Quality of Service (QoS) level. The default QoS level is 0.

iv_retain TYPE /AWS1/IOPRETAIN /AWS1/IOPRETAIN

A Boolean value that determines whether to set the RETAIN flag when the message is published.

Setting the RETAIN flag causes the message to be retained and sent to new subscribers to the topic.

Valid values: true | false

Default value: false

iv_payload TYPE /AWS1/IOPPAYLOAD /AWS1/IOPPAYLOAD

The message body. MQTT accepts text, binary, and empty (null) message payloads.

Publishing an empty (null) payload with retain = true deletes the retained message identified by topic from Amazon Web Services IoT Core.

iv_userproperties TYPE /AWS1/IOPSYNTHEDJSONUSERPRPS /AWS1/IOPSYNTHEDJSONUSERPRPS

A JSON string that contains an array of JSON objects. If you don’t use Amazon Web Services SDK or CLI, you must encode the JSON string to base64 format before adding it to the HTTP header. userProperties is an HTTP header value in the API.

The following example userProperties parameter is a JSON string which represents two User Properties. Note that it needs to be base64-encoded:

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

iv_payloadformatindicator TYPE /AWS1/IOPPAYLOADFMTINDICATOR /AWS1/IOPPAYLOADFMTINDICATOR

An Enum string value that indicates whether the payload is formatted as UTF-8. payloadFormatIndicator is an HTTP header value in the API.

iv_contenttype TYPE /AWS1/IOPCONTENTTYPE /AWS1/IOPCONTENTTYPE

A UTF-8 encoded string that describes the content of the publishing message.

iv_responsetopic TYPE /AWS1/IOPRESPONSETOPIC /AWS1/IOPRESPONSETOPIC

A UTF-8 encoded string that's used as the topic name for a response message. The response topic is used to describe the topic which the receiver should publish to as part of the request-response flow. The topic must not contain wildcard characters.

iv_correlationdata TYPE /AWS1/IOPCORRELATIONDATA /AWS1/IOPCORRELATIONDATA

The base64-encoded binary data used by the sender of the request message to identify which request the response message is for when it's received. correlationData is an HTTP header value in the API.

iv_messageexpiry TYPE /AWS1/IOPMESSAGEEXPIRY /AWS1/IOPMESSAGEEXPIRY

A user-defined integer value that represents the message expiry interval in seconds. If absent, the message doesn't expire. For more information about the limits of messageExpiry, see Amazon Web Services IoT Core message broker and protocol limits and quotas from the Amazon Web Services Reference Guide.

Examples

Syntax Example

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

lo_client->publish(
  iv_contenttype = |string|
  iv_correlationdata = |string|
  iv_messageexpiry = 123
  iv_payload = '5347567362473873563239796247513D'
  iv_payloadformatindicator = |string|
  iv_qos = 123
  iv_responsetopic = |string|
  iv_retain = ABAP_TRUE
  iv_topic = |string|
  iv_userproperties = |string|
).