ListQueuedMessages - AWS IoT Wireless

ListQueuedMessages

List queued messages in the downlink queue.

Request Syntax

GET /wireless-devices/Id/data?maxResults=MaxResults&nextToken=NextToken&WirelessDeviceType=WirelessDeviceType HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

Id

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

Length Constraints: Maximum length of 256.

Required: Yes

MaxResults

The maximum number of results to return in this operation.

Valid Range: Minimum value of 0. Maximum value of 250.

NextToken

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

Length Constraints: Maximum length of 4096.

WirelessDeviceType

The wireless device type, whic can be either Sidewalk or LoRaWAN.

Valid Values: Sidewalk | LoRaWAN

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "DownlinkQueueMessagesList": [ { "LoRaWAN": { "FPort": number }, "MessageId": "string", "ReceivedAt": "string", "TransmitMode": number } ], "NextToken": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

DownlinkQueueMessagesList

The messages in the downlink queue.

Type: Array of DownlinkQueueMessage objects

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: String

Length Constraints: Maximum length of 4096.

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

User does not have permission to perform this action.

HTTP Status Code: 403

InternalServerException

An unexpected error occurred while processing a request.

HTTP Status Code: 500

ResourceNotFoundException

Resource does not exist.

HTTP Status Code: 404

ThrottlingException

The request was denied because it exceeded the allowed API request rate.

HTTP Status Code: 429

ValidationException

The input did not meet the specified constraints.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: