aws-sdk-iotwireless 1.19.0 → 1.20.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5e166f6bc0d681037daea2f3972cbcb893985343f32227b3de50f79fdfbbcbda
-  data.tar.gz: dfb86cd5457c57791d935b3844f3528bdd14635c8b9cfa79022e191eaff12576
+  metadata.gz: 4890979e9ed84ecd116be20d9055a80c3feaefdd858e289f8aec31d3d82e5786
+  data.tar.gz: 440838ef4bea6d80a3c0bf441f03873f66b33dc299d344ce0262b878c015b4e3
 SHA512:
-  metadata.gz: 8842bf06e4ff2b42c317de9c18943f42e895aee55f3f9a55581690c7f12cfda7461227697ebcb8a11725fa1388f25954820b342dffd931fac2ef4c7855c028aa
-  data.tar.gz: a229a35e268512229f78b236e1d916d2a32962f2e86da70b5a9e9a6f593bd2b5600598c9b33fa4d31c4d009b40ff8df7a26ecc7ff10672b26be242db766b415c
+  metadata.gz: 86042e19371af3fc3a442ec387ad227dab55445a7e4f74b9d7d598b006938b6cf30ba11cd9ec97f78be37395efa21d3ce5cb491c2fa2bc7d3ced4a222f289642
+  data.tar.gz: 3a495a8640427600062f1652ce875b7d3d2205ac15f1e28a0694f09abe2c2f3cea4786bae15343d81e3abb6dee1a989c07f3a8ecfdb70740941ee9ac911cd92e

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.20.0 (2022-01-06)
+------------------
+
+* Feature - Downlink Queue Management feature provides APIs for customers to manage the queued messages destined to device inside AWS IoT Core for LoRaWAN. Customer can view, delete or purge the queued message(s). It allows customer to preempt the queued messages and let more urgent messages go through.
+
 1.19.0 (2021-12-21)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.19.0
+1.20.0

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

@@ -1238,6 +1238,36 @@ module Aws::IoTWireless
       req.send_request(options)
     end
 
+    # The operation to delete queued messages.
+    #
+    # @option params [required, String] :id
+    #   Id of a given wireless device which messages will be deleted
+    #
+    # @option params [required, String] :message_id
+    #   if messageID=="*", the queue for a particular wireless deviceId
+    #   will be purged, otherwise, the specific message with messageId will be
+    #   deleted
+    #
+    # @option params [String] :wireless_device_type
+    #   The wireless device type, it is either Sidewalk or LoRaWAN.
+    #
+    # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.delete_queued_messages({
+    #     id: "WirelessDeviceId", # required
+    #     message_id: "MessageId", # required
+    #     wireless_device_type: "Sidewalk", # accepts Sidewalk, LoRaWAN
+    #   })
+    #
+    # @overload delete_queued_messages(params = {})
+    # @param [Hash] params ({})
+    def delete_queued_messages(params = {}, options = {})
+      req = build_request(:delete_queued_messages, params)
+      req.send_request(options)
+    end
+
     # Deletes a service profile.
     #
     # @option params [required, String] :id
@@ -2520,6 +2550,54 @@ module Aws::IoTWireless
       req.send_request(options)
     end
 
+    # The operation to list queued messages.
+    #
+    # @option params [required, String] :id
+    #   Id of a given wireless device which the downlink packets are targeted
+    #
+    # @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 in this operation.
+    #
+    # @option params [String] :wireless_device_type
+    #   The wireless device type, it is either Sidewalk or LoRaWAN.
+    #
+    # @return [Types::ListQueuedMessagesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::ListQueuedMessagesResponse#next_token #next_token} => String
+    #   * {Types::ListQueuedMessagesResponse#downlink_queue_messages_list #downlink_queue_messages_list} => Array<Types::DownlinkQueueMessage>
+    #
+    # 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_queued_messages({
+    #     id: "WirelessDeviceId", # required
+    #     next_token: "NextToken",
+    #     max_results: 1,
+    #     wireless_device_type: "Sidewalk", # accepts Sidewalk, LoRaWAN
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.next_token #=> String
+    #   resp.downlink_queue_messages_list #=> Array
+    #   resp.downlink_queue_messages_list[0].message_id #=> String
+    #   resp.downlink_queue_messages_list[0].transmit_mode #=> Integer
+    #   resp.downlink_queue_messages_list[0].received_at #=> String
+    #   resp.downlink_queue_messages_list[0].lo_ra_wan.f_port #=> Integer
+    #
+    # @overload list_queued_messages(params = {})
+    # @param [Hash] params ({})
+    def list_queued_messages(params = {}, options = {})
+      req = build_request(:list_queued_messages, params)
+      req.send_request(options)
+    end
+
     # Lists the service profiles registered to your AWS account.
     #
     # @option params [String] :next_token
@@ -3508,7 +3586,7 @@ module Aws::IoTWireless
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-iotwireless'
-      context[:gem_version] = '1.19.0'
+      context[:gem_version] = '1.20.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

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

@@ -79,6 +79,8 @@ module Aws::IoTWireless
     DeleteFuotaTaskResponse = Shapes::StructureShape.new(name: 'DeleteFuotaTaskResponse')
     DeleteMulticastGroupRequest = Shapes::StructureShape.new(name: 'DeleteMulticastGroupRequest')
     DeleteMulticastGroupResponse = Shapes::StructureShape.new(name: 'DeleteMulticastGroupResponse')
+    DeleteQueuedMessagesRequest = Shapes::StructureShape.new(name: 'DeleteQueuedMessagesRequest')
+    DeleteQueuedMessagesResponse = Shapes::StructureShape.new(name: 'DeleteQueuedMessagesResponse')
     DeleteServiceProfileRequest = Shapes::StructureShape.new(name: 'DeleteServiceProfileRequest')
     DeleteServiceProfileResponse = Shapes::StructureShape.new(name: 'DeleteServiceProfileResponse')
     DeleteWirelessDeviceRequest = Shapes::StructureShape.new(name: 'DeleteWirelessDeviceRequest')
@@ -126,6 +128,8 @@ module Aws::IoTWireless
     DlRate = Shapes::IntegerShape.new(name: 'DlRate')
     DlRatePolicy = Shapes::StringShape.new(name: 'DlRatePolicy')
     Double = Shapes::FloatShape.new(name: 'Double')
+    DownlinkQueueMessage = Shapes::StructureShape.new(name: 'DownlinkQueueMessage')
+    DownlinkQueueMessagesList = Shapes::ListShape.new(name: 'DownlinkQueueMessagesList')
     DrMax = Shapes::IntegerShape.new(name: 'DrMax')
     DrMin = Shapes::IntegerShape.new(name: 'DrMin')
     EndPoint = Shapes::StringShape.new(name: 'EndPoint')
@@ -212,6 +216,8 @@ module Aws::IoTWireless
     ListMulticastGroupsResponse = Shapes::StructureShape.new(name: 'ListMulticastGroupsResponse')
     ListPartnerAccountsRequest = Shapes::StructureShape.new(name: 'ListPartnerAccountsRequest')
     ListPartnerAccountsResponse = Shapes::StructureShape.new(name: 'ListPartnerAccountsResponse')
+    ListQueuedMessagesRequest = Shapes::StructureShape.new(name: 'ListQueuedMessagesRequest')
+    ListQueuedMessagesResponse = Shapes::StructureShape.new(name: 'ListQueuedMessagesResponse')
     ListServiceProfilesRequest = Shapes::StructureShape.new(name: 'ListServiceProfilesRequest')
     ListServiceProfilesResponse = Shapes::StructureShape.new(name: 'ListServiceProfilesResponse')
     ListTagsForResourceRequest = Shapes::StructureShape.new(name: 'ListTagsForResourceRequest')
@@ -626,6 +632,13 @@ module Aws::IoTWireless
 
     DeleteMulticastGroupResponse.struct_class = Types::DeleteMulticastGroupResponse
 
+    DeleteQueuedMessagesRequest.add_member(:id, Shapes::ShapeRef.new(shape: WirelessDeviceId, required: true, location: "uri", location_name: "Id"))
+    DeleteQueuedMessagesRequest.add_member(:message_id, Shapes::ShapeRef.new(shape: MessageId, required: true, location: "querystring", location_name: "messageId"))
+    DeleteQueuedMessagesRequest.add_member(:wireless_device_type, Shapes::ShapeRef.new(shape: WirelessDeviceType, location: "querystring", location_name: "WirelessDeviceType"))
+    DeleteQueuedMessagesRequest.struct_class = Types::DeleteQueuedMessagesRequest
+
+    DeleteQueuedMessagesResponse.struct_class = Types::DeleteQueuedMessagesResponse
+
     DeleteServiceProfileRequest.add_member(:id, Shapes::ShapeRef.new(shape: ServiceProfileId, required: true, location: "uri", location_name: "Id"))
     DeleteServiceProfileRequest.struct_class = Types::DeleteServiceProfileRequest
 
@@ -712,6 +725,14 @@ module Aws::IoTWireless
 
     DisassociateWirelessGatewayFromThingResponse.struct_class = Types::DisassociateWirelessGatewayFromThingResponse
 
+    DownlinkQueueMessage.add_member(:message_id, Shapes::ShapeRef.new(shape: MessageId, location_name: "MessageId"))
+    DownlinkQueueMessage.add_member(:transmit_mode, Shapes::ShapeRef.new(shape: TransmitMode, location_name: "TransmitMode"))
+    DownlinkQueueMessage.add_member(:received_at, Shapes::ShapeRef.new(shape: ISODateTimeString, location_name: "ReceivedAt"))
+    DownlinkQueueMessage.add_member(:lo_ra_wan, Shapes::ShapeRef.new(shape: LoRaWANSendDataToDevice, location_name: "LoRaWAN"))
+    DownlinkQueueMessage.struct_class = Types::DownlinkQueueMessage
+
+    DownlinkQueueMessagesList.member = Shapes::ShapeRef.new(shape: DownlinkQueueMessage)
+
     FPorts.add_member(:fuota, Shapes::ShapeRef.new(shape: FPort, location_name: "Fuota"))
     FPorts.add_member(:multicast, Shapes::ShapeRef.new(shape: FPort, location_name: "Multicast"))
     FPorts.add_member(:clock_sync, Shapes::ShapeRef.new(shape: FPort, location_name: "ClockSync"))
@@ -968,6 +989,16 @@ module Aws::IoTWireless
     ListPartnerAccountsResponse.add_member(:sidewalk, Shapes::ShapeRef.new(shape: SidewalkAccountList, location_name: "Sidewalk"))
     ListPartnerAccountsResponse.struct_class = Types::ListPartnerAccountsResponse
 
+    ListQueuedMessagesRequest.add_member(:id, Shapes::ShapeRef.new(shape: WirelessDeviceId, required: true, location: "uri", location_name: "Id"))
+    ListQueuedMessagesRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location: "querystring", location_name: "nextToken"))
+    ListQueuedMessagesRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResults, location: "querystring", location_name: "maxResults"))
+    ListQueuedMessagesRequest.add_member(:wireless_device_type, Shapes::ShapeRef.new(shape: WirelessDeviceType, location: "querystring", location_name: "WirelessDeviceType"))
+    ListQueuedMessagesRequest.struct_class = Types::ListQueuedMessagesRequest
+
+    ListQueuedMessagesResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "NextToken"))
+    ListQueuedMessagesResponse.add_member(:downlink_queue_messages_list, Shapes::ShapeRef.new(shape: DownlinkQueueMessagesList, location_name: "DownlinkQueueMessagesList"))
+    ListQueuedMessagesResponse.struct_class = Types::ListQueuedMessagesResponse
+
     ListServiceProfilesRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location: "querystring", location_name: "nextToken"))
     ListServiceProfilesRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResults, location: "querystring", location_name: "maxResults"))
     ListServiceProfilesRequest.struct_class = Types::ListServiceProfilesRequest
@@ -1796,6 +1827,19 @@ module Aws::IoTWireless
         o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
       end)
 
+      api.add_operation(:delete_queued_messages, Seahorse::Model::Operation.new.tap do |o|
+        o.name = "DeleteQueuedMessages"
+        o.http_method = "DELETE"
+        o.http_request_uri = "/wireless-devices/{Id}/data"
+        o.input = Shapes::ShapeRef.new(shape: DeleteQueuedMessagesRequest)
+        o.output = Shapes::ShapeRef.new(shape: DeleteQueuedMessagesResponse)
+        o.errors << Shapes::ShapeRef.new(shape: ValidationException)
+        o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
+        o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
+        o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
+        o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
+      end)
+
       api.add_operation(:delete_service_profile, Seahorse::Model::Operation.new.tap do |o|
         o.name = "DeleteServiceProfile"
         o.http_method = "DELETE"
@@ -2316,6 +2360,25 @@ module Aws::IoTWireless
         o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
       end)
 
+      api.add_operation(:list_queued_messages, Seahorse::Model::Operation.new.tap do |o|
+        o.name = "ListQueuedMessages"
+        o.http_method = "GET"
+        o.http_request_uri = "/wireless-devices/{Id}/data"
+        o.input = Shapes::ShapeRef.new(shape: ListQueuedMessagesRequest)
+        o.output = Shapes::ShapeRef.new(shape: ListQueuedMessagesResponse)
+        o.errors << Shapes::ShapeRef.new(shape: ValidationException)
+        o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
+        o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
+        o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
+        o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
+        o[:pager] = Aws::Pager.new(
+          limit_key: "max_results",
+          tokens: {
+            "next_token" => "next_token"
+          }
+        )
+      end)
+
       api.add_operation(:list_service_profiles, Seahorse::Model::Operation.new.tap do |o|
         o.name = "ListServiceProfiles"
         o.http_method = "GET"

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

@@ -1129,6 +1129,39 @@ module Aws::IoTWireless
 
     class DeleteMulticastGroupResponse < Aws::EmptyStructure; end
 
+    # @note When making an API call, you may pass DeleteQueuedMessagesRequest
+    #   data as a hash:
+    #
+    #       {
+    #         id: "WirelessDeviceId", # required
+    #         message_id: "MessageId", # required
+    #         wireless_device_type: "Sidewalk", # accepts Sidewalk, LoRaWAN
+    #       }
+    #
+    # @!attribute [rw] id
+    #   Id of a given wireless device which messages will be deleted
+    #   @return [String]
+    #
+    # @!attribute [rw] message_id
+    #   if messageID=="*", the queue for a particular wireless deviceId
+    #   will be purged, otherwise, the specific message with messageId will
+    #   be deleted
+    #   @return [String]
+    #
+    # @!attribute [rw] wireless_device_type
+    #   The wireless device type, it is either Sidewalk or LoRaWAN.
+    #   @return [String]
+    #
+    class DeleteQueuedMessagesRequest < Struct.new(
+      :id,
+      :message_id,
+      :wireless_device_type)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    class DeleteQueuedMessagesResponse < Aws::EmptyStructure; end
+
     # @note When making an API call, you may pass DeleteServiceProfileRequest
     #   data as a hash:
     #
@@ -1463,6 +1496,35 @@ module Aws::IoTWireless
 
     class DisassociateWirelessGatewayFromThingResponse < Aws::EmptyStructure; end
 
+    # The message in downlink queue.
+    #
+    # @!attribute [rw] message_id
+    #   The messageId allocated by IoT Wireless for tracing purpose
+    #   @return [String]
+    #
+    # @!attribute [rw] transmit_mode
+    #   The transmit mode to use to send data to the wireless device. Can
+    #   be: `0` for UM (unacknowledge mode) or `1` for AM (acknowledge
+    #   mode).
+    #   @return [Integer]
+    #
+    # @!attribute [rw] received_at
+    #   The timestamp that Iot Wireless received the message.
+    #   @return [String]
+    #
+    # @!attribute [rw] lo_ra_wan
+    #   LoRaWAN router info.
+    #   @return [Types::LoRaWANSendDataToDevice]
+    #
+    class DownlinkQueueMessage < Struct.new(
+      :message_id,
+      :transmit_mode,
+      :received_at,
+      :lo_ra_wan)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # List of FPort assigned for different LoRaWAN application packages to
     # use
     #
@@ -2665,6 +2727,61 @@ module Aws::IoTWireless
       include Aws::Structure
     end
 
+    # @note When making an API call, you may pass ListQueuedMessagesRequest
+    #   data as a hash:
+    #
+    #       {
+    #         id: "WirelessDeviceId", # required
+    #         next_token: "NextToken",
+    #         max_results: 1,
+    #         wireless_device_type: "Sidewalk", # accepts Sidewalk, LoRaWAN
+    #       }
+    #
+    # @!attribute [rw] id
+    #   Id of a given wireless device which the downlink packets are
+    #   targeted
+    #   @return [String]
+    #
+    # @!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 in this operation.
+    #   @return [Integer]
+    #
+    # @!attribute [rw] wireless_device_type
+    #   The wireless device type, it is either Sidewalk or LoRaWAN.
+    #   @return [String]
+    #
+    class ListQueuedMessagesRequest < Struct.new(
+      :id,
+      :next_token,
+      :max_results,
+      :wireless_device_type)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!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] downlink_queue_messages_list
+    #   The messages in downlink queue.
+    #   @return [Array<Types::DownlinkQueueMessage>]
+    #
+    class ListQueuedMessagesResponse < Struct.new(
+      :next_token,
+      :downlink_queue_messages_list)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # @note When making an API call, you may pass ListServiceProfilesRequest
     #   data as a hash:
     #

data/lib/aws-sdk-iotwireless.rb

@@ -48,6 +48,6 @@ require_relative 'aws-sdk-iotwireless/customizations'
 # @!group service
 module Aws::IoTWireless
 
-  GEM_VERSION = '1.19.0'
+  GEM_VERSION = '1.20.0'
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-iotwireless
 version: !ruby/object:Gem::Version
-  version: 1.19.0
+  version: 1.20.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-12-21 00:00:00.000000000 Z
+date: 2022-01-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core