SendDataToWirelessDevice - AWS IoT Wireless

SendDataToWirelessDevice

Sends a decrypted application data frame to a device.

Request Syntax

POST /wireless-devices/Id/data HTTP/1.1 Content-type: application/json { "PayloadData": "string", "TransmitMode": number, "WirelessMetadata": { "LoRaWAN": { "FPort": number }, "Sidewalk": { "MessageType": "string", "Seq": number } } }

URI Request Parameters

The request uses the following URI parameters.

Id

The ID of the wireless device to receive the data.

Length Constraints: Maximum length of 256.

Required: Yes

Request Body

The request accepts the following data in JSON format.

PayloadData

The message payload to send.

Type: String

Length Constraints: Maximum length of 2048.

Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$

Required: Yes

TransmitMode

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

Type: Integer

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

Required: Yes

WirelessMetadata

Metadata about the message request.

Type: WirelessMetadata object

Required: No

Response Syntax

HTTP/1.1 202 Content-type: application/json { "MessageId": "string" }

Response Elements

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

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

MessageId

The ID of the message sent to the wireless device.

Type: String

Errors

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

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: