Deadline CLI Reference¶
deadline job¶
Commands to work with Deadline Cloud jobs in a queue.
Use the deadline bundle submit or deadline bundle gui-submit commands to create a job
from a job bundle.
Usage:
deadline job [OPTIONS] COMMAND [ARGS]...
Options:
--help Show this message and exit.
cancel¶
Cancel a Deadline Cloud job from running, optionally marking it with an alternative status such as SUSPENDED, SUCCEEDED or FAILED.
Usage:
deadline job cancel [OPTIONS]
Options:
--profile TEXT The AWS profile to use.
--farm-id TEXT The farm to use.
--queue-id TEXT The queue to use.
--job-id TEXT The job to cancel.
--mark-as [suspended|canceled|failed|succeeded]
The status to apply to all active tasks in
the job.
--yes Automatically accept any confirmation
prompts
--help Show this message and exit.
download-output¶
Download a the output of a Deadline Cloud job in the queue that was saved as job attachments.
Usage:
deadline job download-output [OPTIONS]
Options:
--profile TEXT The AWS profile to use.
--farm-id TEXT The farm to use.
--queue-id TEXT The queue to use.
--job-id TEXT The job to use.
--step-id TEXT The step to use.
--task-id TEXT The task to use.
--conflict-resolution [skip|overwrite|create_copy]
How to handle downloads if a file already
exists: CREATE_COPY (default): Download the
file with a new name, appending '(1)' to the
end SKIP: Do not download the file
OVERWRITE: Download and replace the existing
file
--yes Automatically accept any confirmation
prompts
--output [verbose|json] Specifies the output format of the messages
printed to stdout. VERBOSE: Displays
messages in a human-readable text format.
JSON: Displays messages in JSON line format,
so that the info can be easily
parsed/consumed by custom scripts.
--help Show this message and exit.
get¶
Get the details of a Deadline Cloud job in the queue.
Usage:
deadline job get [OPTIONS]
Options:
--profile TEXT The AWS profile to use.
--farm-id TEXT The farm to use.
--queue-id TEXT The queue to use.
--job-id TEXT The job to get.
--help Show this message and exit.
list¶
Lists the Deadline Cloud jobs in the queue.
Usage:
deadline job list [OPTIONS]
Options:
--profile TEXT The AWS profile to use.
--farm-id TEXT The farm to use.
--queue-id TEXT The queue to use.
--page-size INTEGER The number of jobs to load at a time.
--item-offset INTEGER The index of the job to start listing from.
--help Show this message and exit.
logs¶
Prints a Deadline Cloud session log stored in CloudWatch logs for the job. Defaults to a recent/ongoing session if a session id is not provided.
By default, it returns the most recent 100 log lines, but this can be adjusted using the --limit parameter.
If session-id is not provided but job-id is, the command will automatically select a session using the following priority: 1. If there are ongoing sessions (no endedAt time), always prefer them 2. Among ongoing sessions, select the one that started most recently 3. If no ongoing sessions exist, select the completed session that ended most recently
Use --next-token with the value from a previous response to get the next page of results of log output prior to the last page.
Usage:
deadline job logs [OPTIONS]
Options:
--profile TEXT The AWS profile to use.
--farm-id TEXT The farm to use.
--queue-id TEXT The queue to use.
--job-id TEXT The job to get logs for.
--session-id TEXT The session ID to get logs for. If not provided
and job-id is specified, will use the latest
session based on endedAt time.
--session-action-id TEXT The session action ID to get logs for. The session
ID will be derived from this.
--limit INTEGER Maximum number of log lines to return.
--start-time TEXT Start time for logs in ISO format (e.g.,
2023-01-01T12:00:00Z).
--end-time TEXT End time for logs in ISO format (e.g.,
2023-01-01T13:00:00Z).
--next-token TEXT Token for pagination of results.
--output [verbose|json] Output format (verbose or json).
--timezone [utc|local] Timezone for timestamps (utc or local). Default is
utc.
--help Show this message and exit.
requeue-tasks¶
Requeue tasks of a Deadline Cloud job. By default, requeues all FAILED, CANCELED, and SUSPENDED tasks.
Use the --run-status option to requeue tasks of different status.
Usage:
deadline job requeue-tasks [OPTIONS]
Options:
--profile TEXT The AWS profile to use.
--farm-id TEXT The farm to use.
--queue-id TEXT The queue to use.
--job-id TEXT The job to requeue tasks for.
--run-status [suspended|canceled|failed|succeeded|not_compatible]
Requeue tasks of this status. Repeat the
option to provide multiple statuses.
--yes Automatically accept any confirmation
prompts
--help Show this message and exit.
trace-schedule¶
EXPERIMENTAL - Generate statistics from a job with a trace that you can view and explore interactively.
To visualize the trace output file when providing the options "--trace-format chrome --trace-file output.json", open the Perfetto Tracing UI in a browser and choose "Open trace file".
Usage:
deadline job trace-schedule [OPTIONS]
Options:
--profile TEXT The AWS profile to use.
--farm-id TEXT The farm to use.
--queue-id TEXT The queue to use.
--job-id TEXT The job to trace.
-v, --verbose Output verbose trace details.
--trace-format [chrome] The tracing format to write.
--trace-file TEXT The tracing file to write.
--help Show this message and exit.
wait¶
Wait for a Deadline Cloud job to complete and then print information about failed step-task IDs.
This command blocks until the job's taskRunStatus reaches a terminal state (SUCCEEDED, FAILED, CANCELED, SUSPENDED, or NOT_COMPATIBLE), then prints a list of any failed step-task combinations.
The command uses exponential backoff for polling, starting at 0.5 seconds and doubling the interval after each check until it reaches the maximum polling interval.
Exit codes:
0 - Job succeeded
1 - Timeout waiting for job completion
2 - Job failed (any tasks failed)
3 - Job was canceled
4 - Job was suspended
5 - Job is not compatible
Usage:
deadline job wait [OPTIONS]
Options:
--profile TEXT The AWS profile to use.
--farm-id TEXT The farm to use.
--queue-id TEXT The queue to use.
--job-id TEXT The job to wait for.
--max-poll-interval INTEGER Maximum polling interval in seconds.
--timeout INTEGER Timeout in seconds (0 for no timeout).
--output [verbose|json] Output format (verbose or json).
--help Show this message and exit.