aws-sdk-iotdataplane 1.30.0 → 1.31.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5bc87a3221774cb94dd1187cb8acdcc4d8eb6c2a9cefaff35a971e100ebe60bf
-  data.tar.gz: 74f2070554bebd8526c284455c189e59aa4dd8e7cd5c4602cdcb481697a25124
+  metadata.gz: adfe47c01d911ac55d458de9769bf1e0d2eea04711108e1e4cb68eef0a314fe2
+  data.tar.gz: 3aefb12eeaf4eca8b4877f63ac9c943bcc5ff7c134f612e0bf021a6631074a7f
 SHA512:
-  metadata.gz: f83fe1ae927b4b565c55e2bbea78b2a920b170e0d9589ec704ef91c35263233d97e72299eddbb258b03cc5ce405274af549d09a499ac3dc913a5b018c00223b7
-  data.tar.gz: 8dd968ba75497e1c763314edc0177ef51f0f0b44f1fb36f7dbb38f7f92cc22353c1ca0706fbb96f6cee4860a575833b6f9230a3fb8305a21bab2b3f8fd89fe2e
+  metadata.gz: 887d96216b505fd70e5658a28f1edd41ad477c7f47c515fb275953ca8887f19fc6d580ba7d7352c230465015a44e98be2cc50566c0251dc563e3dd54c89565ba
+  data.tar.gz: 79ca0d9a1316efe7058e3c502d97cb7565319b0086281c3636015c687c326a347fdcc5c23e021c81d4f7ff792833bcd8905d2085ee3906aa3f5f6277376102e5

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.31.0 (2021-08-24)
+------------------
+
+* Feature - Updated Publish with support for new Retain flag and added two new API operations: GetRetainedMessage, ListRetainedMessages.
+
 1.30.0 (2021-07-30)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.30.0
+1.31.0

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

@@ -329,12 +329,15 @@ module Aws::IoTDataPlane
 
     # Deletes the shadow for the specified thing.
     #
-    # For more information, see [DeleteThingShadow][1] in the AWS IoT
-    # Developer Guide.
+    # Requires permission to access the [DeleteThingShadow][1] action.
+    #
+    # For more information, see [DeleteThingShadow][2] in the IoT Developer
+    # Guide.
     #
     #
     #
-    # [1]: http://docs.aws.amazon.com/iot/latest/developerguide/API_DeleteThingShadow.html
+    # [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
+    # [2]: http://docs.aws.amazon.com/iot/latest/developerguide/API_DeleteThingShadow.html
     #
     # @option params [required, String] :thing_name
     #   The name of the thing.
@@ -364,14 +367,64 @@ module Aws::IoTDataPlane
       req.send_request(options)
     end
 
+    # Gets the details of a single retained message for the specified topic.
+    #
+    # This action returns the message payload of the retained message, which
+    # can incur messaging costs. To list only the topic names of the
+    # retained messages, call
+    # [ListRetainedMessages](/iot/latest/developerguide/API_iotdata_ListRetainedMessages.html).
+    #
+    # Requires permission to access the [GetRetainedMessage][1] action.
+    #
+    # For more information about messaging costs, see [IoT Core pricing -
+    # Messaging][2].
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiotfleethubfordevicemanagement.html#awsiotfleethubfordevicemanagement-actions-as-permissions
+    # [2]: http://aws.amazon.com/iot-core/pricing/#Messaging
+    #
+    # @option params [required, String] :topic
+    #   The topic name of the retained message to retrieve.
+    #
+    # @return [Types::GetRetainedMessageResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::GetRetainedMessageResponse#topic #topic} => String
+    #   * {Types::GetRetainedMessageResponse#payload #payload} => String
+    #   * {Types::GetRetainedMessageResponse#qos #qos} => Integer
+    #   * {Types::GetRetainedMessageResponse#last_modified_time #last_modified_time} => Integer
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.get_retained_message({
+    #     topic: "Topic", # required
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.topic #=> String
+    #   resp.payload #=> String
+    #   resp.qos #=> Integer
+    #   resp.last_modified_time #=> Integer
+    #
+    # @overload get_retained_message(params = {})
+    # @param [Hash] params ({})
+    def get_retained_message(params = {}, options = {})
+      req = build_request(:get_retained_message, params)
+      req.send_request(options)
+    end
+
     # Gets the shadow for the specified thing.
     #
-    # For more information, see [GetThingShadow][1] in the AWS IoT Developer
+    # Requires permission to access the [GetThingShadow][1] action.
+    #
+    # For more information, see [GetThingShadow][2] in the IoT Developer
     # Guide.
     #
     #
     #
-    # [1]: http://docs.aws.amazon.com/iot/latest/developerguide/API_GetThingShadow.html
+    # [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
+    # [2]: http://docs.aws.amazon.com/iot/latest/developerguide/API_GetThingShadow.html
     #
     # @option params [required, String] :thing_name
     #   The name of the thing.
@@ -403,6 +456,13 @@ module Aws::IoTDataPlane
 
     # Lists the shadows for the specified thing.
     #
+    # Requires permission to access the [ListNamedShadowsForThing][1]
+    # action.
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
+    #
     # @option params [required, String] :thing_name
     #   The name of the thing.
     #
@@ -440,14 +500,80 @@ module Aws::IoTDataPlane
       req.send_request(options)
     end
 
-    # Publishes state information.
+    # Lists summary information about the retained messages stored for the
+    # account.
     #
-    # For more information, see [HTTP Protocol][1] in the AWS IoT Developer
-    # Guide.
+    # This action returns only the topic names of the retained messages. It
+    # doesn't return any message payloads. Although this action doesn't
+    # return a message payload, it can still incur messaging costs.
+    #
+    # To get the message payload of a retained message, call
+    # [GetRetainedMessage][1] with the topic name of the retained message.
+    #
+    # Requires permission to access the [ListRetainedMessages][2] action.
+    #
+    # For more information about messaging costs, see [IoT Core pricing -
+    # Messaging][3].
     #
     #
     #
-    # [1]: http://docs.aws.amazon.com/iot/latest/developerguide/protocols.html#http
+    # [1]: https://docs.aws.amazon.com/iot/latest/developerguide/API_iotdata_GetRetainedMessage.html
+    # [2]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiotfleethubfordevicemanagement.html#awsiotfleethubfordevicemanagement-actions-as-permissions
+    # [3]: http://aws.amazon.com/iot-core/pricing/#Messaging
+    #
+    # @option params [String] :next_token
+    #   To retrieve the next set of results, the `nextToken` value from a
+    #   previous response; otherwise **null** to receive the first set of
+    #   results.
+    #
+    # @option params [Integer] :max_results
+    #   The maximum number of results to return at one time.
+    #
+    # @return [Types::ListRetainedMessagesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::ListRetainedMessagesResponse#retained_topics #retained_topics} => Array<Types::RetainedMessageSummary>
+    #   * {Types::ListRetainedMessagesResponse#next_token #next_token} => String
+    #
+    # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.list_retained_messages({
+    #     next_token: "NextToken",
+    #     max_results: 1,
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.retained_topics #=> Array
+    #   resp.retained_topics[0].topic #=> String
+    #   resp.retained_topics[0].payload_size #=> Integer
+    #   resp.retained_topics[0].qos #=> Integer
+    #   resp.retained_topics[0].last_modified_time #=> Integer
+    #   resp.next_token #=> String
+    #
+    # @overload list_retained_messages(params = {})
+    # @param [Hash] params ({})
+    def list_retained_messages(params = {}, options = {})
+      req = build_request(:list_retained_messages, params)
+      req.send_request(options)
+    end
+
+    # Publishes an MQTT message.
+    #
+    # Requires permission to access the [Publish][1] action.
+    #
+    # For more information about MQTT messages, see [MQTT Protocol][2] in
+    # the IoT Developer Guide.
+    #
+    # For more information about messaging costs, see [IoT Core pricing -
+    # Messaging][3].
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
+    # [2]: http://docs.aws.amazon.com/iot/latest/developerguide/mqtt.html
+    # [3]: http://aws.amazon.com/iot-core/pricing/#Messaging
     #
     # @option params [required, String] :topic
     #   The name of the MQTT topic.
@@ -455,8 +581,23 @@ module Aws::IoTDataPlane
     # @option params [Integer] :qos
     #   The Quality of Service (QoS) level.
     #
+    # @option params [Boolean] :retain
+    #   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`
+    #
     # @option params [String, StringIO, File] :payload
-    #   The state information, in JSON format.
+    #   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 IoT Core.
     #
     # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
     #
@@ -465,6 +606,7 @@ module Aws::IoTDataPlane
     #   resp = client.publish({
     #     topic: "Topic", # required
     #     qos: 1,
+    #     retain: false,
     #     payload: "data",
     #   })
     #
@@ -477,12 +619,15 @@ module Aws::IoTDataPlane
 
     # Updates the shadow for the specified thing.
     #
-    # For more information, see [UpdateThingShadow][1] in the AWS IoT
-    # Developer Guide.
+    # Requires permission to access the [UpdateThingShadow][1] action.
+    #
+    # For more information, see [UpdateThingShadow][2] in the IoT Developer
+    # Guide.
     #
     #
     #
-    # [1]: http://docs.aws.amazon.com/iot/latest/developerguide/API_UpdateThingShadow.html
+    # [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
+    # [2]: http://docs.aws.amazon.com/iot/latest/developerguide/API_UpdateThingShadow.html
     #
     # @option params [required, String] :thing_name
     #   The name of the thing.
@@ -529,7 +674,7 @@ module Aws::IoTDataPlane
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-iotdataplane'
-      context[:gem_version] = '1.30.0'
+      context[:gem_version] = '1.31.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

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

@@ -16,6 +16,8 @@ module Aws::IoTDataPlane
     ConflictException = Shapes::StructureShape.new(name: 'ConflictException')
     DeleteThingShadowRequest = Shapes::StructureShape.new(name: 'DeleteThingShadowRequest')
     DeleteThingShadowResponse = Shapes::StructureShape.new(name: 'DeleteThingShadowResponse')
+    GetRetainedMessageRequest = Shapes::StructureShape.new(name: 'GetRetainedMessageRequest')
+    GetRetainedMessageResponse = Shapes::StructureShape.new(name: 'GetRetainedMessageResponse')
     GetThingShadowRequest = Shapes::StructureShape.new(name: 'GetThingShadowRequest')
     GetThingShadowResponse = Shapes::StructureShape.new(name: 'GetThingShadowResponse')
     InternalFailureException = Shapes::StructureShape.new(name: 'InternalFailureException')
@@ -23,15 +25,22 @@ module Aws::IoTDataPlane
     JsonDocument = Shapes::BlobShape.new(name: 'JsonDocument')
     ListNamedShadowsForThingRequest = Shapes::StructureShape.new(name: 'ListNamedShadowsForThingRequest')
     ListNamedShadowsForThingResponse = Shapes::StructureShape.new(name: 'ListNamedShadowsForThingResponse')
+    ListRetainedMessagesRequest = Shapes::StructureShape.new(name: 'ListRetainedMessagesRequest')
+    ListRetainedMessagesResponse = Shapes::StructureShape.new(name: 'ListRetainedMessagesResponse')
+    MaxResults = Shapes::IntegerShape.new(name: 'MaxResults')
     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')
+    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')
+    Retain = Shapes::BooleanShape.new(name: 'Retain')
+    RetainedMessageList = Shapes::ListShape.new(name: 'RetainedMessageList')
+    RetainedMessageSummary = Shapes::StructureShape.new(name: 'RetainedMessageSummary')
     ServiceUnavailableException = Shapes::StructureShape.new(name: 'ServiceUnavailableException')
     ShadowName = Shapes::StringShape.new(name: 'ShadowName')
     ThingName = Shapes::StringShape.new(name: 'ThingName')
@@ -56,6 +65,15 @@ module Aws::IoTDataPlane
     DeleteThingShadowResponse[:payload] = :payload
     DeleteThingShadowResponse[:payload_member] = DeleteThingShadowResponse.member(:payload)
 
+    GetRetainedMessageRequest.add_member(:topic, Shapes::ShapeRef.new(shape: Topic, required: true, location: "uri", location_name: "topic"))
+    GetRetainedMessageRequest.struct_class = Types::GetRetainedMessageRequest
+
+    GetRetainedMessageResponse.add_member(:topic, Shapes::ShapeRef.new(shape: Topic, location_name: "topic"))
+    GetRetainedMessageResponse.add_member(:payload, Shapes::ShapeRef.new(shape: Payload, location_name: "payload"))
+    GetRetainedMessageResponse.add_member(:qos, Shapes::ShapeRef.new(shape: Qos, location_name: "qos"))
+    GetRetainedMessageResponse.add_member(:last_modified_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "lastModifiedTime"))
+    GetRetainedMessageResponse.struct_class = Types::GetRetainedMessageResponse
+
     GetThingShadowRequest.add_member(:thing_name, Shapes::ShapeRef.new(shape: ThingName, required: true, location: "uri", location_name: "thingName"))
     GetThingShadowRequest.add_member(:shadow_name, Shapes::ShapeRef.new(shape: ShadowName, location: "querystring", location_name: "name"))
     GetThingShadowRequest.struct_class = Types::GetThingShadowRequest
@@ -81,6 +99,14 @@ module Aws::IoTDataPlane
     ListNamedShadowsForThingResponse.add_member(:timestamp, Shapes::ShapeRef.new(shape: Timestamp, location_name: "timestamp"))
     ListNamedShadowsForThingResponse.struct_class = Types::ListNamedShadowsForThingResponse
 
+    ListRetainedMessagesRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location: "querystring", location_name: "nextToken"))
+    ListRetainedMessagesRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResults, location: "querystring", location_name: "maxResults"))
+    ListRetainedMessagesRequest.struct_class = Types::ListRetainedMessagesRequest
+
+    ListRetainedMessagesResponse.add_member(:retained_topics, Shapes::ShapeRef.new(shape: RetainedMessageList, location_name: "retainedTopics"))
+    ListRetainedMessagesResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "nextToken"))
+    ListRetainedMessagesResponse.struct_class = Types::ListRetainedMessagesResponse
+
     MethodNotAllowedException.add_member(:message, Shapes::ShapeRef.new(shape: errorMessage, location_name: "message"))
     MethodNotAllowedException.struct_class = Types::MethodNotAllowedException
 
@@ -88,6 +114,7 @@ module Aws::IoTDataPlane
 
     PublishRequest.add_member(:topic, Shapes::ShapeRef.new(shape: Topic, required: true, location: "uri", location_name: "topic"))
     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.struct_class = Types::PublishRequest
     PublishRequest[:payload] = :payload
@@ -99,6 +126,14 @@ module Aws::IoTDataPlane
     ResourceNotFoundException.add_member(:message, Shapes::ShapeRef.new(shape: errorMessage, location_name: "message"))
     ResourceNotFoundException.struct_class = Types::ResourceNotFoundException
 
+    RetainedMessageList.member = Shapes::ShapeRef.new(shape: RetainedMessageSummary)
+
+    RetainedMessageSummary.add_member(:topic, Shapes::ShapeRef.new(shape: Topic, location_name: "topic"))
+    RetainedMessageSummary.add_member(:payload_size, Shapes::ShapeRef.new(shape: PayloadSize, location_name: "payloadSize"))
+    RetainedMessageSummary.add_member(:qos, Shapes::ShapeRef.new(shape: Qos, location_name: "qos"))
+    RetainedMessageSummary.add_member(:last_modified_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "lastModifiedTime"))
+    RetainedMessageSummary.struct_class = Types::RetainedMessageSummary
+
     ServiceUnavailableException.add_member(:message, Shapes::ShapeRef.new(shape: errorMessage, location_name: "message"))
     ServiceUnavailableException.struct_class = Types::ServiceUnavailableException
 
@@ -155,6 +190,21 @@ module Aws::IoTDataPlane
         o.errors << Shapes::ShapeRef.new(shape: UnsupportedDocumentEncodingException)
       end)
 
+      api.add_operation(:get_retained_message, Seahorse::Model::Operation.new.tap do |o|
+        o.name = "GetRetainedMessage"
+        o.http_method = "GET"
+        o.http_request_uri = "/retainedMessage/{topic}"
+        o.input = Shapes::ShapeRef.new(shape: GetRetainedMessageRequest)
+        o.output = Shapes::ShapeRef.new(shape: GetRetainedMessageResponse)
+        o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
+        o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
+        o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
+        o.errors << Shapes::ShapeRef.new(shape: UnauthorizedException)
+        o.errors << Shapes::ShapeRef.new(shape: ServiceUnavailableException)
+        o.errors << Shapes::ShapeRef.new(shape: InternalFailureException)
+        o.errors << Shapes::ShapeRef.new(shape: MethodNotAllowedException)
+      end)
+
       api.add_operation(:get_thing_shadow, Seahorse::Model::Operation.new.tap do |o|
         o.name = "GetThingShadow"
         o.http_method = "GET"
@@ -186,6 +236,26 @@ module Aws::IoTDataPlane
         o.errors << Shapes::ShapeRef.new(shape: MethodNotAllowedException)
       end)
 
+      api.add_operation(:list_retained_messages, Seahorse::Model::Operation.new.tap do |o|
+        o.name = "ListRetainedMessages"
+        o.http_method = "GET"
+        o.http_request_uri = "/retainedMessage"
+        o.input = Shapes::ShapeRef.new(shape: ListRetainedMessagesRequest)
+        o.output = Shapes::ShapeRef.new(shape: ListRetainedMessagesResponse)
+        o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
+        o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
+        o.errors << Shapes::ShapeRef.new(shape: UnauthorizedException)
+        o.errors << Shapes::ShapeRef.new(shape: ServiceUnavailableException)
+        o.errors << Shapes::ShapeRef.new(shape: InternalFailureException)
+        o.errors << Shapes::ShapeRef.new(shape: MethodNotAllowedException)
+        o[:pager] = Aws::Pager.new(
+          limit_key: "max_results",
+          tokens: {
+            "next_token" => "next_token"
+          }
+        )
+      end)
+
       api.add_operation(:publish, Seahorse::Model::Operation.new.tap do |o|
         o.name = "Publish"
         o.http_method = "POST"

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

@@ -59,6 +59,54 @@ module Aws::IoTDataPlane
       include Aws::Structure
     end
 
+    # The input for the GetRetainedMessage operation.
+    #
+    # @note When making an API call, you may pass GetRetainedMessageRequest
+    #   data as a hash:
+    #
+    #       {
+    #         topic: "Topic", # required
+    #       }
+    #
+    # @!attribute [rw] topic
+    #   The topic name of the retained message to retrieve.
+    #   @return [String]
+    #
+    class GetRetainedMessageRequest < Struct.new(
+      :topic)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # The output from the GetRetainedMessage operation.
+    #
+    # @!attribute [rw] topic
+    #   The topic name to which the retained message was published.
+    #   @return [String]
+    #
+    # @!attribute [rw] payload
+    #   The Base64-encoded message payload of the retained message body.
+    #   @return [String]
+    #
+    # @!attribute [rw] qos
+    #   The quality of service (QoS) level used to publish the retained
+    #   message.
+    #   @return [Integer]
+    #
+    # @!attribute [rw] last_modified_time
+    #   The Epoch date and time, in milliseconds, when the retained message
+    #   was stored by IoT.
+    #   @return [Integer]
+    #
+    class GetRetainedMessageResponse < Struct.new(
+      :topic,
+      :payload,
+      :qos,
+      :last_modified_time)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # The input for the GetThingShadow operation.
     #
     # @note When making an API call, you may pass GetThingShadowRequest
@@ -154,12 +202,12 @@ module Aws::IoTDataPlane
     #   @return [Array<String>]
     #
     # @!attribute [rw] next_token
-    #   The token for the next set of results, or null if there are no
-    #   additional results.
+    #   The token to use to get the next set of results, or **null** if
+    #   there are no additional results.
     #   @return [String]
     #
     # @!attribute [rw] timestamp
-    #   The Epoch date and time the response was generated by AWS IoT.
+    #   The Epoch date and time the response was generated by IoT.
     #   @return [Integer]
     #
     class ListNamedShadowsForThingResponse < Struct.new(
@@ -170,6 +218,49 @@ module Aws::IoTDataPlane
       include Aws::Structure
     end
 
+    # @note When making an API call, you may pass ListRetainedMessagesRequest
+    #   data as a hash:
+    #
+    #       {
+    #         next_token: "NextToken",
+    #         max_results: 1,
+    #       }
+    #
+    # @!attribute [rw] next_token
+    #   To retrieve the next set of results, the `nextToken` value from a
+    #   previous response; otherwise **null** to receive the first set of
+    #   results.
+    #   @return [String]
+    #
+    # @!attribute [rw] max_results
+    #   The maximum number of results to return at one time.
+    #   @return [Integer]
+    #
+    class ListRetainedMessagesRequest < Struct.new(
+      :next_token,
+      :max_results)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] retained_topics
+    #   A summary list the account's retained messages. The information
+    #   returned doesn't include the message payloads of the retained
+    #   messages.
+    #   @return [Array<Types::RetainedMessageSummary>]
+    #
+    # @!attribute [rw] next_token
+    #   The token for the next set of results, or null if there are no
+    #   additional results.
+    #   @return [String]
+    #
+    class ListRetainedMessagesResponse < Struct.new(
+      :retained_topics,
+      :next_token)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # The specified combination of HTTP verb and URI is not supported.
     #
     # @!attribute [rw] message
@@ -190,6 +281,7 @@ module Aws::IoTDataPlane
     #       {
     #         topic: "Topic", # required
     #         qos: 1,
+    #         retain: false,
     #         payload: "data",
     #       }
     #
@@ -201,13 +293,30 @@ module Aws::IoTDataPlane
     #   The Quality of Service (QoS) level.
     #   @return [Integer]
     #
+    # @!attribute [rw] retain
+    #   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`
+    #   @return [Boolean]
+    #
     # @!attribute [rw] payload
-    #   The state information, in JSON format.
+    #   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 IoT Core.
     #   @return [String]
     #
     class PublishRequest < Struct.new(
       :topic,
       :qos,
+      :retain,
       :payload)
       SENSITIVE = []
       include Aws::Structure
@@ -237,6 +346,35 @@ module Aws::IoTDataPlane
       include Aws::Structure
     end
 
+    # Information about a single retained message.
+    #
+    # @!attribute [rw] topic
+    #   The topic name to which the retained message was published.
+    #   @return [String]
+    #
+    # @!attribute [rw] payload_size
+    #   The size of the retained message's payload in bytes.
+    #   @return [Integer]
+    #
+    # @!attribute [rw] qos
+    #   The quality of service (QoS) level used to publish the retained
+    #   message.
+    #   @return [Integer]
+    #
+    # @!attribute [rw] last_modified_time
+    #   The Epoch date and time, in milliseconds, when the retained message
+    #   was stored by IoT.
+    #   @return [Integer]
+    #
+    class RetainedMessageSummary < Struct.new(
+      :topic,
+      :payload_size,
+      :qos,
+      :last_modified_time)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # The service is temporarily unavailable.
     #
     # @!attribute [rw] message

data/lib/aws-sdk-iotdataplane.rb

@@ -48,6 +48,6 @@ require_relative 'aws-sdk-iotdataplane/customizations'
 # @!group service
 module Aws::IoTDataPlane
 
-  GEM_VERSION = '1.30.0'
+  GEM_VERSION = '1.31.0'
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-iotdataplane
 version: !ruby/object:Gem::Version
-  version: 1.30.0
+  version: 1.31.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-07-30 00:00:00.000000000 Z
+date: 2021-08-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core