POST

/fuota-tasks

http://api.iotwireless.{region}.amazonaws.com/fuota-tasks

Creates a FUOTA task.

Access Token Required: API Key

Body Params

Namestring

The name of a FUOTA task.

Tagsarray

The tag to attach to the specified resource. Tags are metadata that you can use to manage a resource.

LoRaWANobject

The LoRaWAN information used with a FUOTA task.

Descriptionstring

The description of the new resource.

FragmentSizeBytesinteger

The size of each fragment in bytes. Currently only supported in fuota tasks with multicast groups.

RedundancyPercentinteger

The percentage of added redundant fragments. For example, if firmware file is 100 bytes and fragment size is 10 bytes, with <code>RedundancyPercent</code> set to 50(%), the final number of encoded fragments is (100 / 10) + (100 / 10 * 50%) = 15.

ClientRequestTokenstring

Each resource must have a unique client request token. If you try to create a new resource with the same token as a resource that already exists, an exception occurs. If you omit this value, AWS SDKs will automatically generate a unique client request.

FirmwareUpdateRolestringrequired

The firmware update role that is to be used with a FUOTA task.

FragmentIntervalMSinteger

The interval of sending fragments in milliseconds. Currently the interval will be rounded to the nearest second. Note that this interval only controls the timing when the cloud sends the fragments down. The actual delay of receiving fragments at device side depends on the device's class and the communication delay with the cloud.

FirmwareUpdateImagestringrequired

The S3 URI points to a firmware update image that is to be used with a FUOTA task.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request POST \
2     --url 'http://api.iotwireless.{region}.amazonaws.com/fuota-tasks' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}