AWS.Deadline — AWS SDK for JavaScript (original) (raw)

This service supports a list of resource states that can be polled using the waitFor() method. The resource states are:

Property Details

endpoint ⇒ AWS.Endpoint

Returns an Endpoint object representing the endpoint URL for service requests.

Method Details

associateMemberToFarm(params = {}, callback) ⇒ AWS.Request

Assigns a farm membership level to a member.

associateMemberToFleet(params = {}, callback) ⇒ AWS.Request

Assigns a fleet membership level to a member.

associateMemberToJob(params = {}, callback) ⇒ AWS.Request

Assigns a job membership level to a member

associateMemberToQueue(params = {}, callback) ⇒ AWS.Request

Assigns a queue membership level to a member

assumeFleetRoleForRead(params = {}, callback) ⇒ AWS.Request

Get Amazon Web Services credentials from the fleet role. The IAM permissions of the credentials are scoped down to have read-only access.

assumeFleetRoleForWorker(params = {}, callback) ⇒ AWS.Request

Get credentials from the fleet role for a worker.

assumeQueueRoleForRead(params = {}, callback) ⇒ AWS.Request

Gets Amazon Web Services credentials from the queue role. The IAM permissions of the credentials are scoped down to have read-only access.

assumeQueueRoleForUser(params = {}, callback) ⇒ AWS.Request

Allows a user to assume a role for a queue.

assumeQueueRoleForWorker(params = {}, callback) ⇒ AWS.Request

Allows a worker to assume a queue role.

batchGetJobEntity(params = {}, callback) ⇒ AWS.Request

Get batched job details for a worker.

copyJobTemplate(params = {}, callback) ⇒ AWS.Request

Copies a job template to an Amazon S3 bucket.

createBudget(params = {}, callback) ⇒ AWS.Request

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

createFarm(params = {}, callback) ⇒ AWS.Request

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.

createFleet(params = {}, callback) ⇒ AWS.Request

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.

createJob(params = {}, callback) ⇒ AWS.Request

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.

createLicenseEndpoint(params = {}, callback) ⇒ AWS.Request

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

createMonitor(params = {}, callback) ⇒ AWS.Request

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.

createQueue(params = {}, callback) ⇒ AWS.Request

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.

createQueueEnvironment(params = {}, callback) ⇒ AWS.Request

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

createQueueFleetAssociation(params = {}, callback) ⇒ AWS.Request

Creates an association between a queue and a fleet.

createStorageProfile(params = {}, callback) ⇒ AWS.Request

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

createWorker(params = {}, callback) ⇒ AWS.Request

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.

deleteLicenseEndpoint(params = {}, callback) ⇒ AWS.Request

Deletes a license endpoint.

deleteMeteredProduct(params = {}, callback) ⇒ AWS.Request

Deletes a metered product.

deleteMonitor(params = {}, callback) ⇒ AWS.Request

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

deleteQueue(params = {}, callback) ⇒ AWS.Request

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.

deleteQueueEnvironment(params = {}, callback) ⇒ AWS.Request

Deletes a queue environment.

deleteQueueFleetAssociation(params = {}, callback) ⇒ AWS.Request

Deletes a queue-fleet association.

deleteStorageProfile(params = {}, callback) ⇒ AWS.Request

Deletes a storage profile.

disassociateMemberFromFarm(params = {}, callback) ⇒ AWS.Request

Disassociates a member from a farm.

disassociateMemberFromFleet(params = {}, callback) ⇒ AWS.Request

Disassociates a member from a fleet.

disassociateMemberFromJob(params = {}, callback) ⇒ AWS.Request

Disassociates a member from a job.

disassociateMemberFromQueue(params = {}, callback) ⇒ AWS.Request

Disassociates a member from a queue.

getJob(params = {}, callback) ⇒ AWS.Request

Gets a Deadline Cloud job.

getLicenseEndpoint(params = {}, callback) ⇒ AWS.Request

getMonitor(params = {}, callback) ⇒ AWS.Request

Gets information about the specified monitor.

getQueueEnvironment(params = {}, callback) ⇒ AWS.Request

Gets a queue environment.

getQueueFleetAssociation(params = {}, callback) ⇒ AWS.Request

Gets a queue-fleet association.

getSessionAction(params = {}, callback) ⇒ AWS.Request

Gets a session action for the job.

getSessionsStatisticsAggregation(params = {}, callback) ⇒ AWS.Request

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.

getStorageProfile(params = {}, callback) ⇒ AWS.Request

getStorageProfileForQueue(params = {}, callback) ⇒ AWS.Request

Gets a storage profile for a queue.

listAvailableMeteredProducts(params = {}, callback) ⇒ AWS.Request

A list of the available metered products.

listBudgets(params = {}, callback) ⇒ AWS.Request

A list of budgets in a farm.

listFarmMembers(params = {}, callback) ⇒ AWS.Request

Lists the members of a farm.

listFleetMembers(params = {}, callback) ⇒ AWS.Request

listJobMembers(params = {}, callback) ⇒ AWS.Request

listLicenseEndpoints(params = {}, callback) ⇒ AWS.Request

listMeteredProducts(params = {}, callback) ⇒ AWS.Request

listMonitors(params = {}, callback) ⇒ AWS.Request

Gets a list of your monitors in Deadline Cloud.

listQueueEnvironments(params = {}, callback) ⇒ AWS.Request

Lists queue environments.

listQueueFleetAssociations(params = {}, callback) ⇒ AWS.Request

Lists queue-fleet associations.

listQueueMembers(params = {}, callback) ⇒ AWS.Request

Lists the members in a queue.

listSessionActions(params = {}, callback) ⇒ AWS.Request

listSessionsForWorker(params = {}, callback) ⇒ AWS.Request

Lists sessions for a worker.

listStepConsumers(params = {}, callback) ⇒ AWS.Request

listStepDependencies(params = {}, callback) ⇒ AWS.Request

Lists the dependencies for a step.

listStorageProfiles(params = {}, callback) ⇒ AWS.Request

listStorageProfilesForQueue(params = {}, callback) ⇒ AWS.Request

Lists storage profiles for a queue.

listTagsForResource(params = {}, callback) ⇒ AWS.Request

Lists tags for a resource.

putMeteredProduct(params = {}, callback) ⇒ AWS.Request

searchWorkers(params = {}, callback) ⇒ AWS.Request

startSessionsStatisticsAggregation(params = {}, callback) ⇒ AWS.Request

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.

tagResource(params = {}, callback) ⇒ AWS.Request

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

untagResource(params = {}, callback) ⇒ AWS.Request

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

updateBudget(params = {}, callback) ⇒ AWS.Request

Updates a budget that sets spending thresholds for rendering activity.

updateJob(params = {}, callback) ⇒ AWS.Request

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.

updateMonitor(params = {}, callback) ⇒ AWS.Request

Modifies the settings for a Deadline Cloud monitor. You can modify one or all of the settings when you call UpdateMonitor.

updateQueueEnvironment(params = {}, callback) ⇒ AWS.Request

Updates the queue environment.

updateQueueFleetAssociation(params = {}, callback) ⇒ AWS.Request

Updates a queue-fleet association.

updateSession(params = {}, callback) ⇒ AWS.Request

updateStorageProfile(params = {}, callback) ⇒ AWS.Request

Updates a storage profile.

updateWorkerSchedule(params = {}, callback) ⇒ AWS.Request

Updates the schedule for a worker.

waitFor(state, params = {}, callback) ⇒ AWS.Request

Waits for a given Deadline resource. The final callback or'complete' event will be fired only when the resource is either in its final state or the waiter has timed out and stopped polling for the final state.