AWS IoT Wireless

2022/01/06 - AWS IoT Wireless - 2 new api methods

Changes  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.

DeleteQueuedMessages (new) Link ¶

The operation to delete queued messages.

See also: AWS API Documentation

Request Syntax

client.delete_queued_messages(
    Id='string',
    MessageId='string',
    WirelessDeviceType='Sidewalk'|'LoRaWAN'
)
type Id

string

param Id

[REQUIRED]

Id of a given wireless device which messages will be deleted

type MessageId

string

param MessageId

[REQUIRED]

if messageID=="*", the queue for a particular wireless deviceId will be purged, otherwise, the specific message with messageId will be deleted

type WirelessDeviceType

string

param WirelessDeviceType

The wireless device type, it is either Sidewalk or LoRaWAN.

rtype

dict

returns

Response Syntax

{}

Response Structure

  • (dict) --

ListQueuedMessages (new) Link ¶

The operation to list queued messages.

See also: AWS API Documentation

Request Syntax

client.list_queued_messages(
    Id='string',
    NextToken='string',
    MaxResults=123,
    WirelessDeviceType='Sidewalk'|'LoRaWAN'
)
type Id

string

param Id

[REQUIRED]

Id of a given wireless device which the downlink packets are targeted

type NextToken

string

param NextToken

To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

type MaxResults

integer

param MaxResults

The maximum number of results to return in this operation.

type WirelessDeviceType

string

param WirelessDeviceType

The wireless device type, it is either Sidewalk or LoRaWAN.

rtype

dict

returns

Response Syntax

{
    'NextToken': 'string',
    'DownlinkQueueMessagesList': [
        {
            'MessageId': 'string',
            'TransmitMode': 123,
            'ReceivedAt': 'string',
            'LoRaWAN': {
                'FPort': 123
            }
        },
    ]
}

Response Structure

  • (dict) --

    • NextToken (string) --

      To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

    • DownlinkQueueMessagesList (list) --

      The messages in downlink queue.

      • (dict) --

        The message in downlink queue.

        • MessageId (string) --

          The messageId allocated by IoT Wireless for tracing purpose

        • TransmitMode (integer) --

          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).

        • ReceivedAt (string) --

          The timestamp that Iot Wireless received the message.

        • LoRaWAN (dict) --

          LoRaWAN router info.

          • FPort (integer) --

            The Fport value.