aws-sdk-iotdataplane 1.79.0 → 1.80.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 98cd47a248ac578bdbd5a6056ce5629497ec220f016769294f818e9f758e7a84
-  data.tar.gz: b7cf18ba090495f288b6bbef90336360dfcdaea73990b87ac3e1ef0fa3a64102
+  metadata.gz: 5483d15aba15eb2cbd11416e7bfa79ca6c633e637cca375ca88f37481f854449
+  data.tar.gz: 0420e31ade9345254362693c7b9290e80eb70d75f93971db7d647aef200113d8
 SHA512:
-  metadata.gz: 126a658b91caaceddd64630cf2855c9421c18b6b39db5d37cd0bd02aad41b2330219064ff8e1ca68c6708dec8883ce5e6937c66b683de0834937e229779ce445
-  data.tar.gz: 02ae286e5aa734d24aa012baceaa16def83771da35bd4953ec4a55027c6168b9efd7540d429fa671893875a61dc7f53ad8156a93e6ab505b68aacee5b4852840
+  metadata.gz: 2a32981721ee3a88c3cda9a92c3fc3272090e638bfe0be1a24d0467112fb306e694b9ef52dc5bda30507c0478505cd539661d3126578facfc74e9264175b6ebc
+  data.tar.gz: 40bf7389b2fb3ee563eb7f63e98ba0a528343da43eecddcf7edd364acc8c807a7f16aa782e4cf143b726324e3abf6982732e9d774e38619ab388c23b5578887f

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.80.0 (2025-08-08)
+------------------
+
+* Feature - Adding DeleteConnection API to IoT Data Plane
+
 1.79.0 (2025-08-04)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.79.0
+1.80.0

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

@@ -476,6 +476,45 @@ module Aws::IoTDataPlane
 
     # @!group API Operations
 
+    # Disconnects a connected MQTT client from Amazon Web Services IoT Core.
+    # When you disconnect a client, Amazon Web Services IoT Core closes the
+    # client's network connection and optionally cleans the session state.
+    #
+    # @option params [required, String] :client_id
+    #   The unique identifier of the MQTT client to disconnect. The client ID
+    #   can't start with a dollar sign ($).
+    #
+    # @option params [Boolean] :clean_session
+    #   Specifies whether to remove the client's session state when
+    #   disconnecting. Set to `TRUE` to delete all session information,
+    #   including subscriptions and queued messages. Set to `FALSE` to
+    #   preserve the session state. By default, this is set to `FALSE`
+    #   (preserves the session state).
+    #
+    # @option params [Boolean] :prevent_will_message
+    #   Controls if Amazon Web Services IoT Core publishes the client's Last
+    #   Will and Testament (LWT) message upon disconnection. Set to `TRUE` to
+    #   prevent publishing the LWT message. Set to `FALSE` to allow
+    #   publishing. By default, this is set to `FALSE` (allows publishing the
+    #   LWT message).
+    #
+    # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.delete_connection({
+    #     client_id: "ClientId", # required
+    #     clean_session: false,
+    #     prevent_will_message: false,
+    #   })
+    #
+    # @overload delete_connection(params = {})
+    # @param [Hash] params ({})
+    def delete_connection(params = {}, options = {})
+      req = build_request(:delete_connection, params)
+      req.send_request(options)
+    end
+
     # Deletes the shadow for the specified thing.
     #
     # Requires permission to access the [DeleteThingShadow][1] action.
@@ -530,7 +569,7 @@ module Aws::IoTDataPlane
     #
     #
     # [1]: https://docs.aws.amazon.com/iot/latest/apireference/API_iotdata_ListRetainedMessages.html
-    # [2]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiotfleethubfordevicemanagement.html#awsiotfleethubfordevicemanagement-actions-as-permissions
+    # [2]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html
     # [3]: http://aws.amazon.com/iot-core/pricing/#Messaging
     #
     # @option params [required, String] :topic
@@ -669,7 +708,7 @@ module Aws::IoTDataPlane
     #
     #
     # [1]: https://docs.aws.amazon.com/iot/latest/apireference/API_iotdata_GetRetainedMessage.html
-    # [2]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiotfleethubfordevicemanagement.html#awsiotfleethubfordevicemanagement-actions-as-permissions
+    # [2]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html
     # [3]: http://aws.amazon.com/iot-core/pricing/#Messaging
     #
     # @option params [String] :next_token
@@ -883,7 +922,7 @@ module Aws::IoTDataPlane
         tracer: tracer
       )
       context[:gem_name] = 'aws-sdk-iotdataplane'
-      context[:gem_version] = '1.79.0'
+      context[:gem_version] = '1.80.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

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

@@ -14,11 +14,15 @@ module Aws::IoTDataPlane
 
     include Seahorse::Model
 
+    CleanSession = Shapes::BooleanShape.new(name: 'CleanSession')
+    ClientId = Shapes::StringShape.new(name: 'ClientId')
     ConflictException = Shapes::StructureShape.new(name: 'ConflictException')
     ContentType = Shapes::StringShape.new(name: 'ContentType')
     CorrelationData = Shapes::StringShape.new(name: 'CorrelationData')
+    DeleteConnectionRequest = Shapes::StructureShape.new(name: 'DeleteConnectionRequest')
     DeleteThingShadowRequest = Shapes::StructureShape.new(name: 'DeleteThingShadowRequest')
     DeleteThingShadowResponse = Shapes::StructureShape.new(name: 'DeleteThingShadowResponse')
+    ForbiddenException = Shapes::StructureShape.new(name: 'ForbiddenException')
     GetRetainedMessageRequest = Shapes::StructureShape.new(name: 'GetRetainedMessageRequest')
     GetRetainedMessageResponse = Shapes::StructureShape.new(name: 'GetRetainedMessageResponse')
     GetThingShadowRequest = Shapes::StructureShape.new(name: 'GetThingShadowRequest')
@@ -39,6 +43,7 @@ module Aws::IoTDataPlane
     Payload = Shapes::BlobShape.new(name: 'Payload')
     PayloadFormatIndicator = Shapes::StringShape.new(name: 'PayloadFormatIndicator')
     PayloadSize = Shapes::IntegerShape.new(name: 'PayloadSize')
+    PreventWillMessage = Shapes::BooleanShape.new(name: 'PreventWillMessage')
     PublishRequest = Shapes::StructureShape.new(name: 'PublishRequest')
     Qos = Shapes::IntegerShape.new(name: 'Qos')
     RequestEntityTooLargeException = Shapes::StructureShape.new(name: 'RequestEntityTooLargeException')
@@ -64,6 +69,11 @@ module Aws::IoTDataPlane
     ConflictException.add_member(:message, Shapes::ShapeRef.new(shape: errorMessage, location_name: "message"))
     ConflictException.struct_class = Types::ConflictException
 
+    DeleteConnectionRequest.add_member(:client_id, Shapes::ShapeRef.new(shape: ClientId, required: true, location: "uri", location_name: "clientId"))
+    DeleteConnectionRequest.add_member(:clean_session, Shapes::ShapeRef.new(shape: CleanSession, location: "querystring", location_name: "cleanSession"))
+    DeleteConnectionRequest.add_member(:prevent_will_message, Shapes::ShapeRef.new(shape: PreventWillMessage, location: "querystring", location_name: "preventWillMessage"))
+    DeleteConnectionRequest.struct_class = Types::DeleteConnectionRequest
+
     DeleteThingShadowRequest.add_member(:thing_name, Shapes::ShapeRef.new(shape: ThingName, required: true, location: "uri", location_name: "thingName"))
     DeleteThingShadowRequest.add_member(:shadow_name, Shapes::ShapeRef.new(shape: ShadowName, location: "querystring", location_name: "name"))
     DeleteThingShadowRequest.struct_class = Types::DeleteThingShadowRequest
@@ -73,6 +83,9 @@ module Aws::IoTDataPlane
     DeleteThingShadowResponse[:payload] = :payload
     DeleteThingShadowResponse[:payload_member] = DeleteThingShadowResponse.member(:payload)
 
+    ForbiddenException.add_member(:message, Shapes::ShapeRef.new(shape: errorMessage, location_name: "message"))
+    ForbiddenException.struct_class = Types::ForbiddenException
+
     GetRetainedMessageRequest.add_member(:topic, Shapes::ShapeRef.new(shape: Topic, required: true, location: "uri", location_name: "topic"))
     GetRetainedMessageRequest.struct_class = Types::GetRetainedMessageRequest
 
@@ -192,6 +205,19 @@ module Aws::IoTDataPlane
         "uid" => "iot-data-2015-05-28",
       }
 
+      api.add_operation(:delete_connection, Seahorse::Model::Operation.new.tap do |o|
+        o.name = "DeleteConnection"
+        o.http_method = "DELETE"
+        o.http_request_uri = "/connections/{clientId}"
+        o.input = Shapes::ShapeRef.new(shape: DeleteConnectionRequest)
+        o.output = Shapes::ShapeRef.new(shape: Shapes::StructureShape.new(struct_class: Aws::EmptyStructure))
+        o.errors << Shapes::ShapeRef.new(shape: ForbiddenException)
+        o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
+        o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
+        o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
+        o.errors << Shapes::ShapeRef.new(shape: InternalFailureException)
+      end)
+
       api.add_operation(:delete_thing_shadow, Seahorse::Model::Operation.new.tap do |o|
         o.name = "DeleteThingShadow"
         o.http_method = "DELETE"

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

@@ -28,6 +28,7 @@ module Aws::IoTDataPlane
   #
   # ## Error Classes
   # * {ConflictException}
+  # * {ForbiddenException}
   # * {InternalFailureException}
   # * {InvalidRequestException}
   # * {MethodNotAllowedException}
@@ -59,6 +60,21 @@ module Aws::IoTDataPlane
       end
     end
 
+    class ForbiddenException < ServiceError
+
+      # @param [Seahorse::Client::RequestContext] context
+      # @param [String] message
+      # @param [Aws::IoTDataPlane::Types::ForbiddenException] data
+      def initialize(context, message, data = Aws::EmptyStructure.new)
+        super(context, message, data)
+      end
+
+      # @return [String]
+      def message
+        @message || @data[:message]
+      end
+    end
+
     class InternalFailureException < ServiceError
 
       # @param [Seahorse::Client::RequestContext] context

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

@@ -22,6 +22,35 @@ module Aws::IoTDataPlane
       include Aws::Structure
     end
 
+    # @!attribute [rw] client_id
+    #   The unique identifier of the MQTT client to disconnect. The client
+    #   ID can't start with a dollar sign ($).
+    #   @return [String]
+    #
+    # @!attribute [rw] clean_session
+    #   Specifies whether to remove the client's session state when
+    #   disconnecting. Set to `TRUE` to delete all session information,
+    #   including subscriptions and queued messages. Set to `FALSE` to
+    #   preserve the session state. By default, this is set to `FALSE`
+    #   (preserves the session state).
+    #   @return [Boolean]
+    #
+    # @!attribute [rw] prevent_will_message
+    #   Controls if Amazon Web Services IoT Core publishes the client's
+    #   Last Will and Testament (LWT) message upon disconnection. Set to
+    #   `TRUE` to prevent publishing the LWT message. Set to `FALSE` to
+    #   allow publishing. By default, this is set to `FALSE` (allows
+    #   publishing the LWT message).
+    #   @return [Boolean]
+    #
+    class DeleteConnectionRequest < Struct.new(
+      :client_id,
+      :clean_session,
+      :prevent_will_message)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # The input for the DeleteThingShadow operation.
     #
     # @!attribute [rw] thing_name
@@ -51,6 +80,17 @@ module Aws::IoTDataPlane
       include Aws::Structure
     end
 
+    # The caller isn't authorized to make the request.
+    #
+    # @!attribute [rw] message
+    #   @return [String]
+    #
+    class ForbiddenException < Struct.new(
+      :message)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # The input for the GetRetainedMessage operation.
     #
     # @!attribute [rw] topic

data/lib/aws-sdk-iotdataplane.rb

@@ -23,7 +23,7 @@ Aws::Plugins::GlobalConfiguration.add_identifier(:iotdataplane)
 # structure.
 #
 #     io_t_data_plane = Aws::IoTDataPlane::Client.new
-#     resp = io_t_data_plane.delete_thing_shadow(params)
+#     resp = io_t_data_plane.delete_connection(params)
 #
 # See {Client} for more information.
 #
@@ -54,7 +54,7 @@ module Aws::IoTDataPlane
   autoload :EndpointProvider, 'aws-sdk-iotdataplane/endpoint_provider'
   autoload :Endpoints, 'aws-sdk-iotdataplane/endpoints'
 
-  GEM_VERSION = '1.79.0'
+  GEM_VERSION = '1.80.0'
 
 end
 

data/sig/client.rbs

@@ -78,6 +78,14 @@ module Aws
                   | (?Hash[Symbol, untyped]) -> instance
 
 
+      # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/IoTDataPlane/Client.html#delete_connection-instance_method
+      def delete_connection: (
+                               client_id: ::String,
+                               ?clean_session: bool,
+                               ?prevent_will_message: bool
+                             ) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
+                           | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
+
       interface _DeleteThingShadowResponseSuccess
         include ::Seahorse::Client::_ResponseSuccess[Types::DeleteThingShadowResponse]
         def payload: () -> ::String

data/sig/errors.rbs

@@ -14,6 +14,9 @@ module Aws
       class ConflictException < ::Aws::Errors::ServiceError
         def message: () -> ::String
       end
+      class ForbiddenException < ::Aws::Errors::ServiceError
+        def message: () -> ::String
+      end
       class InternalFailureException < ::Aws::Errors::ServiceError
         def message: () -> ::String
       end

data/sig/types.rbs

@@ -13,6 +13,13 @@ module Aws::IoTDataPlane
       SENSITIVE: []
     end
 
+    class DeleteConnectionRequest
+      attr_accessor client_id: ::String
+      attr_accessor clean_session: bool
+      attr_accessor prevent_will_message: bool
+      SENSITIVE: []
+    end
+
     class DeleteThingShadowRequest
       attr_accessor thing_name: ::String
       attr_accessor shadow_name: ::String
@@ -24,6 +31,11 @@ module Aws::IoTDataPlane
       SENSITIVE: []
     end
 
+    class ForbiddenException
+      attr_accessor message: ::String
+      SENSITIVE: []
+    end
+
     class GetRetainedMessageRequest
       attr_accessor topic: ::String
       SENSITIVE: []

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-iotdataplane
 version: !ruby/object:Gem::Version
-  version: 1.79.0
+  version: 1.80.0
 platform: ruby
 authors:
 - Amazon Web Services