DeadlineCloud / Client / update_step

update_step#

DeadlineCloud.Client.update_step(**kwargs)#

Updates a step.

See also: AWS API Documentation

Request Syntax

response = client.update_step(
    clientToken='string',
    farmId='string',
    queueId='string',
    jobId='string',
    stepId='string',
    targetTaskRunStatus='READY'|'FAILED'|'SUCCEEDED'|'CANCELED'|'SUSPENDED'|'PENDING'
)
Parameters:

  • clientToken (string) –

    The unique token which the server uses to recognize retries of the same request.

    This field is autopopulated if not provided.

  • farmId (string) –

    [REQUIRED]

    The farm ID to update.

  • queueId (string) –

    [REQUIRED]

    The queue ID to update.

  • jobId (string) –

    [REQUIRED]

    The job ID to update.

  • stepId (string) –

    [REQUIRED]

    The step ID to update.

  • targetTaskRunStatus (string) –

    [REQUIRED]

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

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

Exceptions

  • DeadlineCloud.Client.exceptions.AccessDeniedException

  • DeadlineCloud.Client.exceptions.InternalServerErrorException

  • DeadlineCloud.Client.exceptions.ResourceNotFoundException

  • DeadlineCloud.Client.exceptions.ThrottlingException

  • DeadlineCloud.Client.exceptions.ConflictException

  • DeadlineCloud.Client.exceptions.ValidationException