update_step `async` ¶

update_step(
    farm_id: FarmId,
    queue_id: QueueId,
    job_id: JobId,
    step_id: StepId,
    target_task_run_status: StepTargetTaskRunStatus,
    *,
    config_overrides: Optional[AsyncdeadlineClientConfig] = None,
    client_token: Optional[ClientToken] = None,
) -> UpdateStepResponse

Updates a step.

Parameters:

farm_id (FarmId) –

The farm ID to update.
queue_id (QueueId) –

The queue ID to update.
job_id (JobId) –

The job ID to update.
step_id (StepId) –

The step ID to update.
client_token (Optional[ClientToken], default: None ) –

The unique token which the server uses to recognize retries of the same request.
target_task_run_status (StepTargetTaskRunStatus) –

The task status to update the step's tasks to.

Raises:

AccessDeniedException –

You don't have permission to perform the action.
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.
InternalServerErrorException –

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

The requested resource can't be found.
ThrottlingException –

Your request exceeded a request rate quota.
ValidationException –

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

The service returned an error code this client does not model.

Source code in docs_src/capo_deadline/_services/async_deadline.py

async def update_step(
    self,
    farm_id: "capo_deadline.types.farm_id.FarmId",
    queue_id: "capo_deadline.types.queue_id.QueueId",
    job_id: "capo_deadline.types.job_id.JobId",
    step_id: "capo_deadline.types.step_id.StepId",
    target_task_run_status: "capo_deadline.types.step_target_task_run_status.StepTargetTaskRunStatus",
    *,
    config_overrides: Optional[AsyncdeadlineClientConfig] = None,
    client_token: Optional["capo_deadline.types.client_token.ClientToken"] = None,
) -> "capo_deadline.types.update_step_response.UpdateStepResponse":
    """<p>Updates a step.</p>

    Args:
        farm_id: <p>The farm ID to update.</p>
        queue_id: <p>The queue ID to update.</p>
        job_id: <p>The job ID to update.</p>
        step_id: <p>The step ID to update.</p>
        client_token: <p>The unique token which the server uses to recognize retries of the same request.</p>
        target_task_run_status: <p>The task status to update the step's tasks to.</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.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_deadline.types.update_step_request.UpdateStepRequest]",
    ) -> AsyncOperationResponse[
        "capo_deadline.types.update_step_response.UpdateStepResponse"
    ]:
        import capo_deadline._operations.deadline.update_step

        (
            output,
            http_response,
        ) = await capo_deadline._operations.deadline.update_step.async_update_step(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateStep")
    )
    input_: capo_deadline.types.update_step_request.UpdateStepRequest = {
        "farm_id": farm_id,
        "queue_id": queue_id,
        "job_id": job_id,
        "step_id": step_id,
        "target_task_run_status": target_task_run_status,
    }
    if client_token is None:
        client_token = str(uuid.uuid4())
    input_["client_token"] = client_token

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output

update_step async ¶

update_step `async` ¶