Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

UpdateFuotaTask

Updates properties of a FUOTA task.

Request Syntax


PATCH /fuota-tasks/Id HTTP/1.1
Content-type: application/json

{
   "Description": "string",
   "Descriptor": "string",
   "FirmwareUpdateImage": "string",
   "FirmwareUpdateRole": "string",
   "FragmentIntervalMS": number,
   "FragmentSizeBytes": number,
   "LoRaWAN": { 
      "RfRegion": "string"
   },
   "Name": "string",
   "RedundancyPercent": number
}

URI Request Parameters

The request uses the following URI parameters.

Id

The ID of a FUOTA task.

Length Constraints: Maximum length of 256.

Required: Yes

Request Body

The request accepts the following data in JSON format.

Description

The description of the new resource.

Type: String

Length Constraints: Maximum length of 2048.

Required: No

Descriptor

The descriptor is the metadata about the file that is transferred to the device using FUOTA, such as the software version. It is a binary field encoded in base64.

Type: String

Length Constraints: Maximum length of 332.

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

Required: No

FirmwareUpdateImage

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 4096.

Required: No

FirmwareUpdateRole

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Required: No

FragmentIntervalMS

The interval for sending fragments in milliseconds, rounded to the nearest second.

Note

This interval only determines the timing for when the Cloud sends down the fragments to yor device. There can be a delay for when your device will receive these fragments. This delay depends on the device's class and the communication delay with the cloud.

Type: Integer

Valid Range: Minimum value of 1.

Required: No

FragmentSizeBytes

The size of each fragment in bytes. This parameter is supported only for FUOTA tasks with multicast groups.

Type: Integer

Valid Range: Minimum value of 1.

Required: No

LoRaWAN

The LoRaWAN information used with a FUOTA task.

Type: LoRaWANFuotaTask object

Required: No

Name

The name of a FUOTA task.

Type: String

Length Constraints: Maximum length of 256.

Required: No

RedundancyPercent

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

Type: Integer

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

Required: No

Response Syntax


HTTP/1.1 204

Response Elements

If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

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

ConflictException

Adding, updating, or deleting the resource can cause an inconsistent state.

HTTP Status Code: 409

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