queued_messages

Creates, updates, deletes, gets or lists a queued_messages resource.

Overview

Name	queued_messages
Type	Resource
Id	aws.iotwireless.queued_messages

Fields

The following fields are returned by SELECT queries:

list_queued_messages

Name	Datatype	Description
downlink_queue_messages_list	array	The messages in the downlink queue.
next_token	string	To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_queued_messages	select	id, region	nextToken, maxResults, WirelessDeviceType	List queued messages in the downlink queue.
delete_queued_messages	delete	id, messageId, region	WirelessDeviceType	Remove queued messages from the downlink queue.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
id	string	The ID of a given wireless device for which downlink messages will be deleted.
messageId	string	If message ID is "*", it cleares the entire downlink queue for a given device, specified by the wireless device ID. Otherwise, the downlink message with the specified message ID will be deleted.
region	string	AWS region (default: us-east-1)
WirelessDeviceType	string	The wireless device type, which can be either Sidewalk or LoRaWAN.
maxResults	integer	The maximum number of results to return in this operation.
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.

SELECT examples

list_queued_messages

List queued messages in the downlink queue.

SELECT
downlink_queue_messages_list,
next_token
FROM aws.iotwireless.queued_messages
WHERE id = '{{ id }}' -- required
AND region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
AND WirelessDeviceType = '{{ WirelessDeviceType }}'
;

DELETE examples

delete_queued_messages

Remove queued messages from the downlink queue.

DELETE FROM aws.iotwireless.queued_messages
WHERE id = '{{ id }}' --required
AND messageId = '{{ messageId }}' --required
AND region = '{{ region }}' --required
AND WirelessDeviceType = '{{ WirelessDeviceType }}'
;