Amazon IoT Device Management · JSON Structure

Iot Device Management O T A Update File Structure

Describes a file to be associated with an OTA update.

Type: object Properties: 6
Device ManagementFleet ManagementIoTOTA Updates

OTAUpdateFile is a JSON Structure definition published by Amazon IoT Device Management, describing 6 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

fileName fileType fileVersion fileLocation codeSigning attributes

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-iot-device-management/refs/heads/main/json-structure/iot-device-management-o-t-a-update-file-structure.json",
  "name": "OTAUpdateFile",
  "description": "Describes a file to be associated with an OTA update.",
  "type": "object",
  "properties": {
    "fileName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/FileName"
        },
        {
          "description": "The name of the file."
        }
      ]
    },
    "fileType": {
      "allOf": [
        {
          "$ref": "#/components/schemas/FileType"
        },
        {
          "description": "An integer value you can include in the job document to allow your devices to identify the type of file received from the cloud."
        }
      ]
    },
    "fileVersion": {
      "allOf": [
        {
          "$ref": "#/components/schemas/OTAUpdateFileVersion"
        },
        {
          "description": "The file version."
        }
      ]
    },
    "fileLocation": {
      "allOf": [
        {
          "$ref": "#/components/schemas/FileLocation"
        },
        {
          "description": "The location of the updated firmware."
        }
      ]
    },
    "codeSigning": {
      "allOf": [
        {
          "$ref": "#/components/schemas/CodeSigning"
        },
        {
          "description": "The code signing method of the file."
        }
      ]
    },
    "attributes": {
      "allOf": [
        {
          "$ref": "#/components/schemas/AttributesMap"
        },
        {
          "description": "A list of name/attribute pairs."
        }
      ]
    }
  }
}