aws-sdk-iotdataplane 1.40.0 → 1.41.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0be8cab76e1f7c1ecad3774551aba28d397cb72236d257921d4a7c229832c19d
-  data.tar.gz: e60c22a9f2ffcfcbb46ce2feb6692d64518ffb8f48a858ea5caa0a0155a76584
+  metadata.gz: 8d095bdd873c26177dc089f816f0b5517ada0daa223ebbe0025da406749c2616
+  data.tar.gz: af36a813f82e02857c329975f364f5f413bbe1442a150aaa61c80a9e60680706
 SHA512:
-  metadata.gz: 545cd7af191956e19b51b22bf8c095a466ba11cd0bb9a05f209cb4fe892063b4731b0c861d60bf83dc1aee94ac4328ea45f09f4bdfeb9f76863a81a91a1ccf3a
-  data.tar.gz: a17629ea41d2992961c6ebba433096ec3a8be5ebe0a25ac4602c704898b08564cab1d7a6509953ff14615569f6f715ce147f8b287119164f955ea9ae4e6ac48e
+  metadata.gz: 817e5a65a853f48878639a50ec4a84cc8018173d40a8263c4b0f590542291d1c8d89d46d8609eb2445787359457beb38ff78777287db91e76a57a06150a3ffb7
+  data.tar.gz: 93dd2836ad9804cc883f8c351032d837410282d70a068c5db703040e6eab5136b11b8c8b91d1f57a62b2b19d2c9340bac96903d3d0e8cc9da1709610a6ab908b

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.41.0 (2022-11-28)
+------------------
+
+* Feature - This release adds support for MQTT5 properties to AWS IoT HTTP Publish API.
+
 1.40.0 (2022-10-25)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.40.0
+1.41.0

data/lib/aws-sdk-iotdataplane/client.rb

@@ -620,7 +620,7 @@ module Aws::IoTDataPlane
     #   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
@@ -641,6 +641,52 @@ module Aws::IoTDataPlane
     #   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
@@ -650,6 +696,12 @@ module Aws::IoTDataPlane
     #     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 = {})
@@ -716,7 +768,7 @@ module Aws::IoTDataPlane
         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
 

data/lib/aws-sdk-iotdataplane/client_api.rb

@@ -14,6 +14,8 @@ module Aws::IoTDataPlane
     include Seahorse::Model
 
     ConflictException = Shapes::StructureShape.new(name: 'ConflictException')
+    ContentType = Shapes::StringShape.new(name: 'ContentType')
+    CorrelationData = Shapes::StringShape.new(name: 'CorrelationData')
     DeleteThingShadowRequest = Shapes::StructureShape.new(name: 'DeleteThingShadowRequest')
     DeleteThingShadowResponse = Shapes::StructureShape.new(name: 'DeleteThingShadowResponse')
     GetRetainedMessageRequest = Shapes::StructureShape.new(name: 'GetRetainedMessageRequest')
@@ -28,16 +30,19 @@ module Aws::IoTDataPlane
     ListRetainedMessagesRequest = Shapes::StructureShape.new(name: 'ListRetainedMessagesRequest')
     ListRetainedMessagesResponse = Shapes::StructureShape.new(name: 'ListRetainedMessagesResponse')
     MaxResults = Shapes::IntegerShape.new(name: 'MaxResults')
+    MessageExpiry = Shapes::IntegerShape.new(name: 'MessageExpiry')
     MethodNotAllowedException = Shapes::StructureShape.new(name: 'MethodNotAllowedException')
     NamedShadowList = Shapes::ListShape.new(name: 'NamedShadowList')
     NextToken = Shapes::StringShape.new(name: 'NextToken')
     PageSize = Shapes::IntegerShape.new(name: 'PageSize')
     Payload = Shapes::BlobShape.new(name: 'Payload')
+    PayloadFormatIndicator = Shapes::StringShape.new(name: 'PayloadFormatIndicator')
     PayloadSize = Shapes::IntegerShape.new(name: 'PayloadSize')
     PublishRequest = Shapes::StructureShape.new(name: 'PublishRequest')
     Qos = Shapes::IntegerShape.new(name: 'Qos')
     RequestEntityTooLargeException = Shapes::StructureShape.new(name: 'RequestEntityTooLargeException')
     ResourceNotFoundException = Shapes::StructureShape.new(name: 'ResourceNotFoundException')
+    ResponseTopic = Shapes::StringShape.new(name: 'ResponseTopic')
     Retain = Shapes::BooleanShape.new(name: 'Retain')
     RetainedMessageList = Shapes::ListShape.new(name: 'RetainedMessageList')
     RetainedMessageSummary = Shapes::StructureShape.new(name: 'RetainedMessageSummary')
@@ -51,6 +56,7 @@ module Aws::IoTDataPlane
     UnsupportedDocumentEncodingException = Shapes::StructureShape.new(name: 'UnsupportedDocumentEncodingException')
     UpdateThingShadowRequest = Shapes::StructureShape.new(name: 'UpdateThingShadowRequest')
     UpdateThingShadowResponse = Shapes::StructureShape.new(name: 'UpdateThingShadowResponse')
+    UserProperties = Shapes::StringShape.new(name: 'UserProperties')
     errorMessage = Shapes::StringShape.new(name: 'errorMessage')
 
     ConflictException.add_member(:message, Shapes::ShapeRef.new(shape: errorMessage, location_name: "message"))
@@ -116,6 +122,12 @@ module Aws::IoTDataPlane
     PublishRequest.add_member(:qos, Shapes::ShapeRef.new(shape: Qos, location: "querystring", location_name: "qos"))
     PublishRequest.add_member(:retain, Shapes::ShapeRef.new(shape: Retain, location: "querystring", location_name: "retain"))
     PublishRequest.add_member(:payload, Shapes::ShapeRef.new(shape: Payload, location_name: "payload"))
+    PublishRequest.add_member(:user_properties, Shapes::ShapeRef.new(shape: UserProperties, location: "header", location_name: "x-amz-mqtt5-user-properties", metadata: {"jsonvalue"=>true}))
+    PublishRequest.add_member(:payload_format_indicator, Shapes::ShapeRef.new(shape: PayloadFormatIndicator, location: "header", location_name: "x-amz-mqtt5-payload-format-indicator"))
+    PublishRequest.add_member(:content_type, Shapes::ShapeRef.new(shape: ContentType, location: "querystring", location_name: "contentType"))
+    PublishRequest.add_member(:response_topic, Shapes::ShapeRef.new(shape: ResponseTopic, location: "querystring", location_name: "responseTopic"))
+    PublishRequest.add_member(:correlation_data, Shapes::ShapeRef.new(shape: CorrelationData, location: "header", location_name: "x-amz-mqtt5-correlation-data"))
+    PublishRequest.add_member(:message_expiry, Shapes::ShapeRef.new(shape: MessageExpiry, location: "querystring", location_name: "messageExpiry"))
     PublishRequest.struct_class = Types::PublishRequest
     PublishRequest[:payload] = :payload
     PublishRequest[:payload_member] = PublishRequest.member(:payload)
@@ -266,6 +278,7 @@ module Aws::IoTDataPlane
         o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
         o.errors << Shapes::ShapeRef.new(shape: UnauthorizedException)
         o.errors << Shapes::ShapeRef.new(shape: MethodNotAllowedException)
+        o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
       end)
 
       api.add_operation(:update_thing_shadow, Seahorse::Model::Operation.new.tap do |o|

data/lib/aws-sdk-iotdataplane/types.rb

@@ -283,6 +283,12 @@ module Aws::IoTDataPlane
     #         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,
     #       }
     #
     # @!attribute [rw] topic
@@ -290,7 +296,7 @@ module Aws::IoTDataPlane
     #   @return [String]
     #
     # @!attribute [rw] qos
-    #   The Quality of Service (QoS) level.
+    #   The Quality of Service (QoS) level. The default QoS level is 0.
     #   @return [Integer]
     #
     # @!attribute [rw] retain
@@ -314,11 +320,67 @@ module Aws::IoTDataPlane
     #   Services IoT Core.
     #   @return [String]
     #
+    # @!attribute [rw] 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"\}]`
+    #   @return [String]
+    #
+    # @!attribute [rw] 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.
+    #   @return [String]
+    #
+    # @!attribute [rw] content_type
+    #   A UTF-8 encoded string that describes the content of the publishing
+    #   message.
+    #   @return [String]
+    #
+    # @!attribute [rw] 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.
+    #   @return [String]
+    #
+    # @!attribute [rw] 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.
+    #   @return [String]
+    #
+    # @!attribute [rw] 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 [Integer]
+    #
     class PublishRequest < Struct.new(
       :topic,
       :qos,
       :retain,
-      :payload)
+      :payload,
+      :user_properties,
+      :payload_format_indicator,
+      :content_type,
+      :response_topic,
+      :correlation_data,
+      :message_expiry)
       SENSITIVE = []
       include Aws::Structure
     end

data/lib/aws-sdk-iotdataplane.rb

@@ -52,6 +52,6 @@ require_relative 'aws-sdk-iotdataplane/customizations'
 # @!group service
 module Aws::IoTDataPlane
 
-  GEM_VERSION = '1.40.0'
+  GEM_VERSION = '1.41.0'
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-iotdataplane
 version: !ruby/object:Gem::Version
-  version: 1.40.0
+  version: 1.41.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-10-25 00:00:00.000000000 Z
+date: 2022-11-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core