Skip to content

Commit 91ccaee

Browse files
author
AWS
committed
AWS IoT Wireless Update: 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 parent 660362d commit 91ccaee

File tree

3 files changed

+145
-1
lines changed

3 files changed

+145
-1
lines changed
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"type": "feature",
3+
"category": "AWS IoT Wireless",
4+
"contributor": "",
5+
"description": "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."
6+
}

services/iotwireless/src/main/resources/codegen-resources/paginators-1.json

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,11 @@
2525
"output_token": "NextToken",
2626
"limit_key": "MaxResults"
2727
},
28+
"ListQueuedMessages": {
29+
"input_token": "NextToken",
30+
"output_token": "NextToken",
31+
"limit_key": "MaxResults"
32+
},
2833
"ListServiceProfiles": {
2934
"input_token": "NextToken",
3035
"output_token": "NextToken",

services/iotwireless/src/main/resources/codegen-resources/service-2.json

Lines changed: 134 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -404,6 +404,24 @@
404404
],
405405
"documentation":"<p>Deletes a multicast group if it is not in use by a fuota task.</p>"
406406
},
407+
"DeleteQueuedMessages":{
408+
"name":"DeleteQueuedMessages",
409+
"http":{
410+
"method":"DELETE",
411+
"requestUri":"/wireless-devices/{Id}/data",
412+
"responseCode":204
413+
},
414+
"input":{"shape":"DeleteQueuedMessagesRequest"},
415+
"output":{"shape":"DeleteQueuedMessagesResponse"},
416+
"errors":[
417+
{"shape":"ValidationException"},
418+
{"shape":"ResourceNotFoundException"},
419+
{"shape":"ThrottlingException"},
420+
{"shape":"InternalServerException"},
421+
{"shape":"AccessDeniedException"}
422+
],
423+
"documentation":"<p> The operation to delete queued messages. </p>"
424+
},
407425
"DeleteServiceProfile":{
408426
"name":"DeleteServiceProfile",
409427
"http":{
@@ -1063,6 +1081,23 @@
10631081
],
10641082
"documentation":"<p>Lists the partner accounts associated with your AWS account.</p>"
10651083
},
1084+
"ListQueuedMessages":{
1085+
"name":"ListQueuedMessages",
1086+
"http":{
1087+
"method":"GET",
1088+
"requestUri":"/wireless-devices/{Id}/data"
1089+
},
1090+
"input":{"shape":"ListQueuedMessagesRequest"},
1091+
"output":{"shape":"ListQueuedMessagesResponse"},
1092+
"errors":[
1093+
{"shape":"ValidationException"},
1094+
{"shape":"ResourceNotFoundException"},
1095+
{"shape":"InternalServerException"},
1096+
{"shape":"ThrottlingException"},
1097+
{"shape":"AccessDeniedException"}
1098+
],
1099+
"documentation":"<p>The operation to list queued messages. </p>"
1100+
},
10661101
"ListServiceProfiles":{
10671102
"name":"ListServiceProfiles",
10681103
"http":{
@@ -2278,6 +2313,38 @@
22782313
"members":{
22792314
}
22802315
},
2316+
"DeleteQueuedMessagesRequest":{
2317+
"type":"structure",
2318+
"required":[
2319+
"Id",
2320+
"MessageId"
2321+
],
2322+
"members":{
2323+
"Id":{
2324+
"shape":"WirelessDeviceId",
2325+
"documentation":"<p>Id of a given wireless device which messages will be deleted </p>",
2326+
"location":"uri",
2327+
"locationName":"Id"
2328+
},
2329+
"MessageId":{
2330+
"shape":"MessageId",
2331+
"documentation":"<p>if messageID==\"*\", the queue for a particular wireless deviceId will be purged, otherwise, the specific message with messageId will be deleted </p>",
2332+
"location":"querystring",
2333+
"locationName":"messageId"
2334+
},
2335+
"WirelessDeviceType":{
2336+
"shape":"WirelessDeviceType",
2337+
"documentation":"<p>The wireless device type, it is either Sidewalk or LoRaWAN. </p>",
2338+
"location":"querystring",
2339+
"locationName":"WirelessDeviceType"
2340+
}
2341+
}
2342+
},
2343+
"DeleteQueuedMessagesResponse":{
2344+
"type":"structure",
2345+
"members":{
2346+
}
2347+
},
22812348
"DeleteServiceProfileRequest":{
22822349
"type":"structure",
22832350
"required":["Id"],
@@ -2662,6 +2729,29 @@
26622729
"max":256
26632730
},
26642731
"Double":{"type":"double"},
2732+
"DownlinkQueueMessage":{
2733+
"type":"structure",
2734+
"members":{
2735+
"MessageId":{
2736+
"shape":"MessageId",
2737+
"documentation":"<p> The messageId allocated by IoT Wireless for tracing purpose</p>"
2738+
},
2739+
"TransmitMode":{
2740+
"shape":"TransmitMode",
2741+
"documentation":"<p>The transmit mode to use to send data to the wireless device. Can be: <code>0</code> for UM (unacknowledge mode) or <code>1</code> for AM (acknowledge mode).</p>"
2742+
},
2743+
"ReceivedAt":{
2744+
"shape":"ISODateTimeString",
2745+
"documentation":"<p>The timestamp that Iot Wireless received the message.</p>"
2746+
},
2747+
"LoRaWAN":{"shape":"LoRaWANSendDataToDevice"}
2748+
},
2749+
"documentation":"<p>The message in downlink queue.</p>"
2750+
},
2751+
"DownlinkQueueMessagesList":{
2752+
"type":"list",
2753+
"member":{"shape":"DownlinkQueueMessage"}
2754+
},
26652755
"DrMax":{
26662756
"type":"integer",
26672757
"max":15,
@@ -3675,6 +3765,49 @@
36753765
}
36763766
}
36773767
},
3768+
"ListQueuedMessagesRequest":{
3769+
"type":"structure",
3770+
"required":["Id"],
3771+
"members":{
3772+
"Id":{
3773+
"shape":"WirelessDeviceId",
3774+
"documentation":"<p>Id of a given wireless device which the downlink packets are targeted </p>",
3775+
"location":"uri",
3776+
"locationName":"Id"
3777+
},
3778+
"NextToken":{
3779+
"shape":"NextToken",
3780+
"documentation":"<p>To retrieve the next set of results, the <code>nextToken</code> value from a previous response; otherwise <b>null</b> to receive the first set of results.</p>",
3781+
"location":"querystring",
3782+
"locationName":"nextToken"
3783+
},
3784+
"MaxResults":{
3785+
"shape":"MaxResults",
3786+
"documentation":"<p>The maximum number of results to return in this operation.</p>",
3787+
"location":"querystring",
3788+
"locationName":"maxResults"
3789+
},
3790+
"WirelessDeviceType":{
3791+
"shape":"WirelessDeviceType",
3792+
"documentation":"<p>The wireless device type, it is either Sidewalk or LoRaWAN.</p>",
3793+
"location":"querystring",
3794+
"locationName":"WirelessDeviceType"
3795+
}
3796+
}
3797+
},
3798+
"ListQueuedMessagesResponse":{
3799+
"type":"structure",
3800+
"members":{
3801+
"NextToken":{
3802+
"shape":"NextToken",
3803+
"documentation":"<p>To retrieve the next set of results, the <code>nextToken</code> value from a previous response; otherwise <b>null</b> to receive the first set of results.</p>"
3804+
},
3805+
"DownlinkQueueMessagesList":{
3806+
"shape":"DownlinkQueueMessagesList",
3807+
"documentation":"<p>The messages in downlink queue.</p>"
3808+
}
3809+
}
3810+
},
36783811
"ListServiceProfilesRequest":{
36793812
"type":"structure",
36803813
"members":{
@@ -5837,5 +5970,5 @@
58375970
"documentation":"<p>WirelessMetadata object.</p>"
58385971
}
58395972
},
5840-
"documentation":"<p>AWS IoT Wireless API documentation</p>"
5973+
"documentation":"<p>AWS IoT Wireless provides bi-directional communication between internet-connected wireless devices and the AWS Cloud. To onboard both LoRaWAN and Sidewalk devices to AWS IoT, use the IoT Wireless API. These wireless devices use the Low Power Wide Area Networking (LPWAN) communication protocol to communicate with AWS IoT.</p> <p>Using the API, you can perform create, read, update, and delete operations for your wireless devices, gateways, destinations, and profiles. After onboarding your devices, you can use the API operations to set log levels and monitor your devices with CloudWatch.</p> <p>You can also use the API operations to create multicast groups and schedule a multicast session for sending a downlink message to devices in the group. By using Firmware Updates Over-The-Air (FUOTA) API operations, you can create a FUOTA task and schedule a session to update the firmware of individual devices or an entire group of devices in a multicast group.</p>"
58415974
}

0 commit comments

Comments
 (0)