Class: AWS.Deadline
- Inherits:
-
AWS.Service
- Object
- AWS.Service
- AWS.Deadline
- Identifier:
- deadline
- API Version:
- 2023-10-12
- Defined in:
- (unknown)
Overview
Constructs a service interface object. Each API operation is exposed as a function on service.
Service Description
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.
Sending a Request Using Deadline
var deadline = new AWS.Deadline();
deadline.createBudget(params, function (err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Locking the API Version
In order to ensure that the Deadline object uses this specific API, you can
construct the object by passing the apiVersion option to the constructor:
var deadline = new AWS.Deadline({apiVersion: '2023-10-12'});
You can also set the API version globally in AWS.config.apiVersions using
the deadline service identifier:
AWS.config.apiVersions = {
deadline: '2023-10-12',
// other service API versions
};
var deadline = new AWS.Deadline();
Waiter Resource States
This service supports a list of resource states that can be polled using the waitFor() method. The resource states are:
fleetActive, jobCreateComplete, licenseEndpointDeleted, licenseEndpointValid, queueFleetAssociationStopped, queueScheduling, queueSchedulingBlocked
Constructor Summary collapse
-
new AWS.Deadline(options = {}) ⇒ Object
constructor
Constructs a service object.
Property Summary collapse
-
endpoint ⇒ AWS.Endpoint
readwrite
An Endpoint object representing the endpoint URL for service requests.
Properties inherited from AWS.Service
Method Summary collapse
-
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.
-
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.
-
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.
-
createFleet(params = {}, callback) ⇒ AWS.Request
Creates a fleet.
-
createJob(params = {}, callback) ⇒ AWS.Request
Creates a job.
-
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.
-
createQueue(params = {}, callback) ⇒ AWS.Request
Creates a queue to coordinate the order in which jobs run on a farm.
-
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.
-
deleteBudget(params = {}, callback) ⇒ AWS.Request
Deletes a budget.
.
-
deleteFarm(params = {}, callback) ⇒ AWS.Request
Deletes a farm.
.
-
deleteFleet(params = {}, callback) ⇒ AWS.Request
Deletes a fleet.
.
-
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.
-
deleteQueue(params = {}, callback) ⇒ AWS.Request
Deletes a queue.
You can't recover the jobs in a queue if you delete the 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.
.
-
deleteWorker(params = {}, callback) ⇒ AWS.Request
Deletes a worker.
.
-
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.
.
-
getBudget(params = {}, callback) ⇒ AWS.Request
Get a budget.
.
-
getFarm(params = {}, callback) ⇒ AWS.Request
Get a farm.
.
-
getFleet(params = {}, callback) ⇒ AWS.Request
Get a fleet.
.
-
getJob(params = {}, callback) ⇒ AWS.Request
Gets a Deadline Cloud job.
.
-
getLicenseEndpoint(params = {}, callback) ⇒ AWS.Request
Gets a licence endpoint.
.
-
getMonitor(params = {}, callback) ⇒ AWS.Request
Gets information about the specified monitor.
.
-
getQueue(params = {}, callback) ⇒ AWS.Request
Gets a queue.
.
-
getQueueEnvironment(params = {}, callback) ⇒ AWS.Request
Gets a queue environment.
.
-
getQueueFleetAssociation(params = {}, callback) ⇒ AWS.Request
Gets a queue-fleet association.
.
-
getSession(params = {}, callback) ⇒ AWS.Request
Gets a session.
.
-
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.
-
getStep(params = {}, callback) ⇒ AWS.Request
Gets a step.
.
-
getStorageProfile(params = {}, callback) ⇒ AWS.Request
Gets a storage profile.
.
-
getStorageProfileForQueue(params = {}, callback) ⇒ AWS.Request
Gets a storage profile for a queue.
.
-
getTask(params = {}, callback) ⇒ AWS.Request
Gets a task.
.
-
getWorker(params = {}, callback) ⇒ AWS.Request
Gets a worker.
.
-
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.
.
-
listFarms(params = {}, callback) ⇒ AWS.Request
Lists farms.
.
-
listFleetMembers(params = {}, callback) ⇒ AWS.Request
Lists fleet members.
.
-
listFleets(params = {}, callback) ⇒ AWS.Request
Lists fleets.
.
-
listJobMembers(params = {}, callback) ⇒ AWS.Request
Lists members on a job.
.
-
listJobs(params = {}, callback) ⇒ AWS.Request
Lists jobs.
.
-
listLicenseEndpoints(params = {}, callback) ⇒ AWS.Request
Lists license endpoints.
.
-
listMeteredProducts(params = {}, callback) ⇒ AWS.Request
Lists metered products.
.
-
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.
.
-
listQueues(params = {}, callback) ⇒ AWS.Request
Lists queues.
.
-
listSessionActions(params = {}, callback) ⇒ AWS.Request
Lists session actions.
.
-
listSessions(params = {}, callback) ⇒ AWS.Request
Lists sessions.
.
-
listSessionsForWorker(params = {}, callback) ⇒ AWS.Request
Lists sessions for a worker.
.
-
listStepConsumers(params = {}, callback) ⇒ AWS.Request
Lists step consumers.
.
-
listStepDependencies(params = {}, callback) ⇒ AWS.Request
Lists the dependencies for a step.
.
-
listSteps(params = {}, callback) ⇒ AWS.Request
Lists steps for a job.
.
-
listStorageProfiles(params = {}, callback) ⇒ AWS.Request
Lists storage profiles.
.
-
listStorageProfilesForQueue(params = {}, callback) ⇒ AWS.Request
Lists storage profiles for a queue.
.
-
listTagsForResource(params = {}, callback) ⇒ AWS.Request
Lists tags for a resource.
.