Skip to main content
Do you like Artifex? Give it a ⭐ star on GitHub!

Job Status

Get the status of the job that is currently running. If no job is running, an error will be raised.

Arguments

No parameters.

Response

  • status
    JobStatus

    An object indicating the job status. Possible values are:
    • JobStatus.ON_HOLD: the job is on hold and waiting for user action. This can only occur for jobs generated on the Tanaos platform.
    • JobStatus.IN_PROGRESS: the job is currently being executed.
    • JobStatus.COMPLETED: the job has been successfully executed
    • JobStatus.FAILED: the job has failed.
  • progress
    float

    The percentage of progress of the job, expressed as a number between 0 and 1.
from synthex import Synthex

client = Synthex()

# Start a job before getting its status,
# otherwise an error will be raised

status = client.jobs.status()
{
    "status": "In Progress",
    "progress": 0.5,
}