aws-elixir

View Source AWS.Deadline (aws-elixir v1.0.4)

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

associate_member_to_farm(client, farm_id, principal_id, input, options \\ [])

Assigns a farm membership level to a member.

associate_member_to_fleet(client, farm_id, fleet_id, principal_id, input, options \\ [])

Assigns a fleet membership level to a member.

associate_member_to_job(client, farm_id, job_id, principal_id, queue_id, input, options \\ [])

Assigns a job membership level to a member

associate_member_to_queue(client, farm_id, principal_id, queue_id, input, options \\ [])

Assigns a queue membership level to a member

assume_fleet_role_for_read(client, farm_id, fleet_id, options \\ [])

Get Amazon Web Services credentials from the fleet role.

assume_fleet_role_for_worker(client, farm_id, fleet_id, worker_id, options \\ [])

Get credentials from the fleet role for a worker.

assume_queue_role_for_read(client, farm_id, queue_id, options \\ [])

Gets Amazon Web Services credentials from the queue role.

assume_queue_role_for_user(client, farm_id, queue_id, options \\ [])

Allows a user to assume a role for a queue.

assume_queue_role_for_worker(client, farm_id, fleet_id, worker_id, queue_id, options \\ [])

Allows a worker to assume a queue role.

batch_get_job_entity(client, farm_id, fleet_id, worker_id, input, options \\ [])

Get batched job details for a worker.

copy_job_template(client, farm_id, job_id, queue_id, input, options \\ [])

Copies a job template to an Amazon S3 bucket.

create_budget(client, farm_id, input, options \\ [])

Creates a budget to set spending thresholds for your rendering activity.

create_farm(client, input, options \\ [])

Creates a farm to allow space for queues and fleets.

create_fleet(client, farm_id, input, options \\ [])

Creates a fleet.

create_job(client, farm_id, queue_id, input, options \\ [])

Creates a job.

create_license_endpoint(client, input, options \\ [])

Creates a license endpoint to integrate your various licensed software used for rendering on Deadline Cloud.

create_monitor(client, input, options \\ [])

Creates an Amazon Web Services Deadline Cloud monitor that you can use to view your farms, queues, and fleets.

create_queue(client, farm_id, input, options \\ [])

Creates a queue to coordinate the order in which jobs run on a farm.

create_queue_environment(client, farm_id, queue_id, input, options \\ [])

Creates an environment for a queue that defines how jobs in the queue run.

create_queue_fleet_association(client, farm_id, input, options \\ [])

Creates an association between a queue and a fleet.

create_storage_profile(client, farm_id, input, options \\ [])

Creates a storage profile that specifies the operating system, file type, and file location of resources used on a farm.

create_worker(client, farm_id, fleet_id, input, options \\ [])

Creates a worker.

delete_budget(client, budget_id, farm_id, input, options \\ [])

Deletes a budget.

delete_farm(client, farm_id, input, options \\ [])

Deletes a farm.

delete_fleet(client, farm_id, fleet_id, input, options \\ [])

Deletes a fleet.

delete_license_endpoint(client, license_endpoint_id, input, options \\ [])

Deletes a license endpoint.

delete_metered_product(client, license_endpoint_id, product_id, input, options \\ [])

Deletes a metered product.

delete_monitor(client, monitor_id, input, options \\ [])

Removes a Deadline Cloud monitor.

delete_queue(client, farm_id, queue_id, input, options \\ [])

Deletes a queue.

delete_queue_environment(client, farm_id, queue_environment_id, queue_id, input, options \\ [])

Deletes a queue environment.

delete_queue_fleet_association(client, farm_id, fleet_id, queue_id, input, options \\ [])

Deletes a queue-fleet association.

delete_storage_profile(client, farm_id, storage_profile_id, input, options \\ [])

Deletes a storage profile.

delete_worker(client, farm_id, fleet_id, worker_id, input, options \\ [])

Deletes a worker.

disassociate_member_from_farm(client, farm_id, principal_id, input, options \\ [])

Disassociates a member from a farm.

disassociate_member_from_fleet(client, farm_id, fleet_id, principal_id, input, options \\ [])

Disassociates a member from a fleet.

disassociate_member_from_job(client, farm_id, job_id, principal_id, queue_id, input, options \\ [])

Disassociates a member from a job.

disassociate_member_from_queue(client, farm_id, principal_id, queue_id, input, options \\ [])

Disassociates a member from a queue.

get_budget(client, budget_id, farm_id, options \\ [])

Get a budget.

get_farm(client, farm_id, options \\ [])

Get a farm.

get_fleet(client, farm_id, fleet_id, options \\ [])

Get a fleet.

get_job(client, farm_id, job_id, queue_id, options \\ [])

Gets a Deadline Cloud job.

get_license_endpoint(client, license_endpoint_id, options \\ [])

Gets a licence endpoint.

get_monitor(client, monitor_id, options \\ [])

Gets information about the specified monitor.

get_queue(client, farm_id, queue_id, options \\ [])

Gets a queue.

get_queue_environment(client, farm_id, queue_environment_id, queue_id, options \\ [])

Gets a queue environment.

get_queue_fleet_association(client, farm_id, fleet_id, queue_id, options \\ [])

Gets a queue-fleet association.

get_session(client, farm_id, job_id, queue_id, session_id, options \\ [])

Gets a session.

get_session_action(client, farm_id, job_id, queue_id, session_action_id, options \\ [])

Gets a session action for the job.

get_sessions_statistics_aggregation(client, farm_id, aggregation_id, max_results \\ nil, next_token \\ nil, options \\ [])

Gets a set of statistics for queues or farms.

get_step(client, farm_id, job_id, queue_id, step_id, options \\ [])

Gets a step.

get_storage_profile(client, farm_id, storage_profile_id, options \\ [])

Gets a storage profile.

get_storage_profile_for_queue(client, farm_id, queue_id, storage_profile_id, options \\ [])

Gets a storage profile for a queue.

get_task(client, farm_id, job_id, queue_id, step_id, task_id, options \\ [])

Gets a task.

get_worker(client, farm_id, fleet_id, worker_id, options \\ [])

Gets a worker.

list_available_metered_products(client, max_results \\ nil, next_token \\ nil, options \\ [])

A list of the available metered products.

list_budgets(client, farm_id, max_results \\ nil, next_token \\ nil, status \\ nil, options \\ [])

A list of budgets in a farm.

list_farm_members(client, farm_id, max_results \\ nil, next_token \\ nil, options \\ [])

Lists the members of a farm.

list_farms(client, max_results \\ nil, next_token \\ nil, principal_id \\ nil, options \\ [])

Lists farms.

list_fleet_members(client, farm_id, fleet_id, max_results \\ nil, next_token \\ nil, options \\ [])

Lists fleet members.

list_fleets(client, farm_id, display_name \\ nil, max_results \\ nil, next_token \\ nil, principal_id \\ nil, status \\ nil, options \\ [])

Lists fleets.

list_job_members(client, farm_id, job_id, queue_id, max_results \\ nil, next_token \\ nil, options \\ [])

Lists members on a job.

list_job_parameter_definitions(client, farm_id, job_id, queue_id, max_results \\ nil, next_token \\ nil, options \\ [])

Lists parameter definitions of a job.

list_jobs(client, farm_id, queue_id, max_results \\ nil, next_token \\ nil, principal_id \\ nil, options \\ [])

Lists jobs.

list_license_endpoints(client, max_results \\ nil, next_token \\ nil, options \\ [])

Lists license endpoints.

list_metered_products(client, license_endpoint_id, max_results \\ nil, next_token \\ nil, options \\ [])

Lists metered products.

list_monitors(client, max_results \\ nil, next_token \\ nil, options \\ [])

Gets a list of your monitors in Deadline Cloud.

list_queue_environments(client, farm_id, queue_id, max_results \\ nil, next_token \\ nil, options \\ [])

Lists queue environments.

list_queue_fleet_associations(client, farm_id, fleet_id \\ nil, max_results \\ nil, next_token \\ nil, queue_id \\ nil, options \\ [])

Lists queue-fleet associations.

list_queue_members(client, farm_id, queue_id, max_results \\ nil, next_token \\ nil, options \\ [])

Lists the members in a queue.

list_queues(client, farm_id, max_results \\ nil, next_token \\ nil, principal_id \\ nil, status \\ nil, options \\ [])

Lists queues.

list_session_actions(client, farm_id, job_id, queue_id, max_results \\ nil, next_token \\ nil, session_id \\ nil, task_id \\ nil, options \\ [])

Lists session actions.

list_sessions(client, farm_id, job_id, queue_id, max_results \\ nil, next_token \\ nil, options \\ [])

Lists sessions.

list_sessions_for_worker(client, farm_id, fleet_id, worker_id, max_results \\ nil, next_token \\ nil, options \\ [])

Lists sessions for a worker.

list_step_consumers(client, farm_id, job_id, queue_id, step_id, max_results \\ nil, next_token \\ nil, options \\ [])

Lists step consumers.

list_step_dependencies(client, farm_id, job_id, queue_id, step_id, max_results \\ nil, next_token \\ nil, options \\ [])

Lists the dependencies for a step.

list_steps(client, farm_id, job_id, queue_id, max_results \\ nil, next_token \\ nil, options \\ [])

Lists steps for a job.

list_storage_profiles(client, farm_id, max_results \\ nil, next_token \\ nil, options \\ [])

Lists storage profiles.

list_storage_profiles_for_queue(client, farm_id, queue_id, max_results \\ nil, next_token \\ nil, options \\ [])

Lists storage profiles for a queue.

list_tags_for_resource(client, resource_arn, options \\ [])

Lists tags for a resource.

list_tasks(client, farm_id, job_id, queue_id, step_id, max_results \\ nil, next_token \\ nil, options \\ [])

Lists tasks for a job.

list_workers(client, farm_id, fleet_id, max_results \\ nil, next_token \\ nil, options \\ [])

Lists workers.

metadata()
put_metered_product(client, license_endpoint_id, product_id, input, options \\ [])

Adds a metered product.

search_jobs(client, farm_id, input, options \\ [])

Searches for jobs.

search_steps(client, farm_id, input, options \\ [])

Searches for steps.

search_tasks(client, farm_id, input, options \\ [])

Searches for tasks.

search_workers(client, farm_id, input, options \\ [])

Searches for workers.

start_sessions_statistics_aggregation(client, farm_id, input, options \\ [])

Starts an asynchronous request for getting aggregated statistics about queues and farms.

tag_resource(client, resource_arn, input, options \\ [])

Tags a resource using the resource's ARN and desired tags.

untag_resource(client, resource_arn, input, options \\ [])

Removes a tag from a resource using the resource's ARN and tag to remove.

update_budget(client, budget_id, farm_id, input, options \\ [])

Updates a budget that sets spending thresholds for rendering activity.

update_farm(client, farm_id, input, options \\ [])

Updates a farm.

update_fleet(client, farm_id, fleet_id, input, options \\ [])

Updates a fleet.

update_job(client, farm_id, job_id, queue_id, input, options \\ [])

Updates a job.

update_monitor(client, monitor_id, input, options \\ [])

Modifies the settings for a Deadline Cloud monitor.

update_queue(client, farm_id, queue_id, input, options \\ [])

Updates a queue.

update_queue_environment(client, farm_id, queue_environment_id, queue_id, input, options \\ [])

Updates the queue environment.

update_queue_fleet_association(client, farm_id, fleet_id, queue_id, input, options \\ [])

Updates a queue-fleet association.

update_session(client, farm_id, job_id, queue_id, session_id, input, options \\ [])

Updates a session.

update_step(client, farm_id, job_id, queue_id, step_id, input, options \\ [])

Updates a step.

update_storage_profile(client, farm_id, storage_profile_id, input, options \\ [])

Updates a storage profile.

update_task(client, farm_id, job_id, queue_id, step_id, task_id, input, options \\ [])

Updates a task.

update_worker(client, farm_id, fleet_id, worker_id, input, options \\ [])

Updates a worker.

update_worker_schedule(client, farm_id, fleet_id, worker_id, input, options \\ [])

Updates the schedule for a worker.

Link to this section Functions

Link to this function

associate_member_to_farm(client, farm_id, principal_id, input, options \\ [])

View Source

Assigns a farm membership level to a member.

Link to this function

associate_member_to_fleet(client, farm_id, fleet_id, principal_id, input, options \\ [])

View Source

Assigns a fleet membership level to a member.

Link to this function

associate_member_to_job(client, farm_id, job_id, principal_id, queue_id, input, options \\ [])

View Source

Assigns a job membership level to a member

Link to this function

associate_member_to_queue(client, farm_id, principal_id, queue_id, input, options \\ [])

View Source

Assigns a queue membership level to a member

Link to this function

assume_fleet_role_for_read(client, farm_id, fleet_id, options \\ [])

View Source

Get Amazon Web Services credentials from the fleet role.

The IAM permissions of the credentials are scoped down to have read-only access.

Link to this function

assume_fleet_role_for_worker(client, farm_id, fleet_id, worker_id, options \\ [])

View Source

Get credentials from the fleet role for a worker.

Link to this function

assume_queue_role_for_read(client, farm_id, queue_id, options \\ [])

View Source

Gets Amazon Web Services credentials from the queue role.

The IAM permissions of the credentials are scoped down to have read-only access.

Link to this function

assume_queue_role_for_user(client, farm_id, queue_id, options \\ [])

View Source

Allows a user to assume a role for a queue.

Link to this function

assume_queue_role_for_worker(client, farm_id, fleet_id, worker_id, queue_id, options \\ [])

View Source

Allows a worker to assume a queue role.

Link to this function

batch_get_job_entity(client, farm_id, fleet_id, worker_id, input, options \\ [])

View Source

Get batched job details for a worker.

Link to this function

copy_job_template(client, farm_id, job_id, queue_id, input, options \\ [])

View Source

Copies a job template to an Amazon S3 bucket.

Link to this function

create_budget(client, farm_id, input, options \\ [])

View Source

Creates a budget to set spending thresholds for your rendering activity.

Link to this function

create_farm(client, input, options \\ [])

View Source

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.

Link to this function

create_fleet(client, farm_id, input, options \\ [])

View Source

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.

Link to this function

create_job(client, farm_id, queue_id, input, options \\ [])

View Source

Creates a job.

A job is a set of instructions that AWS Deadline Cloud uses to schedule and run work on available workers. For more information, see Deadline Cloud jobs.

Link to this function

create_license_endpoint(client, input, options \\ [])

View Source

Creates a license endpoint to integrate your various licensed software used for rendering on Deadline Cloud.

Link to this function

create_monitor(client, input, options \\ [])

View Source

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.

Link to this function

create_queue(client, farm_id, input, options \\ [])

View Source

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.

Link to this function

create_queue_environment(client, farm_id, queue_id, input, options \\ [])

View Source

Creates an environment for a queue that defines how jobs in the queue run.

Link to this function

create_queue_fleet_association(client, farm_id, input, options \\ [])

View Source

Creates an association between a queue and a fleet.

Link to this function

create_storage_profile(client, farm_id, input, options \\ [])

View Source

Creates a storage profile that specifies the operating system, file type, and file location of resources used on a farm.

Link to this function

create_worker(client, farm_id, fleet_id, input, options \\ [])

View Source

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.

Link to this function

delete_budget(client, budget_id, farm_id, input, options \\ [])

View Source

Deletes a budget.

Link to this function

delete_farm(client, farm_id, input, options \\ [])

View Source

Deletes a farm.

Link to this function

delete_fleet(client, farm_id, fleet_id, input, options \\ [])

View Source

Deletes a fleet.

Link to this function

delete_license_endpoint(client, license_endpoint_id, input, options \\ [])

View Source

Deletes a license endpoint.

Link to this function

delete_metered_product(client, license_endpoint_id, product_id, input, options \\ [])

View Source

Deletes a metered product.

Link to this function

delete_monitor(client, monitor_id, input, options \\ [])

View Source

Removes a Deadline Cloud monitor.

After you delete a monitor, you can create a new one and attach farms to the monitor.

Link to this function

delete_queue(client, farm_id, queue_id, input, options \\ [])

View Source

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.

Link to this function

delete_queue_environment(client, farm_id, queue_environment_id, queue_id, input, options \\ [])

View Source

Deletes a queue environment.

Link to this function

delete_queue_fleet_association(client, farm_id, fleet_id, queue_id, input, options \\ [])

View Source

Deletes a queue-fleet association.

Link to this function

delete_storage_profile(client, farm_id, storage_profile_id, input, options \\ [])

View Source

Deletes a storage profile.

Link to this function

delete_worker(client, farm_id, fleet_id, worker_id, input, options \\ [])

View Source

Deletes a worker.

Link to this function

disassociate_member_from_farm(client, farm_id, principal_id, input, options \\ [])

View Source

Disassociates a member from a farm.

Link to this function

disassociate_member_from_fleet(client, farm_id, fleet_id, principal_id, input, options \\ [])

View Source

Disassociates a member from a fleet.

Link to this function

disassociate_member_from_job(client, farm_id, job_id, principal_id, queue_id, input, options \\ [])

View Source

Disassociates a member from a job.

Link to this function

disassociate_member_from_queue(client, farm_id, principal_id, queue_id, input, options \\ [])

View Source

Disassociates a member from a queue.

Link to this function

get_budget(client, budget_id, farm_id, options \\ [])

View Source

Get a budget.

Link to this function

get_farm(client, farm_id, options \\ [])

View Source

Get a farm.

Link to this function

get_fleet(client, farm_id, fleet_id, options \\ [])

View Source

Get a fleet.

Link to this function

get_job(client, farm_id, job_id, queue_id, options \\ [])

View Source

Gets a Deadline Cloud job.

Link to this function

get_license_endpoint(client, license_endpoint_id, options \\ [])

View Source

Gets a licence endpoint.

Link to this function

get_monitor(client, monitor_id, options \\ [])

View Source

Gets information about the specified monitor.

Link to this function

get_queue(client, farm_id, queue_id, options \\ [])

View Source

Gets a queue.

Link to this function

get_queue_environment(client, farm_id, queue_environment_id, queue_id, options \\ [])

View Source

Gets a queue environment.

Link to this function

get_queue_fleet_association(client, farm_id, fleet_id, queue_id, options \\ [])

View Source

Gets a queue-fleet association.

Link to this function

get_session(client, farm_id, job_id, queue_id, session_id, options \\ [])

View Source

Gets a session.

Link to this function

get_session_action(client, farm_id, job_id, queue_id, session_action_id, options \\ [])

View Source

Gets a session action for the job.

Link to this function

get_sessions_statistics_aggregation(client, farm_id, aggregation_id, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Gets 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.

Link to this function

get_step(client, farm_id, job_id, queue_id, step_id, options \\ [])

View Source

Gets a step.

Link to this function

get_storage_profile(client, farm_id, storage_profile_id, options \\ [])

View Source

Gets a storage profile.

Link to this function

get_storage_profile_for_queue(client, farm_id, queue_id, storage_profile_id, options \\ [])

View Source

Gets a storage profile for a queue.

Link to this function

get_task(client, farm_id, job_id, queue_id, step_id, task_id, options \\ [])

View Source

Gets a task.

Link to this function

get_worker(client, farm_id, fleet_id, worker_id, options \\ [])

View Source

Gets a worker.

Link to this function

list_available_metered_products(client, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

A list of the available metered products.

Link to this function

list_budgets(client, farm_id, max_results \\ nil, next_token \\ nil, status \\ nil, options \\ [])

View Source

A list of budgets in a farm.

Link to this function

list_farm_members(client, farm_id, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Lists the members of a farm.

Link to this function

list_farms(client, max_results \\ nil, next_token \\ nil, principal_id \\ nil, options \\ [])

View Source

Lists farms.

Link to this function

list_fleet_members(client, farm_id, fleet_id, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Lists fleet members.

Link to this function

list_fleets(client, farm_id, display_name \\ nil, max_results \\ nil, next_token \\ nil, principal_id \\ nil, status \\ nil, options \\ [])

View Source

Lists fleets.

Link to this function

list_job_members(client, farm_id, job_id, queue_id, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Lists members on a job.

Link to this function

list_job_parameter_definitions(client, farm_id, job_id, queue_id, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Lists parameter definitions of a job.

Link to this function

list_jobs(client, farm_id, queue_id, max_results \\ nil, next_token \\ nil, principal_id \\ nil, options \\ [])

View Source

Lists jobs.

Link to this function

list_license_endpoints(client, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Lists license endpoints.

Link to this function

list_metered_products(client, license_endpoint_id, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Lists metered products.

Link to this function

list_monitors(client, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Gets a list of your monitors in Deadline Cloud.

Link to this function

list_queue_environments(client, farm_id, queue_id, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Lists queue environments.

Link to this function

list_queue_fleet_associations(client, farm_id, fleet_id \\ nil, max_results \\ nil, next_token \\ nil, queue_id \\ nil, options \\ [])

View Source

Lists queue-fleet associations.

Link to this function

list_queue_members(client, farm_id, queue_id, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Lists the members in a queue.

Link to this function

list_queues(client, farm_id, max_results \\ nil, next_token \\ nil, principal_id \\ nil, status \\ nil, options \\ [])

View Source

Lists queues.

Link to this function

list_session_actions(client, farm_id, job_id, queue_id, max_results \\ nil, next_token \\ nil, session_id \\ nil, task_id \\ nil, options \\ [])

View Source

Lists session actions.

Link to this function

list_sessions(client, farm_id, job_id, queue_id, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Lists sessions.

Link to this function

list_sessions_for_worker(client, farm_id, fleet_id, worker_id, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Lists sessions for a worker.

Link to this function

list_step_consumers(client, farm_id, job_id, queue_id, step_id, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Lists step consumers.

Link to this function

list_step_dependencies(client, farm_id, job_id, queue_id, step_id, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Lists the dependencies for a step.

Link to this function

list_steps(client, farm_id, job_id, queue_id, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Lists steps for a job.

Link to this function

list_storage_profiles(client, farm_id, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Lists storage profiles.

Link to this function

list_storage_profiles_for_queue(client, farm_id, queue_id, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Lists storage profiles for a queue.

Link to this function

list_tags_for_resource(client, resource_arn, options \\ [])

View Source

Lists tags for a resource.

Link to this function

list_tasks(client, farm_id, job_id, queue_id, step_id, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Lists tasks for a job.

Link to this function

list_workers(client, farm_id, fleet_id, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Lists workers.

Link to this function

metadata()

View Source
Link to this function

put_metered_product(client, license_endpoint_id, product_id, input, options \\ [])

View Source

Adds a metered product.

Link to this function

search_jobs(client, farm_id, input, options \\ [])

View Source

Searches for jobs.

Link to this function

search_steps(client, farm_id, input, options \\ [])

View Source

Searches for steps.

Link to this function

search_tasks(client, farm_id, input, options \\ [])

View Source

Searches for tasks.

Link to this function

search_workers(client, farm_id, input, options \\ [])

View Source

Searches for workers.

Link to this function

start_sessions_statistics_aggregation(client, farm_id, input, options \\ [])

View Source

Starts 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.

Link to this function

tag_resource(client, resource_arn, input, options \\ [])

View Source

Tags a resource using the resource's ARN and desired tags.

Link to this function

untag_resource(client, resource_arn, input, options \\ [])

View Source

Removes a tag from a resource using the resource's ARN and tag to remove.

Link to this function

update_budget(client, budget_id, farm_id, input, options \\ [])

View Source

Updates a budget that sets spending thresholds for rendering activity.

Link to this function

update_farm(client, farm_id, input, options \\ [])

View Source

Updates a farm.

Link to this function

update_fleet(client, farm_id, fleet_id, input, options \\ [])

View Source

Updates a fleet.

Link to this function

update_job(client, farm_id, job_id, queue_id, input, options \\ [])

View Source

Updates 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.

Link to this function

update_monitor(client, monitor_id, input, options \\ [])

View Source

Modifies the settings for a Deadline Cloud monitor.

You can modify one or all of the settings when you call UpdateMonitor.

Link to this function

update_queue(client, farm_id, queue_id, input, options \\ [])

View Source

Updates a queue.

Link to this function

update_queue_environment(client, farm_id, queue_environment_id, queue_id, input, options \\ [])

View Source

Updates the queue environment.

Link to this function

update_queue_fleet_association(client, farm_id, fleet_id, queue_id, input, options \\ [])

View Source

Updates a queue-fleet association.

Link to this function

update_session(client, farm_id, job_id, queue_id, session_id, input, options \\ [])

View Source

Updates a session.

Link to this function

update_step(client, farm_id, job_id, queue_id, step_id, input, options \\ [])

View Source

Updates a step.

Link to this function

update_storage_profile(client, farm_id, storage_profile_id, input, options \\ [])

View Source

Updates a storage profile.

Link to this function

update_task(client, farm_id, job_id, queue_id, step_id, task_id, input, options \\ [])

View Source

Updates a task.

Link to this function

update_worker(client, farm_id, fleet_id, worker_id, input, options \\ [])

View Source

Updates a worker.

Link to this function

update_worker_schedule(client, farm_id, fleet_id, worker_id, input, options \\ [])

View Source

Updates the schedule for a worker.