id: https://api-evangelist.github.io/amazon-deadline-cloud/vocabulary/amazon-deadline-cloud-vocabulary.yaml name: Amazon Deadline Cloud Vocabulary description: Controlled vocabulary for Amazon Deadline Cloud API covering render farm resources, job lifecycle states, worker statuses, compute configurations, and production personas. version: 1.0.0-alpha1 specificationVersion: 1.0.0-alpha1 operational: resources: - term: Farm definition: A logical grouping of queues, fleets, and workers that represents a render farm environment. Each farm is scoped to an AWS account and region. - term: Queue definition: A container for rendering job submissions within a farm. Queues hold jobs awaiting processing and associate with fleets that provide compute capacity. - term: Fleet definition: A group of compute workers configured with specific instance types and scaling settings. Fleets provide the execution capacity for rendering jobs. - term: Job definition: A rendering or simulation workload submitted to a queue. Jobs contain task definitions, parameters, attachments, and lifecycle configurations. - term: Worker definition: A compute instance within a fleet that executes job tasks. Workers are managed by Deadline Cloud and report status back to the service. - term: Task definition: An individual unit of work within a job. A job may contain thousands of tasks representing frames, chunks, or simulation steps. - term: Session definition: A worker's active execution context for processing tasks from a job. Sessions track the association between a worker and the tasks it is running. - term: Step definition: A logical grouping of tasks within a job that share the same script or tool configuration. Steps may have dependencies on other steps. actions: - term: CreateFarm definition: Provision a new render farm environment within an AWS account. - term: UpdateFarm definition: Modify the display name or KMS key configuration of an existing farm. - term: DeleteFarm definition: Remove a farm and all its associated resources permanently. - term: CreateQueue definition: Add a new job queue to a farm for receiving rendering submissions. - term: CreateFleet definition: Provision a compute fleet with specified instance types and scaling parameters. - term: SubmitJob definition: Submit a rendering job to a queue for execution by available fleet workers. - term: UpdateJob definition: Modify a job's priority, lifecycle status, or target task run status. - term: ListWorkers definition: Retrieve the list of workers in a fleet along with their current status. jobLifecycleStatuses: - term: CREATE_IN_PROGRESS definition: The job is being created and is not yet ready for task execution. - term: CREATE_COMPLETE definition: The job has been successfully created and tasks are ready to run. - term: UPDATE_IN_PROGRESS definition: The job is being updated (e.g., priority change) and may be temporarily paused. - term: UPDATE_SUCCEEDED definition: The job update completed successfully. - term: ARCHIVED definition: The job has been archived and its tasks are no longer eligible for execution. taskRunStatuses: - term: QUEUED definition: The task is waiting for an available worker to pick it up. - term: RUNNING definition: A worker is actively executing the task. - term: SUCCEEDED definition: The task completed successfully and produced its expected output. - term: FAILED definition: The task encountered an error and did not complete successfully. - term: CANCELED definition: The task was explicitly canceled before or during execution. - term: SUSPENDED definition: The task has been temporarily paused and will not be picked up by workers. - term: PENDING definition: The task is waiting for step dependencies to complete before becoming eligible. workerStatuses: - term: CREATED definition: The worker has been registered but has not yet started processing tasks. - term: STARTED definition: The worker is active and polling for tasks to execute. - term: STOPPING definition: The worker is finishing its current task and preparing to shut down. - term: STOPPED definition: The worker has completed shutdown and is no longer processing tasks. - term: NOT_RESPONDING definition: The worker has failed to send heartbeat signals within the expected interval. - term: NOT_COMPATIBLE definition: The worker's environment does not meet the requirements of available tasks. computeConfigurations: - term: CustomerManaged definition: Fleet configuration where the customer provides and manages the underlying EC2 instances using an Auto Scaling Group. - term: ServiceManaged definition: Fleet configuration where Deadline Cloud manages instance provisioning, scaling, and termination automatically. - term: SpotCapacityOptimized definition: A fleet allocation strategy that selects Spot Instance pools with the most available capacity to minimize interruptions. - term: OnDemand definition: Fleet instances that are provisioned on-demand with guaranteed availability at a higher cost than Spot Instances. capability: personas: - term: Render Wrangler definition: A technical artist responsible for submitting rendering jobs, setting priorities, monitoring progress, and troubleshooting failed tasks on the render farm. - term: Infrastructure Engineer definition: An engineer who provisions and maintains render farm infrastructure including farms, queues, and compute fleets with appropriate scaling policies. - term: Production Coordinator definition: A coordinator who tracks rendering progress across productions, manages job priorities to meet delivery deadlines, and reports status to stakeholders. workflows: - term: Set Up Render Farm definition: The end-to-end workflow for provisioning a render farm including creating a farm, configuring queues, and launching compute fleets. - term: Monitor Active Renders definition: The workflow for tracking active rendering jobs including listing jobs, inspecting job details, and checking worker utilization. - term: Manage Job Priorities definition: The workflow for adjusting job priorities to optimize farm throughput and ensure time-critical productions render before lower-priority work. - term: Scale Fleet Capacity definition: The workflow for adjusting fleet worker counts and instance configurations in response to changing render demand. crossReference: awsServices: - term: Amazon EC2 definition: The compute service providing the underlying virtual machines for Deadline Cloud worker fleets, supporting both On-Demand and Spot Instance purchasing options. url: https://aws.amazon.com/ec2/ - term: Amazon S3 definition: Object storage used for job input assets, output renders, and job attachment settings including the S3 bucket for render outputs. url: https://aws.amazon.com/s3/ - term: Amazon FSx for Lustre definition: High-performance parallel file system used as shared storage for large render asset libraries accessible by all workers in a fleet. url: https://aws.amazon.com/fsx/lustre/ - term: Amazon CloudWatch definition: Monitoring and observability service used to track Deadline Cloud metrics including job throughput, worker utilization, and fleet capacity. url: https://aws.amazon.com/cloudwatch/ - term: AWS KMS definition: Key Management Service used to encrypt farm-level data including job definitions and render outputs using customer-managed keys. url: https://aws.amazon.com/kms/ - term: AWS IAM definition: Identity and Access Management service used to control access to Deadline Cloud resources through IAM roles and policies. url: https://aws.amazon.com/iam/ relatedProducts: - term: AWS Thinkbox Deadline definition: The predecessor on-premises render management software that Amazon Deadline Cloud evolved from, sharing job and worker concepts with the cloud service. url: https://www.awsthinkbox.com/deadline - term: AWS Thinkbox Krakatoa definition: A volumetric particle rendering plugin compatible with Deadline-managed render farms for simulation and effects rendering. url: https://www.awsthinkbox.com/krakatoa standards: - term: OpenAPI 3.1.0 definition: The API specification format used to describe Deadline Cloud REST API operations, request/response schemas, and authentication requirements. url: https://spec.openapis.org/oas/v3.1.0 - term: AWS Signature Version 4 definition: The authentication protocol required for all Amazon Deadline Cloud API requests, using HMAC-SHA256 signing with AWS credentials. url: https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html - term: JSON Schema definition: The schema language used to describe Deadline Cloud resource structures including Farm, Queue, Fleet, Job, and Worker objects. url: https://json-schema.org/