Amazon Web Services, Inc.

AWSDeadlineCloud

The Amazon Web Services Deadline Cloud API provides infrastructure and centralized management for your projects. Use the Deadline Cloud API to onboard users,…

Developer tools#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

The Amazon Web Services Deadline Cloud API provides infrastructure and centralized management for your projects. Use the Deadline Cloud API to onboard users, assign projects, and attach permissions specific to their job function.

With Deadline Cloud, content production teams can deploy resources for their workforce securely in the cloud, reducing the costs of added physical infrastructure. Keep your content production operations secure, while allowing your contributors to access the tools they need, such as scalable high-speed storage, licenses, and cost management services.

Endpoints 127

Farm

  • PUTAssociate member to farm/2023-10-12/farms/:farmId/members/:principalIdAssigns a farm membership level to a member.
  • DELETEDisassociate member from farm/2023-10-12/farms/:farmId/members/:principalIdDisassociates a member from a farm.
  • GETList farms/2023-10-12/farms?nextToken=string&maxResults=0&principalId=stringLists farms.
  • POSTCreate farm/2023-10-12/farmsCreates a farm to allow space for queues and fleets. Farms are the space where the components of your renders gather and are pieced together in the cloud.…
  • GETList limits/2023-10-12/farms/:farmId/limits?nextToken=string&maxResults=0Gets a list of limits defined in the specified farm.
  • POSTCreate limit/2023-10-12/farms/:farmId/limitsCreates a limit that manages the distribution of shared resources, such as floating licenses. A limit can throttle work assignments, help manage workloads,…
  • GETList storage profiles/2023-10-12/farms/:farmId/storage-profiles?nextToken=string&maxResults=0Lists storage profiles.
  • POSTCreate storage profile/2023-10-12/farms/:farmId/storage-profilesCreates a storage profile that specifies the operating system, file type, and file location of resources used on a farm.
  • GETGet farm/2023-10-12/farms/:farmIdGet a farm.
  • DELETEDelete farm/2023-10-12/farms/:farmIdDeletes a farm.
  • PATCHUpdate farm/2023-10-12/farms/:farmIdUpdates a farm.
  • GETGet limit/2023-10-12/farms/:farmId/limits/:limitIdGets information about a specific limit.
  • DELETEDelete limit/2023-10-12/farms/:farmId/limits/:limitIdRemoves a limit from the specified farm. Before you delete a limit you must use the DeleteQueueLimitAssociation operation to remove the association with any…
  • PATCHUpdate limit/2023-10-12/farms/:farmId/limits/:limitIdUpdates the properties of the specified limit.
  • GETGet storage profile/2023-10-12/farms/:farmId/storage-profiles/:storageProfileIdGets a storage profile.
  • DELETEDelete storage profile/2023-10-12/farms/:farmId/storage-profiles/:storageProfileIdDeletes a storage profile.
  • PATCHUpdate storage profile/2023-10-12/farms/:farmId/storage-profiles/:storageProfileIdUpdates a storage profile.
  • GETList farm members/2023-10-12/farms/:farmId/members?nextToken=string&maxResults=0Lists the members of a farm.

Fleet

  • PUTAssociate member to fleet/2023-10-12/farms/:farmId/fleets/:fleetId/members/:principalIdAssigns a fleet membership level to a member.
  • DELETEDisassociate member from fleet/2023-10-12/farms/:farmId/fleets/:fleetId/members/:principalIdDisassociates a member from a fleet.
  • GETAssume fleet role for read/2023-10-12/farms/:farmId/fleets/:fleetId/read-rolesGet Amazon Web Services credentials from the fleet role. The IAM permissions of the credentials are scoped down to have read-only access.
  • GETList fleets/2023-10-12/farms/:farmId/fleets?nextToken=string&maxResults=0&principalId=string&displayName=string&status=stringLists fleets.
  • POSTCreate fleet/2023-10-12/farms/:farmId/fleetsCreates a fleet. Fleets gather information relating to compute, or capacity, for renders within your farms. You can choose to manage your own capacity or opt…
  • GETGet fleet/2023-10-12/farms/:farmId/fleets/:fleetIdGet a fleet.
  • DELETEDelete fleet/2023-10-12/farms/:farmId/fleets/:fleetIdDeletes a fleet.
  • PATCHUpdate fleet/2023-10-12/farms/:farmId/fleets/:fleetIdUpdates a fleet. Workers that are running when you call UpdateFleet keep the instance type and capabilities that they launched with until they scale in.…
  • GETList fleet members/2023-10-12/farms/:farmId/fleets/:fleetId/members?nextToken=string&maxResults=0Lists fleet members.

Job

  • PUTAssociate member to job/2023-10-12/farms/:farmId/queues/:queueId/jobs/:jobId/members/:principalIdAssigns a job membership level to a member
  • DELETEDisassociate member from job/2023-10-12/farms/:farmId/queues/:queueId/jobs/:jobId/members/:principalIdDisassociates a member from a job.
  • POSTCopy job template/2023-10-12/farms/:farmId/queues/:queueId/jobs/:jobId/templateCopies a job template to an Amazon S3 bucket.
  • GETList jobs/2023-10-12/farms/:farmId/queues/:queueId/jobs?nextToken=string&maxResults=0&principalId=stringLists jobs.
  • POSTCreate job/2023-10-12/farms/:farmId/queues/:queueId/jobsCreates a job. A job is a set of instructions that Deadline Cloud uses to schedule and run work on available workers. For more information, see Deadline Cloud…
  • GETGet job/2023-10-12/farms/:farmId/queues/:queueId/jobs/:jobIdGets a Deadline Cloud job.
  • PATCHUpdate job/2023-10-12/farms/:farmId/queues/:queueId/jobs/:jobIdUpdates a job. When you change the status of the job to ARCHIVED , the job can't be scheduled or archived. An archived jobs and its steps and tasks are…
  • GETGet session/2023-10-12/farms/:farmId/queues/:queueId/jobs/:jobId/sessions/:sessionIdGets a session.
  • PATCHUpdate session/2023-10-12/farms/:farmId/queues/:queueId/jobs/:jobId/sessions/:sessionIdUpdates a session.
  • GETGet session action/2023-10-12/farms/:farmId/queues/:queueId/jobs/:jobId/session-actions/:sessionActionIdGets a session action for the job.
  • GETGet step/2023-10-12/farms/:farmId/queues/:queueId/jobs/:jobId/steps/:stepIdGets a step.
  • PATCHUpdate step/2023-10-12/farms/:farmId/queues/:queueId/jobs/:jobId/steps/:stepIdUpdates a step.
  • GETGet task/2023-10-12/farms/:farmId/queues/:queueId/jobs/:jobId/steps/:stepId/tasks/:taskIdGets a task.
  • PATCHUpdate task/2023-10-12/farms/:farmId/queues/:queueId/jobs/:jobId/steps/:stepId/tasks/:taskIdUpdates a task.
  • GETList job members/2023-10-12/farms/:farmId/queues/:queueId/jobs/:jobId/members?nextToken=string&maxResults=0Lists members on a job.
  • GETList job parameter definitions/2023-10-12/farms/:farmId/queues/:queueId/jobs/:jobId/parameter-definitions?nextToken=string&maxResults=0Lists parameter definitions of a job.
  • GETList session actions/2023-10-12/farms/:farmId/queues/:queueId/jobs/:jobId/session-actions?nextToken=string&maxResults=0&sessionId=string&taskId=stringLists session actions.
  • GETList sessions/2023-10-12/farms/:farmId/queues/:queueId/jobs/:jobId/sessions?nextToken=string&maxResults=0Lists sessions.
  • GETList step consumers/2023-10-12/farms/:farmId/queues/:queueId/jobs/:jobId/steps/:stepId/consumers?nextToken=string&maxResults=0Lists step consumers.
  • GETList step dependencies/2023-10-12/farms/:farmId/queues/:queueId/jobs/:jobId/steps/:stepId/dependencies?nextToken=string&maxResults=0Lists the dependencies for a step.
  • GETList steps/2023-10-12/farms/:farmId/queues/:queueId/jobs/:jobId/steps?nextToken=string&maxResults=0Lists steps for a job.
  • GETList tasks/2023-10-12/farms/:farmId/queues/:queueId/jobs/:jobId/steps/:stepId/tasks?nextToken=string&maxResults=0Lists tasks for a job.

Queue

  • PUTAssociate member to queue/2023-10-12/farms/:farmId/queues/:queueId/members/:principalIdAssigns a queue membership level to a member
  • DELETEDisassociate member from queue/2023-10-12/farms/:farmId/queues/:queueId/members/:principalIdDisassociates a member from a queue.
  • GETAssume queue role for read/2023-10-12/farms/:farmId/queues/:queueId/read-rolesGets Amazon Web Services credentials from the queue role. The IAM permissions of the credentials are scoped down to have read-only access.
  • GETAssume queue role for user/2023-10-12/farms/:farmId/queues/:queueId/user-rolesAllows a user to assume a role for a queue.
  • GETList queues/2023-10-12/farms/:farmId/queues?nextToken=string&maxResults=0&principalId=string&status=stringLists queues.
  • POSTCreate queue/2023-10-12/farms/:farmId/queuesCreates a queue to coordinate the order in which jobs run on a farm. A queue can also specify where to pull resources and indicate where to output completed…
  • GETList queue environments/2023-10-12/farms/:farmId/queues/:queueId/environments?nextToken=string&maxResults=0Lists queue environments.
  • POSTCreate queue environment/2023-10-12/farms/:farmId/queues/:queueId/environmentsCreates an environment for a queue that defines how jobs in the queue run.
  • GETGet queue/2023-10-12/farms/:farmId/queues/:queueIdGets a queue.
  • DELETEDelete queue/2023-10-12/farms/:farmId/queues/:queueIdDeletes a queue. You can't recover the jobs in a queue if you delete the queue. Deleting the queue also deletes the jobs in that queue.
  • PATCHUpdate queue/2023-10-12/farms/:farmId/queues/:queueIdUpdates a queue.
  • GETGet queue environment/2023-10-12/farms/:farmId/queues/:queueId/environments/:queueEnvironmentIdGets a queue environment.
  • DELETEDelete queue environment/2023-10-12/farms/:farmId/queues/:queueId/environments/:queueEnvironmentIdDeletes a queue environment.
  • PATCHUpdate queue environment/2023-10-12/farms/:farmId/queues/:queueId/environments/:queueEnvironmentIdUpdates the queue environment.
  • GETGet storage profile for queue/2023-10-12/farms/:farmId/queues/:queueId/storage-profiles/:storageProfileIdGets a storage profile for a queue.
  • GETList queue members/2023-10-12/farms/:farmId/queues/:queueId/members?nextToken=string&maxResults=0Lists the members in a queue.
  • GETList storage profiles for queue/2023-10-12/farms/:farmId/queues/:queueId/storage-profiles?nextToken=string&maxResults=0Lists storage profiles for a queue.

Worker

  • GETAssume fleet role for worker/2023-10-12/farms/:farmId/fleets/:fleetId/workers/:workerId/fleet-rolesGet credentials from the fleet role for a worker.
  • GETAssume queue role for worker/2023-10-12/farms/:farmId/fleets/:fleetId/workers/:workerId/queue-roles?queueId=stringAllows a worker to assume a queue role.
  • POSTBatch get job entity/2023-10-12/farms/:farmId/fleets/:fleetId/workers/:workerId/batchGetJobEntityGet batched job details for a worker.
  • GETList workers/2023-10-12/farms/:farmId/fleets/:fleetId/workers?nextToken=string&maxResults=0Lists workers.
  • POSTCreate worker/2023-10-12/farms/:farmId/fleets/:fleetId/workersCreates a worker. A worker tells your instance how much processing power (vCPU), and memory (GiB) you'll need to assemble the digital assets held within a…
  • GETGet worker/2023-10-12/farms/:farmId/fleets/:fleetId/workers/:workerIdGets a worker.
  • DELETEDelete worker/2023-10-12/farms/:farmId/fleets/:fleetId/workers/:workerIdDeletes a worker.
  • PATCHUpdate worker/2023-10-12/farms/:farmId/fleets/:fleetId/workers/:workerIdUpdates a worker.
  • GETList sessions for worker/2023-10-12/farms/:farmId/fleets/:fleetId/workers/:workerId/sessions?nextToken=string&maxResults=0Lists sessions for a worker.
  • PATCHUpdate worker schedule/2023-10-12/farms/:farmId/fleets/:fleetId/workers/:workerId/scheduleUpdates the schedule for a worker.

Budget

  • GETList budgets/2023-10-12/farms/:farmId/budgets?nextToken=string&maxResults=0&status=stringA list of budgets in a farm.
  • POSTCreate budget/2023-10-12/farms/:farmId/budgetsCreates a budget to set spending thresholds for your rendering activity.
  • GETGet budget/2023-10-12/farms/:farmId/budgets/:budgetIdGet a budget.
  • DELETEDelete budget/2023-10-12/farms/:farmId/budgets/:budgetIdDeletes a budget.
  • PATCHUpdate budget/2023-10-12/farms/:farmId/budgets/:budgetIdUpdates a budget that sets spending thresholds for rendering activity.

License endpoint

  • GETList license endpoints/2023-10-12/license-endpoints?nextToken=string&maxResults=0Lists license endpoints.
  • POSTCreate license endpoint/2023-10-12/license-endpointsCreates a license endpoint to integrate your various licensed software used for rendering on Deadline Cloud.
  • GETGet license endpoint/2023-10-12/license-endpoints/:licenseEndpointIdGets a licence endpoint.
  • DELETEDelete license endpoint/2023-10-12/license-endpoints/:licenseEndpointIdDeletes a license endpoint.
  • PUTPut metered product/2023-10-12/license-endpoints/:licenseEndpointId/metered-products/:productIdAdds a metered product.
  • DELETEDelete metered product/2023-10-12/license-endpoints/:licenseEndpointId/metered-products/:productIdDeletes a metered product.
  • GETList metered products/2023-10-12/license-endpoints/:licenseEndpointId/metered-products?nextToken=string&maxResults=0Lists metered products.

Monitor

  • GETList monitors/2023-10-12/monitors?nextToken=string&maxResults=0Gets a list of your monitors in Deadline Cloud.
  • POSTCreate monitor/2023-10-12/monitorsCreates an Amazon Web Services Deadline Cloud monitor that you can use to view your farms, queues, and fleets. After you submit a job, you can track the…
  • GETGet monitor/2023-10-12/monitors/:monitorIdGets information about the specified monitor.
  • DELETEDelete monitor/2023-10-12/monitors/:monitorIdRemoves a Deadline Cloud monitor. After you delete a monitor, you can create a new one and attach farms to the monitor.
  • PATCHUpdate monitor/2023-10-12/monitors/:monitorIdModifies the settings for a Deadline Cloud monitor. You can modify one or all of the settings when you call UpdateMonitor .
  • GETGet monitor settings/2023-10-12/monitors/:monitorId/settingsGets the settings for a Deadline Cloud monitor.
  • PATCHUpdate monitor settings/2023-10-12/monitors/:monitorId/settingsUpdates the settings for a Deadline Cloud monitor. Keys present in the request are upserted; keys absent are left unchanged. Send an empty string value to…

Volume

  • GETGet volume/2023-10-12/farms/:farmId/fleets/:fleetId/volumes/:volumeIdGets a persistent volume.
  • DELETEDelete volume/2023-10-12/farms/:farmId/fleets/:fleetId/volumes/:volumeIdDeletes a persistent volume.
  • GETList volumes/2023-10-12/farms/:farmId/fleets/:fleetId/volumes?nextToken=string&maxResults=0Lists the persistent volumes in a fleet.
  • POSTBatch get job/2023-10-12/batch-get-jobRetrieves multiple jobs in a single request. This is a batch version of the GetJob API. The result of getting each job is reported individually in the…
  • POSTBatch get session/2023-10-12/batch-get-sessionRetrieves multiple sessions in a single request. This is a batch version of the GetSession API. The result of getting each session is reported individually in…
  • POSTBatch get session action/2023-10-12/batch-get-session-actionRetrieves multiple session actions in a single request. This is a batch version of the GetSessionAction API. The result of getting each session action is…
  • POSTBatch get step/2023-10-12/batch-get-stepRetrieves multiple steps in a single request. This is a batch version of the GetStep API. The result of getting each step is reported individually in the…
  • POSTBatch get task/2023-10-12/batch-get-taskRetrieves multiple tasks in a single request. This is a batch version of the GetTask API. The result of getting each task is reported individually in the…
  • POSTBatch get worker/2023-10-12/batch-get-workerRetrieves multiple workers in a single request. This is a batch version of the GetWorker API. The result of getting each worker is reported individually in…
  • PATCHBatch update job/2023-10-12/batch-update-jobUpdates multiple jobs in a single request. This is a batch version of the UpdateJob API. The result of updating each job is reported individually in the…
  • PATCHBatch update task/2023-10-12/batch-update-taskUpdates multiple tasks in a single request. This is a batch version of the UpdateTask API. The result of updating each task is reported individually in the…
  • GETList queue fleet associations/2023-10-12/farms/:farmId/queue-fleet-associations?nextToken=string&maxResults=0&queueId=string&fleetId=stringLists queue-fleet associations.
  • PUTCreate queue fleet association/2023-10-12/farms/:farmId/queue-fleet-associationsCreates an association between a queue and a fleet.
  • GETList queue limit associations/2023-10-12/farms/:farmId/queue-limit-associations?nextToken=string&maxResults=0&queueId=string&limitId=stringGets a list of the associations between queues and limits defined in a farm.
  • PUTCreate queue limit association/2023-10-12/farms/:farmId/queue-limit-associationsAssociates a limit with a particular queue. After the limit is associated, all workers for jobs that specify the limit associated with the queue are subject…
  • GETGet queue fleet association/2023-10-12/farms/:farmId/queue-fleet-associations/:queueId/:fleetIdGets a queue-fleet association.
  • DELETEDelete queue fleet association/2023-10-12/farms/:farmId/queue-fleet-associations/:queueId/:fleetIdDeletes a queue-fleet association.
  • PATCHUpdate queue fleet association/2023-10-12/farms/:farmId/queue-fleet-associations/:queueId/:fleetIdUpdates a queue-fleet association.
  • GETGet queue limit association/2023-10-12/farms/:farmId/queue-limit-associations/:queueId/:limitIdGets information about a specific association between a queue and a limit.
  • DELETEDelete queue limit association/2023-10-12/farms/:farmId/queue-limit-associations/:queueId/:limitIdRemoves the association between a queue and a limit. You must use the UpdateQueueLimitAssociation operation to set the status to…
  • PATCHUpdate queue limit association/2023-10-12/farms/:farmId/queue-limit-associations/:queueId/:limitIdUpdates the status of the queue. If you set the status to one of the STOP_LIMIT_USAGE* values, there will be a delay before the status transitions to the…
  • GETGet sessions statistics aggregation/2023-10-12/farms/:farmId/sessions-statistics-aggregation?nextToken=string&maxResults=0&aggregationId=stringGets a set of statistics for queues or farms. Before you can call the GetSessionStatisticsAggregation operation, you must first call the…
  • POSTStart sessions statistics aggregation/2023-10-12/farms/:farmId/sessions-statistics-aggregationStarts an asynchronous request for getting aggregated statistics about queues and farms. Get the statistics using the GetSessionsStatisticsAggregation…
  • GETList available metered products/2023-10-12/metered-products?nextToken=string&maxResults=0A list of the available metered products.
  • GETList memberships/2023-10-12/memberships?nextToken=string&maxResults=0&principalId=string&identityStoreId=string&identityCenterRegion=string&resourceTypes=Lists the Deadline Cloud resource memberships associated with a specified IAM Identity Center principal, optionally filtered by the requested resource types.
  • GETList tags for resource/2023-10-12/tags/:resourceArnLists tags for a resource.
  • POSTTag resource/2023-10-12/tags/:resourceArnTags a resource using the resource's ARN and desired tags.
  • DELETEUntag resource/2023-10-12/tags/:resourceArn?tagKeys=Removes a tag from a resource using the resource's ARN and tag to remove.
  • POSTSearch jobs/2023-10-12/farms/:farmId/search/jobsSearches for jobs.
  • POSTSearch steps/2023-10-12/farms/:farmId/search/stepsSearches for steps.
  • POSTSearch tasks/2023-10-12/farms/:farmId/search/tasksSearches for tasks.
  • POSTSearch workers/2023-10-12/farms/:farmId/search/workersSearches for workers.

API details

Base URL
https://deadline.{region}.amazonaws.com
Authentication
AWS Signature Version 4 (requests signed with your AWS access key)
Operations
127 operations on 77 pathsGET 57POST 25PATCH 19DELETE 19PUT 7
Main resources
Job 22Farm 18Queue 17Worker 10Fleet 9License endpoint 7Monitor 7Budget 5Volume 3
Description format
AWS Smithy model, API version 2023-10-12

How to test the AWSDeadlineCloud in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the AWSDeadlineCloud collection, without the publisher's secrets.
  3. Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Associate member to farm” (PUT /2023-10-12/farms/:farmId/members/:principalId), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the AWSDeadlineCloud?

The Amazon Web Services Deadline Cloud API provides infrastructure and centralized management for your projects. Use the Deadline Cloud API to onboard users,… It is listed under Developer tools and has 127 endpoints.

Who publishes the AWSDeadlineCloud?

It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.

What is the base URL of the AWSDeadlineCloud?

Requests go to https://deadline.{region}.amazonaws.com. Endpoint paths are added to this base URL.

How do I authenticate with the AWSDeadlineCloud?

With AWS Signature Version 4 (requests signed with your AWS access key).

How many endpoints does the AWSDeadlineCloud have?

127 operations on 77 paths (57 GET, 25 POST, 19 PATCH, 19 DELETE, 7 PUT). The largest groups are Job, Farm, Queue, Worker.

Is forking the AWSDeadlineCloud free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.