Skip to content

Deadline CLI Reference

deadline attachment

BETA - Commands to work with Deadline Cloud job attachments.

Usage:

deadline attachment [OPTIONS] COMMAND [ARGS]...

Options:

  --help  Show this message and exit.

download

BETA - Download Job Attachment data files for given job attachments manifest(s).

Usage:

deadline attachment download [OPTIONS]

Options:

  -m, --manifests TEXT            File path(s) to manifest formatted file(s).
                                  File name has to contain the hash of
                                  corresponding source path.  [required]
  --s3-root-uri TEXT              Job Attachments S3 root uri including bucket
                                  name and root prefix.
  --path-mapping-rules TEXT       Path to a file with the path mapping rules
                                  to use.
  --farm-id TEXT                  The AWS Deadline Cloud Farm to use.
  --queue-id TEXT                 The AWS Deadline Cloud Queue to use.
  --profile TEXT                  The AWS profile to use for interacting with
                                  Job Attachments S3 bucket.
  --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 '(X)' to the
                                  end. X is incremented for each duplicate
                                  SKIP: Do not download the file OVERWRITE:
                                  Download and replace the existing file
  --json                          Output is printed as JSON for scripting.
  --help                          Show this message and exit.

upload

BETA - Upload Job Attachment data files for given job attachments manifest(s).

Usage:

deadline attachment upload [OPTIONS]

Options:

  -m, --manifests TEXT         File path(s) to manifest formatted file(s).
                               File name has to contain the hash of
                               corresponding source path.  [required]
  -r, --root-dirs TEXT         The root directory of assets to upload.
  --path-mapping-rules TEXT    Path to a file with the path mapping rules to
                               use.
  --s3-root-uri TEXT           Job Attachments S3 root uri including bucket
                               name and root prefix.
  --upload-manifest-path TEXT  File path for uploading the manifests to CAS.
  --farm-id TEXT               The AWS Deadline Cloud Farm to use.
  --queue-id TEXT              The AWS Deadline Cloud Queue to use.
  --profile TEXT               The AWS profile to use for interacting with Job
                               Attachments S3 bucket.
  --json                       Output is printed as JSON for scripting
  --help                       Show this message and exit.