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

UpdateWorker

Updates a worker.

Request Syntax


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

{
   "capabilities": { 
      "amounts": [ 
         { 
            "name": "string",
            "value": number
         }
      ],
      "attributes": [ 
         { 
            "name": "string",
            "values": [ "string" ]
         }
      ]
   },
   "hostProperties": { 
      "hostName": "string",
      "ipAddresses": { 
         "ipV4Addresses": [ "string" ],
         "ipV6Addresses": [ "string" ]
      }
   },
   "status": "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.

capabilities

The worker capabilities to update.

Type: WorkerCapabilities object

Required: No

hostProperties

The host properties to update.

Type: HostPropertiesRequest object

Required: No

status

The worker status to update.

Type: String

Valid Values: STARTED | STOPPING | STOPPED

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "log": { 
      "error": "string",
      "logDriver": "string",
      "options": { 
         "string" : "string" 
      },
      "parameters": { 
         "string" : "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.

log

The worker log to update.

Type: LogConfiguration object

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