/wireless-devices/{Id}/data

The AWS IoT Wireless multi-region endpoint

https://api.iotwireless.{region}.amazonaws.com

POST

Sends a decrypted application data frame to a device.

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request POST 'https://api.iotwireless.{region}.amazonaws.com/wireless-devices//data' \
--header 'Content-Type: application/json' \
--data-raw '{
    "TransmitMode": 0,
    "PayloadData": "string",
    "WirelessMetadata": {
        "LoRaWAN": {
            "FPort": 0
        },
        "Sidewalk": {
            "Seq": 0,
            "MessageType": "CUSTOM_COMMAND_ID_NOTIFY"
        }
    }
}'

Response Example

202 - Example 1

{
    "MessageId": "string"
}

Request

Path Params

string

required

The ID of the wireless device to receive the data.

Body Params application/json

TransmitMode

integer

required

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

>= 0<= 1

PayloadData

string

required

The binary to be sent to the end device, encoded in base64.

<= 2048 characters

Match pattern:

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

WirelessMetadata

object

optional

WirelessMetadata object.

LoRaWAN

object

optional

LoRaWAN device info.

Sidewalk

object

optional

The Sidewalk account credentials.

Examples

Responses

🟢202Success

application/json

Body

MessageId

string

optional

The ID of the message sent to the wireless device.

🟠480ValidationException

🟠481ResourceNotFoundException

🟠482ThrottlingException

🟠483InternalServerException

Modified at 2022-09-10 19:46:41

/jobs/{jobId}