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

UpdateWorkerSchedule

Updates the schedule for a worker.

Request Syntax


PATCH /2023-10-12/farms/farmId/fleets/fleetId/workers/workerId/schedule HTTP/1.1
Content-type: application/json

{
   "updatedSessionActions": { 
      "string" : { 
         "completedStatus": "string",
         "endedAt": "string",
         "processExitCode": number,
         "progressMessage": "string",
         "progressPercent": number,
         "startedAt": "string",
         "updatedAt": "string"
      }
   }
}

URI Request Parameters

The request uses the following URI parameters.

farmId

The farm ID to update.

Pattern: ^farm-[0-9a-f]{32}$

Required: Yes

fleetId

The fleet ID to update.

Pattern: ^fleet-[0-9a-f]{32}$

Required: Yes

workerId

The worker ID to update.

Pattern: ^worker-[0-9a-f]{32}$

Required: Yes

Request Body

The request accepts the following data in JSON format.

updatedSessionActions

The session actions associated with the worker schedule to update.

Type: String to UpdatedSessionActionInfo object map

Key Pattern: ^sessionaction-[0-9a-f]{32}-(0|([1-9][0-9]{0,9}))$

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "assignedSessions": { 
      "string" : { 
         "jobId": "string",
         "logConfiguration": { 
            "error": "string",
            "logDriver": "string",
            "options": { 
               "string" : "string" 
            },
            "parameters": { 
               "string" : "string" 
            }
         },
         "queueId": "string",
         "sessionActions": [ 
            { 
               "definition": { ... },
               "sessionActionId": "string"
            }
         ]
      }
   },
   "cancelSessionActions": { 
      "string" : [ "string" ]
   },
   "desiredWorkerStatus": "string",
   "updateIntervalSeconds": number
}

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.

assignedSessions

The assigned sessions to update.

Type: String to AssignedSession object map

Key Pattern: ^session-[0-9a-f]{32}$

cancelSessionActions

The session actions associated with the worker schedule to cancel.

Type: String to array of strings map

Key Pattern: ^session-[0-9a-f]{32}$

Array Members: Minimum number of 0 items. Maximum number of 100 items.

Pattern: ^sessionaction-[0-9a-f]{32}-(0|([1-9][0-9]{0,9}))$

desiredWorkerStatus

The status to update the worker to.

Type: String

Valid Values: STOPPED

updateIntervalSeconds

Updates the time interval (in seconds) for the schedule.

Type: Integer

Valid Range: Minimum value of 0.

Errors

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

AccessDeniedException

You don't have permission to perform the action.

HTTP Status Code: 403

ConflictException

Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.

HTTP Status Code: 409

InternalServerErrorException

Deadline Cloud can't process your request right now. Try again later.

HTTP Status Code: 500

ResourceNotFoundException

The requested resource can't be found.

HTTP Status Code: 404

ThrottlingException

Your request exceeded a request rate quota.

HTTP Status Code: 429

ValidationException

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.

HTTP Status Code: 400