lib/aws-sdk-iotdataplane/client.rb in aws-sdk-iotdataplane-1.40.0 vs lib/aws-sdk-iotdataplane/client.rb in aws-sdk-iotdataplane-1.41.0

@@ -618,11 +618,11 @@
     #
     # @option params [required, String] :topic
     #   The name of the MQTT topic.
     #
     # @option params [Integer] :qos
-    #   The Quality of Service (QoS) level.
+    #   The Quality of Service (QoS) level. The default QoS level is 0.
     #
     # @option params [Boolean] :retain
     #   A Boolean value that determines whether to set the RETAIN flag when
     #   the message is published.
     #
@@ -639,19 +639,71 @@
     #
     #   Publishing an empty (null) payload with **retain** = `true` deletes
     #   the retained message identified by **topic** from Amazon Web Services
     #   IoT Core.
     #
+    # @option params [String] :user_properties
+    #   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"\}]`
+    #
+    #   **SDK automatically handles json encoding and base64 encoding for you
+    #   when the required value (Hash, Array, etc.) is provided according to
+    #   the description.**
+    #
+    # @option params [String] :payload_format_indicator
+    #   An `Enum` string value that indicates whether the payload is formatted
+    #   as UTF-8. `payloadFormatIndicator` is an HTTP header value in the API.
+    #
+    # @option params [String] :content_type
+    #   A UTF-8 encoded string that describes the content of the publishing
+    #   message.
+    #
+    # @option params [String] :response_topic
+    #   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.
+    #
+    # @option params [String] :correlation_data
+    #   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.
+    #
+    # @option params [Integer] :message_expiry
+    #   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 ][1]
+    #   from the Amazon Web Services Reference Guide.
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/general/latest/gr/iot-core.html#message-broker-limits
+    #
     # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
     #
     # @example Request syntax with placeholder values
     #
     #   resp = client.publish({
     #     topic: "Topic", # required
     #     qos: 1,
     #     retain: false,
     #     payload: "data",
+    #     user_properties: "UserProperties",
+    #     payload_format_indicator: "UNSPECIFIED_BYTES", # accepts UNSPECIFIED_BYTES, UTF8_DATA
+    #     content_type: "ContentType",
+    #     response_topic: "ResponseTopic",
+    #     correlation_data: "CorrelationData",
+    #     message_expiry: 1,
     #   })
     #
     # @overload publish(params = {})
     # @param [Hash] params ({})
     def publish(params = {}, options = {})
@@ -714,10 +766,10 @@
         operation: config.api.operation(operation_name),
         client: self,
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-iotdataplane'
-      context[:gem_version] = '1.40.0'
+      context[:gem_version] = '1.41.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 
     # @api private
     # @deprecated