View Source AWS.Deadline (aws-elixir v1.0.6)
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.
Link to this section Summary
Functions
Assigns a farm membership level to a member.
Assigns a fleet membership level to a member.
Assigns a job membership level to a member
Assigns a queue membership level to a member
Get Amazon Web Services credentials from the fleet role.
Get credentials from the fleet role for a worker.
Gets Amazon Web Services credentials from the queue role.
Allows a user to assume a role for a queue.
Allows a worker to assume a queue role.
Get batched job details for a worker.
Copies a job template to an Amazon S3 bucket.
Creates a budget to set spending thresholds for your rendering activity.
Creates a farm to allow space for queues and fleets.
Creates a fleet.
Creates a job.
Creates a license endpoint to integrate your various licensed software used for rendering on Deadline Cloud.
Creates a limit that manages the distribution of shared resources, such as floating licenses.
Creates an Amazon Web Services Deadline Cloud monitor that you can use to view your farms, queues, and fleets.
Creates a queue to coordinate the order in which jobs run on a farm.
Creates an environment for a queue that defines how jobs in the queue run.
Creates an association between a queue and a fleet.
Associates a limit with a particular queue.
Creates a storage profile that specifies the operating system, file type, and file location of resources used on a farm.
Creates a worker.
Deletes a budget.
Deletes a farm.
Deletes a fleet.
Deletes a license endpoint.
Removes a limit from the specified farm.
Deletes a metered product.
Removes a Deadline Cloud monitor.
Deletes a queue.
Deletes a queue environment.
Deletes a queue-fleet association.
Removes the association between a queue and a limit.
Deletes a storage profile.
Disassociates a member from a farm.
Disassociates a member from a fleet.
Disassociates a member from a job.
Disassociates a member from a queue.
Get a budget.
Get a farm.
Get a fleet.
Gets a Deadline Cloud job.
Gets a licence endpoint.
Gets information about a specific limit.
Gets information about the specified monitor.
Gets a queue.
Gets a queue environment.
Gets a queue-fleet association.
Gets information about a specific association between a queue and a limit.
Gets a session action for the job.
Gets a set of statistics for queues or farms.
Gets a storage profile.
Gets a storage profile for a queue.
A list of the available metered products.
A list of budgets in a farm.
Lists the members of a farm.
Lists farms.
Lists fleet members.
Lists members on a job.
Lists parameter definitions of a job.
Lists license endpoints.
Gets a list of limits defined in the specified farm.
Lists metered products.
Gets a list of your monitors in Deadline Cloud.
Lists queue environments.
Lists queue-fleet associations.
Gets a list of the associations between queues and limits defined in a farm.
Lists the members in a queue.
Lists queues.
Lists session actions.
Lists sessions.
Lists sessions for a worker.
Lists step consumers.
Lists the dependencies for a step.
Lists steps for a job.
Lists storage profiles.
Lists storage profiles for a queue.
Lists tags for a resource.
Lists tasks for a job.
Lists workers.
Adds a metered product.
Searches for jobs.
Searches for steps.
Searches for tasks.
Searches for workers.
Starts an asynchronous request for getting aggregated statistics about queues and farms.
Tags a resource using the resource's ARN and desired tags.
Removes a tag from a resource using the resource's ARN and tag to remove.
Updates a budget that sets spending thresholds for rendering activity.
Updates a farm.
Updates a fleet.
Updates the properties of the specified limit.
Modifies the settings for a Deadline Cloud monitor.
Updates a queue.
Updates the queue environment.
Updates a queue-fleet association.
Updates the status of the queue.
Updates a session.
Updates a storage profile.
Updates a task.
Updates the schedule for a worker.
Link to this section Functions
associate_member_to_farm(client, farm_id, principal_id, input, options \\ [])
View SourceAssigns a farm membership level to a member.
associate_member_to_fleet(client, farm_id, fleet_id, principal_id, input, options \\ [])
View SourceAssigns a fleet membership level to a member.
associate_member_to_job(client, farm_id, job_id, principal_id, queue_id, input, options \\ [])
View SourceAssigns a job membership level to a member
associate_member_to_queue(client, farm_id, principal_id, queue_id, input, options \\ [])
View SourceAssigns a queue membership level to a member
assume_fleet_role_for_read(client, farm_id, fleet_id, options \\ [])
View SourceGet Amazon Web Services credentials from the fleet role.
The IAM permissions of the credentials are scoped down to have read-only access.
assume_fleet_role_for_worker(client, farm_id, fleet_id, worker_id, options \\ [])
View SourceGet credentials from the fleet role for a worker.
assume_queue_role_for_read(client, farm_id, queue_id, options \\ [])
View SourceGets Amazon Web Services credentials from the queue role.
The IAM permissions of the credentials are scoped down to have read-only access.
assume_queue_role_for_user(client, farm_id, queue_id, options \\ [])
View SourceAllows a user to assume a role for a queue.
assume_queue_role_for_worker(client, farm_id, fleet_id, worker_id, queue_id, options \\ [])
View SourceAllows a worker to assume a queue role.
batch_get_job_entity(client, farm_id, fleet_id, worker_id, input, options \\ [])
View SourceGet batched job details for a worker.
copy_job_template(client, farm_id, job_id, queue_id, input, options \\ [])
View SourceCopies a job template to an Amazon S3 bucket.
Creates a budget to set spending thresholds for your rendering activity.
Creates 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. Farms contain budgets and allow you to enforce permissions. Deadline Cloud farms are a useful container for large projects.
Creates 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 to have fleets fully managed by Deadline Cloud.
Creates 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 jobs.
Creates a license endpoint to integrate your various licensed software used for rendering on Deadline Cloud.
Creates a limit that manages the distribution of shared resources, such as floating licenses.
A limit can throttle work assignments, help manage workloads, and track current usage. Before you use a limit, you must associate the limit with one or more queues.
You must add the amountRequirementName
to a step in a job template to
declare the limit requirement.
Creates 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 progress of the tasks and steps that make up the job, and then download the job's results.
Creates 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 jobs.
create_queue_environment(client, farm_id, queue_id, input, options \\ [])
View SourceCreates an environment for a queue that defines how jobs in the queue run.
create_queue_fleet_association(client, farm_id, input, options \\ [])
View SourceCreates an association between a queue and a fleet.
create_queue_limit_association(client, farm_id, input, options \\ [])
View SourceAssociates 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 to the
limit. You
can't associate two limits with the same amountRequirementName
to the same
queue.
Creates a storage profile that specifies the operating system, file type, and file location of resources used on a farm.
Creates 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 particular instance. You can specify certain instance types to use, or let the worker know which instances types to exclude.
Deletes a budget.
Deletes a farm.
Deletes a fleet.
delete_license_endpoint(client, license_endpoint_id, input, options \\ [])
View SourceDeletes a license endpoint.
Removes a limit from the specified farm.
Before you delete a limit you must use the
DeleteQueueLimitAssociation
operation to remove the association with any
queues.
delete_metered_product(client, license_endpoint_id, product_id, input, options \\ [])
View SourceDeletes a metered product.
Removes a Deadline Cloud monitor.
After you delete a monitor, you can create a new one and attach farms to the monitor.
Deletes 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.
delete_queue_environment(client, farm_id, queue_environment_id, queue_id, input, options \\ [])
View SourceDeletes a queue environment.
delete_queue_fleet_association(client, farm_id, fleet_id, queue_id, input, options \\ [])
View SourceDeletes a queue-fleet association.
delete_queue_limit_association(client, farm_id, limit_id, queue_id, input, options \\ [])
View SourceRemoves the association between a queue and a limit.
You must use the
UpdateQueueLimitAssociation
operation to set the status to
STOP_LIMIT_USAGE_AND_COMPLETE_TASKS
or
STOP_LIMIT_USAGE_AND_CANCEL_TASKS
. The status does not change immediately.
Use the GetQueueLimitAssociation
operation to see if the status changed to
STOPPED
before deleting the association.
delete_storage_profile(client, farm_id, storage_profile_id, input, options \\ [])
View SourceDeletes a storage profile.
delete_worker(client, farm_id, fleet_id, worker_id, input, options \\ [])
View SourceDeletes a worker.
disassociate_member_from_farm(client, farm_id, principal_id, input, options \\ [])
View SourceDisassociates a member from a farm.
disassociate_member_from_fleet(client, farm_id, fleet_id, principal_id, input, options \\ [])
View SourceDisassociates a member from a fleet.
disassociate_member_from_job(client, farm_id, job_id, principal_id, queue_id, input, options \\ [])
View SourceDisassociates a member from a job.
disassociate_member_from_queue(client, farm_id, principal_id, queue_id, input, options \\ [])
View SourceDisassociates a member from a queue.
Get a budget.
Get a farm.
Get a fleet.
Gets a Deadline Cloud job.
Gets a licence endpoint.
Gets information about a specific limit.
Gets information about the specified monitor.
Gets a queue.
get_queue_environment(client, farm_id, queue_environment_id, queue_id, options \\ [])
View SourceGets a queue environment.
get_queue_fleet_association(client, farm_id, fleet_id, queue_id, options \\ [])
View SourceGets a queue-fleet association.
get_queue_limit_association(client, farm_id, limit_id, queue_id, options \\ [])
View SourceGets information about a specific association between a queue and a limit.
get_session(client, farm_id, job_id, queue_id, session_id, options \\ [])
View SourceGets a session.
get_session_action(client, farm_id, job_id, queue_id, session_action_id, options \\ [])
View SourceGets a session action for the job.
get_sessions_statistics_aggregation(client, farm_id, aggregation_id, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceGets a set of statistics for queues or farms.
Before you can call the
GetSessionStatisticsAggregation
operation, you must first call the
StartSessionsStatisticsAggregation
operation. Statistics are available for
1 hour after you call the StartSessionsStatisticsAggregation
operation.
get_step(client, farm_id, job_id, queue_id, step_id, options \\ [])
View SourceGets a step.
get_storage_profile(client, farm_id, storage_profile_id, options \\ [])
View SourceGets a storage profile.
get_storage_profile_for_queue(client, farm_id, queue_id, storage_profile_id, options \\ [])
View SourceGets a storage profile for a queue.
get_task(client, farm_id, job_id, queue_id, step_id, task_id, options \\ [])
View SourceGets a task.
Gets a worker.
list_available_metered_products(client, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceA list of the available metered products.
list_budgets(client, farm_id, max_results \\ nil, next_token \\ nil, status \\ nil, options \\ [])
View SourceA list of budgets in a farm.
list_farm_members(client, farm_id, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceLists the members of a farm.
list_farms(client, max_results \\ nil, next_token \\ nil, principal_id \\ nil, options \\ [])
View SourceLists farms.
list_fleet_members(client, farm_id, fleet_id, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceLists fleet members.
list_fleets(client, farm_id, display_name \\ nil, max_results \\ nil, next_token \\ nil, principal_id \\ nil, status \\ nil, options \\ [])
View SourceLists fleets.
list_job_members(client, farm_id, job_id, queue_id, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceLists members on a job.
list_job_parameter_definitions(client, farm_id, job_id, queue_id, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceLists parameter definitions of a job.
list_jobs(client, farm_id, queue_id, max_results \\ nil, next_token \\ nil, principal_id \\ nil, options \\ [])
View SourceLists jobs.
list_license_endpoints(client, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceLists license endpoints.
list_limits(client, farm_id, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceGets a list of limits defined in the specified farm.
list_metered_products(client, license_endpoint_id, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceLists metered products.
list_monitors(client, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceGets a list of your monitors in Deadline Cloud.
list_queue_environments(client, farm_id, queue_id, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceLists queue environments.
list_queue_fleet_associations(client, farm_id, fleet_id \\ nil, max_results \\ nil, next_token \\ nil, queue_id \\ nil, options \\ [])
View SourceLists queue-fleet associations.
list_queue_limit_associations(client, farm_id, limit_id \\ nil, max_results \\ nil, next_token \\ nil, queue_id \\ nil, options \\ [])
View SourceGets a list of the associations between queues and limits defined in a farm.
list_queue_members(client, farm_id, queue_id, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceLists the members in a queue.
list_queues(client, farm_id, max_results \\ nil, next_token \\ nil, principal_id \\ nil, status \\ nil, options \\ [])
View SourceLists queues.
list_session_actions(client, farm_id, job_id, queue_id, max_results \\ nil, next_token \\ nil, session_id \\ nil, task_id \\ nil, options \\ [])
View SourceLists session actions.
list_sessions(client, farm_id, job_id, queue_id, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceLists sessions.
list_sessions_for_worker(client, farm_id, fleet_id, worker_id, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceLists sessions for a worker.
list_step_consumers(client, farm_id, job_id, queue_id, step_id, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceLists step consumers.
list_step_dependencies(client, farm_id, job_id, queue_id, step_id, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceLists the dependencies for a step.
list_steps(client, farm_id, job_id, queue_id, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceLists steps for a job.
list_storage_profiles(client, farm_id, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceLists storage profiles.
list_storage_profiles_for_queue(client, farm_id, queue_id, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceLists storage profiles for a queue.
Lists tags for a resource.
list_tasks(client, farm_id, job_id, queue_id, step_id, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceLists tasks for a job.
list_workers(client, farm_id, fleet_id, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceLists workers.
put_metered_product(client, license_endpoint_id, product_id, input, options \\ [])
View SourceAdds a metered product.
Searches for jobs.
Searches for steps.
Searches for tasks.
Searches for workers.
start_sessions_statistics_aggregation(client, farm_id, input, options \\ [])
View SourceStarts an asynchronous request for getting aggregated statistics about queues and farms.
Get the statistics using the GetSessionsStatisticsAggregation
operation. You
can only have one running aggregation for your Deadline Cloud farm. Call the
GetSessionsStatisticsAggregation
operation and check the
status
field to see if an aggregation is running. Statistics are available
for 1 hour after you call the StartSessionsStatisticsAggregation
operation.
Tags a resource using the resource's ARN and desired tags.
Removes a tag from a resource using the resource's ARN and tag to remove.
Updates a budget that sets spending thresholds for rendering activity.
Updates a farm.
Updates a fleet.
update_job(client, farm_id, job_id, queue_id, input, options \\ [])
View SourceUpdates 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 deleted after 120 days. The job can't be recovered.
Updates the properties of the specified limit.
Modifies the settings for a Deadline Cloud monitor.
You can modify one or all of the settings
when you call UpdateMonitor
.
Updates a queue.
update_queue_environment(client, farm_id, queue_environment_id, queue_id, input, options \\ [])
View SourceUpdates the queue environment.
update_queue_fleet_association(client, farm_id, fleet_id, queue_id, input, options \\ [])
View SourceUpdates a queue-fleet association.
update_queue_limit_association(client, farm_id, limit_id, queue_id, input, options \\ [])
View SourceUpdates 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 STOPPED
state.
update_session(client, farm_id, job_id, queue_id, session_id, input, options \\ [])
View SourceUpdates a session.
update_step(client, farm_id, job_id, queue_id, step_id, input, options \\ [])
View SourceUpdates a step.
update_storage_profile(client, farm_id, storage_profile_id, input, options \\ [])
View SourceUpdates a storage profile.
update_task(client, farm_id, job_id, queue_id, step_id, task_id, input, options \\ [])
View SourceUpdates a task.
update_worker(client, farm_id, fleet_id, worker_id, input, options \\ [])
View SourceUpdates a worker.
update_worker_schedule(client, farm_id, fleet_id, worker_id, input, options \\ [])
View SourceUpdates the schedule for a worker.