IoTWireless / Client / list_queued_messages

list_queued_messages#

IoTWireless.Client.list_queued_messages(**kwargs)#

List queued messages in the downlink queue.

See also: AWS API Documentation

Request Syntax

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

  • Id (string) –

    [REQUIRED]

    The ID of a given wireless device which the downlink message packets are being sent.

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

  • MaxResults (integer) – The maximum number of results to return in this operation.

  • WirelessDeviceType (string) – The wireless device type, whic can be either Sidewalk or LoRaWAN.

Return type:

dict

Returns:

Response Syntax

{
    'NextToken': 'string',
    'DownlinkQueueMessagesList': [
        {
            'MessageId': 'string',
            'TransmitMode': 123,
            'ReceivedAt': 'string',
            'LoRaWAN': {
                'FPort': 123,
                'ParticipatingGateways': {
                    'DownlinkMode': 'SEQUENTIAL'|'CONCURRENT'|'USING_UPLINK_GATEWAY',
                    'GatewayList': [
                        {
                            'GatewayId': 'string',
                            'DownlinkFrequency': 123
                        },
                    ],
                    'TransmissionInterval': 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 the downlink queue.

      • (dict) –

        The message in the downlink queue.

        • MessageId (string) –

          The message ID assigned by IoT Wireless to each downlink message, which helps identify the message.

        • TransmitMode (integer) –

          The transmit mode to use for sending data to the wireless device. This can be 0 for UM (unacknowledge mode) or 1 for AM (acknowledge mode).

        • ReceivedAt (string) –

          The time at which Iot Wireless received the downlink message.

        • LoRaWAN (dict) –

          LoRaWAN router info.

          • FPort (integer) –

            The Fport value.

          • ParticipatingGateways (dict) –

            Choose the gateways that you want to use for the downlink data traffic when the wireless device is running in class B or class C mode.

            • DownlinkMode (string) –

              Indicates whether to send the downlink message in sequential mode or concurrent mode, or to use only the chosen gateways from the previous uplink message transmission.

            • GatewayList (list) –

              The list of gateways that you want to use for sending the downlink data traffic.

              • (dict) –

                Gateway list item object that specifies the frequency and list of gateways for which the downlink message should be sent.

                • GatewayId (string) –

                  The ID of the wireless gateways that you want to add to the list of gateways when sending downlink messages.

                • DownlinkFrequency (integer) –

                  The frequency to use for the gateways when sending a downlink message to the wireless device.

            • TransmissionInterval (integer) –

              The duration of time for which AWS IoT Core for LoRaWAN will wait before transmitting the payload to the next gateway.

Exceptions

  • IoTWireless.Client.exceptions.ValidationException

  • IoTWireless.Client.exceptions.ResourceNotFoundException

  • IoTWireless.Client.exceptions.InternalServerException

  • IoTWireless.Client.exceptions.ThrottlingException

  • IoTWireless.Client.exceptions.AccessDeniedException