{"id":23528,"library":"deadline","title":"AWS Deadline Cloud Python Library (deadline)","description":"Multi-purpose Python library and CLI tool for interacting with AWS Deadline Cloud. Provides job submission, asset management, job monitoring, and worker integration. Current version 0.56.1, actively maintained by AWS, releases bi-weekly to monthly.","status":"active","version":"0.56.1","language":"python","source_language":"en","source_url":"https://github.com/aws-deadline/deadline-cloud","tags":["aws","deadline-cloud","cli","job-scheduling","cloud-computing"],"install":[{"cmd":"pip install deadline","lang":"bash","label":"Install from PyPI"}],"dependencies":[{"reason":"AWS SDK for Python, required for all AWS API calls","package":"boto3","optional":false},{"reason":"Parsing YAML configuration files","package":"PyYAML","optional":false},{"reason":"Qt bindings for GUI submission (bundle gui-submit)","package":"PyQt5","optional":true}],"imports":[{"note":"No DeadlineClient class; use client.get_deadline_client() or client.get_queue_settings()","wrong":"from deadline.client import DeadlineClient","symbol":"deadline.client","correct":"from deadline import client"},{"note":"AssetSync is deprecated in 0.54.1 and removed in 0.55.0+; use job_attachments.api instead","wrong":"from deadline.job_attachments.asset_sync import AssetSync","symbol":"deadline.job_attachments","correct":"from deadline import job_attachments"}],"quickstart":{"code":"import os\nfrom deadline import client\n\n# Set AWS credentials (or use default session)\nos.environ['AWS_DEFAULT_REGION'] = 'us-west-2'\n\n# Get a Deadline client instance\n# Note: client.get_deadline_client() returns a low-level boto3 client\n# For high-level operations, use deadline.job_attachments or deadline.jobs\nfarm_id = 'farm-1234567890abcdef0'\nqueue_id = 'queue-1234567890abcdef0'\ndl_client = client.get_deadline_client()\n\n# List jobs\nresponse = dl_client.list_jobs(farmId=farm_id, queueId=queue_id)\nprint(response)\n","lang":"python","description":"Initialize the Deadline client and list jobs for a given farm and queue."},"warnings":[{"fix":"Replace any `from deadline.job_attachments.asset_sync` imports with `from deadline import job_attachments` and use the new API.","message":"In version 0.55.0, job_attachments was decoupled from deadline.client. Old imports like `from deadline.job_attachments.asset_sync import AssetSync` will fail. Use `from deadline import job_attachments` instead.","severity":"breaking","affected_versions":">=0.55.0"},{"fix":"Replace `--submitter-name` with `--submitter-info` in CLI commands.","message":"CLI option `bundle gui-submit --submitter-name` is deprecated in 0.54.0. Use `--submitter-info` instead.","severity":"deprecated","affected_versions":">=0.54.0"},{"fix":"Use other public APIs under job_attachments (e.g., job_attachments.api).","message":"`AssetSync.sync_inputs` and `AssetSync.attachment_sync_inputs` are deprecated since 0.54.1 and will be removed in a future version.","severity":"deprecated","affected_versions":">=0.54.1"},{"fix":"Use `--timestamp-format relative` or `--timestamp-format utc` instead of `--timezone`.","message":"`--timezone` deprecated in favor of `--timestamp-format` for the `job logs` CLI command since 0.53.3.","severity":"deprecated","affected_versions":">=0.53.3"},{"fix":"Import as `from deadline import client` and call `client.get_deadline_client()`.","message":"The `client` module does not export a class `DeadlineClient`. It is a module with functions.","severity":"gotcha","affected_versions":"all"}],"env_vars":null,"last_verified":"2026-05-01T00:00:00.000Z","next_check":"2026-07-30T00:00:00.000Z","problems":[{"fix":"Ensure you have a recent version: `pip install -U deadline`. The package name is `deadline`, not `deadline-cloud`.","cause":"Installed an old version (<0.50) where the package layout was different, or virtual environment misconfigured.","error":"ModuleNotFoundError: No module named 'deadline.client'"},{"fix":"Use `from deadline import client` instead.","cause":"Using `import deadline` and then `deadline.client` but the package uses lazy imports or requires explicit import.","error":"AttributeError: module 'deadline' has no attribute 'client'"},{"fix":"Update code to use `from deadline import job_attachments` and call `job_attachments.api.sync_inputs(...)` or similar new API.","cause":"AssetSync was removed in version 0.55.0 after deprecation in 0.54.1.","error":"ImportError: cannot import name 'AssetSync' from 'deadline.job_attachments'"},{"fix":"Set environment variables `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`, and `AWS_DEFAULT_REGION`, or configure a profile.","cause":"AWS credentials not configured or not passed to the Deadline client.","error":"botocore.exceptions.NoCredentialsError: Unable to locate credentials"}],"ecosystem":"pypi","meta_description":null,"install_score":null,"install_tag":null,"quickstart_score":null,"quickstart_tag":null}