update_worker ¶

def update_worker(
    self,
    farm_id: "capo_deadline.types.farm_id.FarmId",
    fleet_id: "capo_deadline.types.fleet_id.FleetId",
    worker_id: "capo_deadline.types.worker_id.WorkerId",
    *,
    config_overrides: Optional[deadlineClientConfig] = None,
    status: Optional[
        "capo_deadline.types.updated_worker_status.UpdatedWorkerStatus"
    ] = None,
    capabilities: Optional[
        "capo_deadline.types.worker_capabilities.WorkerCapabilities"
    ] = None,
    host_properties: Optional[
        "capo_deadline.types.host_properties_request.HostPropertiesRequest"
    ] = None,
) -> "capo_deadline.types.update_worker_response.UpdateWorkerResponse":
    """<p>Updates a worker.</p>

    Args:
        farm_id: <p>The farm ID to update.</p>
        fleet_id: <p>The fleet ID to update.</p>
        worker_id: <p>The worker ID to update.</p>
        status: <p>The worker status to update.</p>
        capabilities: <p>The worker capabilities to update.</p>
        host_properties: <p>The host properties to update.</p>

    Raises:
        capo_deadline.errors.access_denied_exception.AccessDeniedException: <p>You don't have permission to perform the action.</p>
        capo_deadline.errors.conflict_exception.ConflictException: <p>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.</p>
        capo_deadline.errors.internal_server_error_exception.InternalServerErrorException: <p>Deadline Cloud can't process your request right now. Try again later.</p>
        capo_deadline.errors.resource_not_found_exception.ResourceNotFoundException: <p>The requested resource can't be found.</p>
        capo_deadline.errors.throttling_exception.ThrottlingException: <p>Your request exceeded a request rate quota.</p>
        capo_deadline.errors.validation_exception.ValidationException: <p>The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.</p>
        capo_deadline.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_deadline.types.update_worker_request.UpdateWorkerRequest]",
    ) -> OperationResponse[
        "capo_deadline.types.update_worker_response.UpdateWorkerResponse"
    ]:
        import capo_deadline._operations.deadline.update_worker

        output, http_response = (
            capo_deadline._operations.deadline.update_worker.update_worker(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    def _redact_output(
        output: "capo_deadline.types.update_worker_response.UpdateWorkerResponse",
    ) -> dict[str, Any]:
        import capo_deadline.types.update_worker_response

        return capo_deadline.types.update_worker_response.redact_sensitive(output)

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("UpdateWorker", redact_output=_redact_output),
    )
    input_: capo_deadline.types.update_worker_request.UpdateWorkerRequest = {
        "farm_id": farm_id,
        "fleet_id": fleet_id,
        "worker_id": worker_id,
    }
    if status is not None:
        input_["status"] = status
    if capabilities is not None:
        input_["capabilities"] = capabilities
    if host_properties is not None:
        input_["host_properties"] = host_properties

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output