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

CreateJobForDevices

Creates a job to run on a device. A job can update a device's software or reboot it.

Request Syntax


POST /jobs HTTP/1.1
Content-type: application/json

{
   "DeviceIds": [ "string" ],
   "DeviceJobConfig": { 
      "OTAJobConfig": { 
         "AllowMajorVersionUpdate": boolean,
         "ImageVersion": "string"
      }
   },
   "JobType": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

DeviceIds

ID of target device.

Type: Array of strings

Array Members: Fixed number of 1 item.

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

Pattern: ^[a-zA-Z0-9\-\_]+$

Required: Yes

DeviceJobConfig

Configuration settings for a software update job.

Type: DeviceJobConfig object

Required: No

JobType

The type of job to run.

Type: String

Valid Values: OTA | REBOOT

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "Jobs": [ 
      { 
         "DeviceId": "string",
         "JobId": "string"
      }
   ]
}

Response Elements

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

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

Jobs

A list of jobs.

Type: Array of Job objects

Errors

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

AccessDeniedException

The requestor does not have permission to access the target action or resource.

HTTP Status Code: 403

ConflictException

The target resource is in use.

HTTP Status Code: 409

InternalServerException

An internal error occurred.

HTTP Status Code: 500

ResourceNotFoundException

The target resource was not found.

HTTP Status Code: 404

ValidationException

The request contains an invalid parameter value.

HTTP Status Code: 400