---
title: "PATCH /2023-10-12/farms/{farmId}/fleets/{fleetId}/workers/{workerId}"
method: PATCH
path: "/2023-10-12/farms/{farmId}/fleets/{fleetId}/workers/{workerId}"
---

# PATCH /2023-10-12/farms/{farmId}/fleets/{fleetId}/workers/{workerId}

`PATCH /2023-10-12/farms/{farmId}/fleets/{fleetId}/workers/{workerId}`

Updates a worker.

## Path parameters

- `farmId` string, required
- `fleetId` string, required
- `workerId` string, required

## Request body

- object
  - `status` 'STARTED' | 'STOPPING' | 'STOPPED' — The worker status to update.
  - `capabilities` object — The details for worker capabilities.
    - `amounts` WorkerAmountCapability[] — The worker capabilities amounts on a list of worker capabilities.
      - `name` string, required — The name of the worker amount capability.
      - `value` number, float, required — The value of the worker amount capability.
    - `attributes` WorkerAttributeCapability[] — The worker attribute capabilities in the list of attribute capabilities.
      - `name` string, required — The name of the worker attribute capability.
      - `values` AttributeCapabilityValue[], required — The values of the worker amount capability.
  - `hostProperties` object — The host property details.
    - `ipAddresses` object — The IP address of the host.
      - `ipV4Addresses` IpV4Address[] — The IpV4 address of the network.
      - `ipV6Addresses` IpV6Address[] — The IpV6 address for the network and node component.
    - `hostName` string — The host name.

## Response `200`

Success

- UpdateWorkerResponse
  - `log` object — The worker log to update.
    - `logDriver` string, required — The log drivers for worker related logs.
    - `options` object — The options for a log driver.
    - `parameters` object — The parameters for the log configuration.
    - `error` string — The log configuration error details.
  - `hostConfiguration` object — The script that runs as a worker is starting up that you can use to provide additional configuration for workers in your fleet.
    - `scriptBody` string, password, required — <p>The text of the script that runs as a worker is starting up that you can use to provide additional configuration for workers in your fleet. The script runs after a worker enters the <code>STARTING</code> state and before the worker processes tasks.</p> <p>For more information about using the script, see <a href="https://docs.aws.amazon.com/deadline-cloud/latest/developerguide/smf-admin.html">Run scripts as an administrator to configure workers</a> in the <i>Deadline Cloud Developer Guide</i>. </p> <important> <p>The script runs as an administrative user (<code>sudo root</code> on Linux, as an Administrator on Windows). </p> </important>
    - `scriptTimeoutSeconds` integer — <p>The maximum time that the host configuration can run. If the timeout expires, the worker enters the <code>NOT RESPONDING</code> state and shuts down. You are charged for the time that the worker is running the host configuration script.</p> <note> <p>You should configure your fleet for a maximum of one worker while testing your host configuration script to avoid starting additional workers.</p> </note> <p>The default is 300 seconds (5 minutes).</p>

## Other responses

- `480` — AccessDeniedException
- `481` — InternalServerErrorException
- `482` — ResourceNotFoundException
- `483` — ThrottlingException
- `484` — ConflictException
- `485` — ValidationException

---

[API](https://skmtc.net/aws/apis/deadline.md) · [All operations](https://skmtc.net/aws/apis/deadline/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/deadline/versions/259a7ebfefa8/schema)