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();
Version:
-
2023-10-12
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.
.
-
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.
.
-
listTasks(params = {}, callback) ⇒ AWS.Request
Lists tasks for a job.
.
-
listWorkers(params = {}, callback) ⇒ AWS.Request
Lists workers.
.
-
putMeteredProduct(params = {}, callback) ⇒ AWS.Request
Adds a metered product.
.
-
searchJobs(params = {}, callback) ⇒ AWS.Request
Searches for jobs.
.
-
searchSteps(params = {}, callback) ⇒ AWS.Request
Searches for steps.
.
-
searchTasks(params = {}, callback) ⇒ AWS.Request
Searches for tasks.
.
-
searchWorkers(params = {}, callback) ⇒ AWS.Request
Searches for workers.
.
-
startSessionsStatisticsAggregation(params = {}, callback) ⇒ AWS.Request
Starts an asynchronous request for getting aggregated statistics about queues and farms.
-
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.
.
-
updateFarm(params = {}, callback) ⇒ AWS.Request
Updates a farm.
.
-
updateFleet(params = {}, callback) ⇒ AWS.Request
Updates a fleet.
.
-
updateJob(params = {}, callback) ⇒ AWS.Request
Updates a job.
.
-
updateMonitor(params = {}, callback) ⇒ AWS.Request
Modifies the settings for a Deadline Cloud monitor.
-
updateQueue(params = {}, callback) ⇒ AWS.Request
Updates a queue.
.
-
updateQueueEnvironment(params = {}, callback) ⇒ AWS.Request
Updates the queue environment.
.
-
updateQueueFleetAssociation(params = {}, callback) ⇒ AWS.Request
Updates a queue-fleet association.
.
-
updateSession(params = {}, callback) ⇒ AWS.Request
Updates a session.
.
-
updateStep(params = {}, callback) ⇒ AWS.Request
Updates a step.
.
-
updateStorageProfile(params = {}, callback) ⇒ AWS.Request
Updates a storage profile.
.
-
updateTask(params = {}, callback) ⇒ AWS.Request
Updates a task.
.
-
updateWorker(params = {}, callback) ⇒ AWS.Request
Updates a worker.
.
-
updateWorkerSchedule(params = {}, callback) ⇒ AWS.Request
Updates the schedule for a worker.
.
-
waitFor(state, params = {}, callback) ⇒ AWS.Request
Waits for a given Deadline resource.
Methods inherited from AWS.Service
makeRequest, makeUnauthenticatedRequest, setupRequestListeners, defineService
Constructor Details
new AWS.Deadline(options = {}) ⇒ Object
Constructs a service object. This object has one method for each API operation.
Examples:
Constructing a Deadline object
var deadline = new AWS.Deadline({apiVersion: '2023-10-12'});
Options Hash (options):
-
params
(map)
—
An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.
-
endpoint
(String|AWS.Endpoint)
—
The endpoint URI to send requests to. The default endpoint is built from the configured
region
. The endpoint should be a string like'https://{service}.{region}.amazonaws.com'
or an Endpoint object. -
accessKeyId
(String)
—
your AWS access key ID.
-
secretAccessKey
(String)
—
your AWS secret access key.
-
sessionToken
(AWS.Credentials)
—
the optional AWS session token to sign requests with.
-
credentials
(AWS.Credentials)
—
the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.
-
credentialProvider
(AWS.CredentialProviderChain)
—
the provider chain used to resolve credentials if no static
credentials
property is set. -
region
(String)
—
the region to send service requests to. See AWS.Deadline.region for more information.
-
maxRetries
(Integer)
—
the maximum amount of retries to attempt with a request. See AWS.Deadline.maxRetries for more information.
-
maxRedirects
(Integer)
—
the maximum amount of redirects to follow with a request. See AWS.Deadline.maxRedirects for more information.
-
sslEnabled
(Boolean)
—
whether to enable SSL for requests.
-
paramValidation
(Boolean|map)
—
whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:
- min [Boolean] — Validates that a value meets the min
constraint. This is enabled by default when paramValidation is set
to
true
. - max [Boolean] — Validates that a value meets the max constraint.
- pattern [Boolean] — Validates that a string value matches a regular expression.
- enum [Boolean] — Validates that a string value matches one of the allowable enum values.
- min [Boolean] — Validates that a value meets the min
constraint. This is enabled by default when paramValidation is set
to
-
computeChecksums
(Boolean)
—
whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)
-
convertResponseTypes
(Boolean)
—
whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to
true
. -
correctClockSkew
(Boolean)
—
whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to
false
. -
s3ForcePathStyle
(Boolean)
—
whether to force path style URLs for S3 objects.
-
s3BucketEndpoint
(Boolean)
—
whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an
endpoint
to be provided explicitly to the service constructor. -
s3DisableBodySigning
(Boolean)
—
whether S3 body signing should be disabled when using signature version
v4
. Body signing can only be disabled when using https. Defaults totrue
. -
s3UsEast1RegionalEndpoint
('legacy'|'regional')
—
when region is set to 'us-east-1', whether to send s3 request to global endpoints or 'us-east-1' regional endpoints. This config is only applicable to S3 client. Defaults to
legacy
-
s3UseArnRegion
(Boolean)
—
whether to override the request region with the region inferred from requested resource's ARN. Only available for S3 buckets Defaults to
true
-
retryDelayOptions
(map)
—
A set of options to configure the retry delay on retryable errors. Currently supported options are:
- base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
- customBackoff [function] — A custom function that accepts a
retry count and error and returns the amount of time to delay in
milliseconds. If the result is a non-zero negative value, no further
retry attempts will be made. The
base
option will be ignored if this option is supplied. The function is only called for retryable errors.
-
httpOptions
(map)
—
A set of options to pass to the low-level HTTP request. Currently supported options are:
- proxy [String] — the URL to proxy requests through
- agent [http.Agent, https.Agent] — the Agent object to perform
HTTP requests with. Used for connection pooling. Defaults to the global
agent (
http.globalAgent
) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment. - connectTimeout [Integer] — Sets the socket to timeout after
failing to establish a connection with the server after
connectTimeout
milliseconds. This timeout has no effect once a socket connection has been established. - timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
- xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
- xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
-
apiVersion
(String, Date)
—
a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by
apiVersions
). Specify 'latest' to use the latest possible version. -
apiVersions
(map<String, String|Date>)
—
a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.
-
logger
(#write, #log)
—
an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests
-
systemClockOffset
(Number)
—
an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global
AWS.config
object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds. -
signatureVersion
(String)
—
the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.
-
signatureCache
(Boolean)
—
whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to
true
. -
dynamoDbCrc32
(Boolean)
—
whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default:
true
. -
useAccelerateEndpoint
(Boolean)
—
Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default:
false
. -
clientSideMonitoring
(Boolean)
—
whether to collect and publish this client's performance metrics of all its API requests.
-
endpointDiscoveryEnabled
(Boolean|undefined)
—
whether to call operations with endpoints given by service dynamically. Setting this
-
endpointCacheSize
(Number)
—
the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000
-
hostPrefixEnabled
(Boolean)
—
whether to marshal request parameters to the prefix of hostname. Defaults to
true
. -
stsRegionalEndpoints
('legacy'|'regional')
—
whether to send sts request to global endpoints or regional endpoints. Defaults to 'legacy'.
-
useFipsEndpoint
(Boolean)
—
Enables FIPS compatible endpoints. Defaults to
false
. -
useDualstackEndpoint
(Boolean)
—
Enables IPv6 dualstack endpoint. Defaults to
false
.
Property Details
Method Details
associateMemberToFarm(params = {}, callback) ⇒ AWS.Request
Assigns a farm membership level to a member.
Service Reference:
Examples:
Calling the associateMemberToFarm operation
var params = {
farmId: 'STRING_VALUE', /* required */
identityStoreId: 'STRING_VALUE', /* required */
membershipLevel: VIEWER | CONTRIBUTOR | OWNER | MANAGER, /* required */
principalId: 'STRING_VALUE', /* required */
principalType: USER | GROUP /* required */
};
deadline.associateMemberToFarm(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
farmId
— (String
)The ID of the farm to associate with the member.
identityStoreId
— (String
)The identity store ID of the member to associate with the farm.
membershipLevel
— (String
)The principal's membership level for the associated farm.
Possible values include:"VIEWER"
"CONTRIBUTOR"
"OWNER"
"MANAGER"
principalId
— (String
)The member's principal ID to associate with the farm.
principalType
— (String
)The principal type of the member to associate with the farm.
Possible values include:"USER"
"GROUP"
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs.
-
(AWS.Response)
—
Returns:
associateMemberToFleet(params = {}, callback) ⇒ AWS.Request
Assigns a fleet membership level to a member.
Service Reference:
Examples:
Calling the associateMemberToFleet operation
var params = {
farmId: 'STRING_VALUE', /* required */
fleetId: 'STRING_VALUE', /* required */
identityStoreId: 'STRING_VALUE', /* required */
membershipLevel: VIEWER | CONTRIBUTOR | OWNER | MANAGER, /* required */
principalId: 'STRING_VALUE', /* required */
principalType: USER | GROUP /* required */
};
deadline.associateMemberToFleet(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
farmId
— (String
)The farm ID of the fleet to associate with the member.
fleetId
— (String
)The ID of the fleet to associate with a member.
identityStoreId
— (String
)The member's identity store ID to associate with the fleet.
membershipLevel
— (String
)The principal's membership level for the associated fleet.
Possible values include:"VIEWER"
"CONTRIBUTOR"
"OWNER"
"MANAGER"
principalId
— (String
)The member's principal ID to associate with a fleet.
principalType
— (String
)The member's principal type to associate with the fleet.
Possible values include:"USER"
"GROUP"
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs.
-
(AWS.Response)
—
Returns:
associateMemberToJob(params = {}, callback) ⇒ AWS.Request
Assigns a job membership level to a member
Service Reference:
Examples:
Calling the associateMemberToJob operation
var params = {
farmId: 'STRING_VALUE', /* required */
identityStoreId: 'STRING_VALUE', /* required */
jobId: 'STRING_VALUE', /* required */
membershipLevel: VIEWER | CONTRIBUTOR | OWNER | MANAGER, /* required */
principalId: 'STRING_VALUE', /* required */
principalType: USER | GROUP, /* required */
queueId: 'STRING_VALUE' /* required */
};
deadline.associateMemberToJob(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
farmId
— (String
)The farm ID of the job to associate with the member.
identityStoreId
— (String
)The member's identity store ID to associate with the job.
jobId
— (String
)The job ID to associate with the member.
membershipLevel
— (String
)The principal's membership level for the associated job.
Possible values include:"VIEWER"
"CONTRIBUTOR"
"OWNER"
"MANAGER"
principalId
— (String
)The member's principal ID to associate with the job.
principalType
— (String
)The member's principal type to associate with the job.
Possible values include:"USER"
"GROUP"
queueId
— (String
)The queue ID to associate to the member.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs.
-
(AWS.Response)
—
Returns:
associateMemberToQueue(params = {}, callback) ⇒ AWS.Request
Assigns a queue membership level to a member
Service Reference:
Examples:
Calling the associateMemberToQueue operation
var params = {
farmId: 'STRING_VALUE', /* required */
identityStoreId: 'STRING_VALUE', /* required */
membershipLevel: VIEWER | CONTRIBUTOR | OWNER | MANAGER, /* required */
principalId: 'STRING_VALUE', /* required */
principalType: USER | GROUP, /* required */
queueId: 'STRING_VALUE' /* required */
};
deadline.associateMemberToQueue(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
farmId
— (String
)The farm ID of the queue to associate with the member.
identityStoreId
— (String
)The member's identity store ID to associate with the queue.
membershipLevel
— (String
)The principal's membership level for the associated queue.
Possible values include:"VIEWER"
"CONTRIBUTOR"
"OWNER"
"MANAGER"
principalId
— (String
)The member's principal ID to associate with the queue.
principalType
— (String
)The member's principal type to associate with the queue.
Possible values include:"USER"
"GROUP"
queueId
— (String
)The ID of the queue to associate to the member.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs.
-
(AWS.Response)
—
Returns:
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.
Service Reference:
Examples:
Calling the assumeFleetRoleForRead operation
var params = {
farmId: 'STRING_VALUE', /* required */
fleetId: 'STRING_VALUE' /* required */
};
deadline.assumeFleetRoleForRead(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
farmId
— (String
)The farm ID for the fleet's farm.
fleetId
— (String
)The fleet ID.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:credentials
— (map
)The credentials for the fleet role.
accessKeyId
— required — (String
)The IAM access key ID.
expiration
— required — (Date
)The expiration date and time of the IAM credentials.
secretAccessKey
— required — (String
)The IAM secret access key.
sessionToken
— required — (String
)The IAM session token
-
(AWS.Response)
—
Returns:
assumeFleetRoleForWorker(params = {}, callback) ⇒ AWS.Request
Get credentials from the fleet role for a worker.
Service Reference:
Examples:
Calling the assumeFleetRoleForWorker operation
var params = {
farmId: 'STRING_VALUE', /* required */
fleetId: 'STRING_VALUE', /* required */
workerId: 'STRING_VALUE' /* required */
};
deadline.assumeFleetRoleForWorker(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
farmId
— (String
)The farm ID for the fleet's farm.
fleetId
— (String
)The fleet ID that contains the worker.
workerId
— (String
)The ID of the worker assuming the fleet role.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:credentials
— (map
)The credentials for the worker.
accessKeyId
— required — (String
)The IAM access key ID.
expiration
— required — (Date
)The expiration date and time of the IAM credentials.
secretAccessKey
— required — (String
)The IAM secret access key.
sessionToken
— required — (String
)The IAM session token
-
(AWS.Response)
—
Returns:
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.
Service Reference:
Examples:
Calling the assumeQueueRoleForRead operation
var params = {
farmId: 'STRING_VALUE', /* required */
queueId: 'STRING_VALUE' /* required */
};
deadline.assumeQueueRoleForRead(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
farmId
— (String
)The farm ID of the farm containing the queue.
queueId
— (String
)The queue ID.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:credentials
— (map
)The credentials for the queue role.
accessKeyId
— required — (String
)The IAM access key ID.
expiration
— required — (Date
)The expiration date and time of the IAM credentials.
secretAccessKey
— required — (String
)The IAM secret access key.
sessionToken
— required — (String
)The IAM session token
-
(AWS.Response)
—
Returns:
assumeQueueRoleForUser(params = {}, callback) ⇒ AWS.Request
Allows a user to assume a role for a queue.
Service Reference:
Examples:
Calling the assumeQueueRoleForUser operation
var params = {
farmId: 'STRING_VALUE', /* required */
queueId: 'STRING_VALUE' /* required */
};
deadline.assumeQueueRoleForUser(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
farmId
— (String
)The farm ID of the queue that the user assumes the role for.
queueId
— (String
)The queue ID of the queue that the user assumes the role for.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:credentials
— (map
)The credentials for the queue role that a user has access to.
accessKeyId
— required — (String
)The IAM access key ID.
expiration
— required — (Date
)The expiration date and time of the IAM credentials.
secretAccessKey
— required — (String
)The IAM secret access key.
sessionToken
— required — (String
)The IAM session token
-
(AWS.Response)
—
Returns:
assumeQueueRoleForWorker(params = {}, callback) ⇒ AWS.Request
Allows a worker to assume a queue role.
Service Reference:
Examples:
Calling the assumeQueueRoleForWorker operation
var params = {
farmId: 'STRING_VALUE', /* required */
fleetId: 'STRING_VALUE', /* required */
queueId: 'STRING_VALUE', /* required */
workerId: 'STRING_VALUE' /* required */
};
deadline.assumeQueueRoleForWorker(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
farmId
— (String
)The farm ID of the worker assuming the queue role.
fleetId
— (String
)The fleet ID of the worker assuming the queue role.
queueId
— (String
)The queue ID of the worker assuming the queue role.
workerId
— (String
)The worker ID of the worker assuming the queue role.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:credentials
— (map
)The Amazon Web Services credentials for the role that the worker is assuming.
accessKeyId
— required — (String
)The IAM access key ID.
expiration
— required — (Date
)The expiration date and time of the IAM credentials.
secretAccessKey
— required — (String
)The IAM secret access key.
sessionToken
— required — (String
)The IAM session token
-
(AWS.Response)
—
Returns:
batchGetJobEntity(params = {}, callback) ⇒ AWS.Request
Get batched job details for a worker.
Service Reference:
Examples:
Calling the batchGetJobEntity operation
var params = {
farmId: 'STRING_VALUE', /* required */
fleetId: 'STRING_VALUE', /* required */
identifiers: [ /* required */
{
environmentDetails: {
environmentId: 'STRING_VALUE', /* required */
jobId: 'STRING_VALUE' /* required */
},
jobAttachmentDetails: {
jobId: 'STRING_VALUE' /* required */
},
jobDetails: {
jobId: 'STRING_VALUE' /* required */
},
stepDetails: {
jobId: 'STRING_VALUE', /* required */
stepId: 'STRING_VALUE' /* required */
}
},
/* more items */
],
workerId: 'STRING_VALUE' /* required */
};
deadline.batchGetJobEntity(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
farmId
— (String
)The farm ID of the worker that's fetching job details. The worker must have an assignment on a job to fetch job details.
fleetId
— (String
)The fleet ID of the worker that's fetching job details. The worker must have an assignment on a job to fetch job details.
identifiers
— (Array<map>
)The job identifiers to include within the job entity batch details.
environmentDetails
— (map
)The environment details.
environmentId
— required — (String
)The environment ID.
jobId
— required — (String
)The job ID.
jobAttachmentDetails
— (map
)The job attachment details.
jobId
— required — (String
)The job ID.
jobDetails
— (map
)The job details.
jobId
— required — (String
)The job ID.
stepDetails
— (map
)The step details.
jobId
— required — (String
)The job ID.
stepId
— required — (String
)The step ID.
workerId
— (String
)The worker ID of the worker containing the job details to get.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:entities
— (Array<map>
)A list of the job entities, or details, in the batch.
environmentDetails
— (map
)The environment details for the job entity.
environmentId
— required — (String
)The environment ID.
jobId
— required — (String
)The job ID.
schemaVersion
— required — (String
)The schema version in the environment.
template
— required — (map
)The template used for the environment.
jobAttachmentDetails
— (map
)The job attachment details.
attachments
— required — (map
)The job attachments.
fileSystem
— (String
)The file system.
Possible values include:"COPIED"
"VIRTUAL"
manifests
— required — (Array<map>
)A list of manifests which describe job attachment configurations.
fileSystemLocationName
— (String
)The file system location name.
inputManifestHash
— (String
)The has value of the file.
inputManifestPath
— (String
)The file path.
outputRelativeDirectories
— (Array<String>
)The file path relative to the directory.
rootPath
— required — (String
)The file's root path.
rootPathFormat
— required — (String
)The format of the root path.
Possible values include:"windows"
"posix"
jobId
— required — (String
)The job ID.
jobDetails
— (map
)The job details.
jobAttachmentSettings
— (map
)The job attachment settings.
rootPrefix
— required — (String
)The root prefix.
s3BucketName
— required — (String
)The Amazon S3 bucket name.
jobId
— required — (String
)The job ID.
jobRunAsUser
— (map
)The user name and group that the job uses when run.
posix
— (map
)The user and group that the jobs in the queue run as.
group
— required — (String
)The name of the POSIX user's group.
user
— required — (String
)The name of the POSIX user.
runAs
— required — (String
)Specifies whether the job should run using the queue's system user or if the job should run using the worker agent system user.
Possible values include:"QUEUE_CONFIGURED_USER"
"WORKER_AGENT_USER"
windows
— (map
)Identifies a Microsoft Windows user.
passwordArn
— required — (String
)The password ARN for the Windows user.
user
— required — (String
)The user.
logGroupName
— required — (String
)The log group name.
parameters
— (map<map>
)The parameters.
float
— (String
)A double precision IEEE-754 floating point number represented as a string.
int
— (String
)A signed integer represented as a string.
path
— (String
)A file system path represented as a string.
string
— (String
)A UTF-8 string.
pathMappingRules
— (Array<map>
)The path mapping rules.
destinationPath
— required — (String
)The destination path.
sourcePath
— required — (String
)The source path.
sourcePathFormat
— required — (String
)The source path format.
Possible values include:"windows"
"posix"
queueRoleArn
— (String
)The queue role ARN.
schemaVersion
— required — (String
)The schema version.
stepDetails
— (map
)The step details.
dependencies
— required — (Array<String>
)The dependencies for a step.
jobId
— required — (String
)The job ID.
schemaVersion
— required — (String
)The schema version for a step template.
stepId
— required — (String
)The step ID.
template
— required — (map
)The template for a step.
errors
— (Array<map>
)A list of errors from the job error logs for the batch.
environmentDetails
— (map
)The environment details for the failed job entity.
code
— required — (String
)The error code.
Possible values include:"AccessDeniedException"
"InternalServerException"
"ValidationException"
"ResourceNotFoundException"
"MaxPayloadSizeExceeded"
"ConflictException"
environmentId
— required — (String
)The environment ID.
jobId
— required — (String
)The job ID.
message
— required — (String
)The error message detailing the error's cause.
jobAttachmentDetails
— (map
)The job attachment details for the failed job entity.
code
— required — (String
)The error code.
Possible values include:"AccessDeniedException"
"InternalServerException"
"ValidationException"
"ResourceNotFoundException"
"MaxPayloadSizeExceeded"
"ConflictException"
jobId
— required — (String
)The job ID.
message
— required — (String
)The error message detailing the error's cause.
jobDetails
— (map
)The job details for the failed job entity.
code
— required — (String
)The error code.
Possible values include:"AccessDeniedException"
"InternalServerException"
"ValidationException"
"ResourceNotFoundException"
"MaxPayloadSizeExceeded"
"ConflictException"
jobId
— required — (String
)The job ID.
message
— required — (String
)The error message detailing the error's cause.
stepDetails
— (map
)The step details for the failed job entity.
code
— required — (String
)The error code.
Possible values include:"AccessDeniedException"
"InternalServerException"
"ValidationException"
"ResourceNotFoundException"
"MaxPayloadSizeExceeded"
"ConflictException"
jobId
— required — (String
)The job ID.
message
— required — (String
)The error message detailing the error's cause.
stepId
— required — (String
)The step ID.
-
(AWS.Response)
—
Returns:
copyJobTemplate(params = {}, callback) ⇒ AWS.Request
Copies a job template to an Amazon S3 bucket.
Service Reference:
Examples:
Calling the copyJobTemplate operation
var params = {
farmId: 'STRING_VALUE', /* required */
jobId: 'STRING_VALUE', /* required */
queueId: 'STRING_VALUE', /* required */
targetS3Location: { /* required */
bucketName: 'STRING_VALUE', /* required */
key: 'STRING_VALUE' /* required */
}
};
deadline.copyJobTemplate(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
farmId
— (String
)The farm ID to copy.
jobId
— (String
)The job ID to copy.
queueId
— (String
)The queue ID to copy.
targetS3Location
— (map
)The Amazon S3 bucket name and key where you would like to add a copy of the job template.
bucketName
— required — (String
)The name of the Amazon S3 bucket.
key
— required — (String
)The Amazon S3 object key that uniquely identifies the Amazon S3 bucket.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:templateType
— (String
)The format of the job template, either
Possible values include:JSON
orYAML
."JSON"
"YAML"
-
(AWS.Response)
—
Returns:
createBudget(params = {}, callback) ⇒ AWS.Request
Creates a budget to set spending thresholds for your rendering activity.
Service Reference:
Examples:
Calling the createBudget operation
var params = {
actions: [ /* required */
{
thresholdPercentage: 'NUMBER_VALUE', /* required */
type: STOP_SCHEDULING_AND_COMPLETE_TASKS | STOP_SCHEDULING_AND_CANCEL_TASKS, /* required */
description: 'STRING_VALUE'
},
/* more items */
],
approximateDollarLimit: 'NUMBER_VALUE', /* required */
displayName: 'STRING_VALUE', /* required */
farmId: 'STRING_VALUE', /* required */
schedule: { /* required */
fixed: {
endTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, /* required */
startTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789 /* required */
}
},
usageTrackingResource: { /* required */
queueId: 'STRING_VALUE'
},
clientToken: 'STRING_VALUE',
description: 'STRING_VALUE'
};
deadline.createBudget(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
actions
— (Array<map>
)The budget actions to specify what happens when the budget runs out.
description
— (String
)A description for the budget action to add.
thresholdPercentage
— required — (Float
)The percentage threshold for the budget action to add.
type
— required — (String
)The type of budget action to add.
Possible values include:"STOP_SCHEDULING_AND_COMPLETE_TASKS"
"STOP_SCHEDULING_AND_CANCEL_TASKS"
approximateDollarLimit
— (Float
)The dollar limit based on consumed usage.
clientToken
— (String
)The unique token which the server uses to recognize retries of the same request.
If a token is not provided, the SDK will use a version 4 UUID.description
— (String
)The description of the budget.
displayName
— (String
)The display name of the budget.
farmId
— (String
)The farm ID to include in this budget.
schedule
— (map
)The schedule to associate with this budget.
fixed
— (map
)The fixed start and end time of the budget's schedule.
endTime
— required — (Date
)When the budget ends.
startTime
— required — (Date
)When the budget starts.
usageTrackingResource
— (map
)The queue ID provided to this budget to track usage.
queueId
— (String
)The queue ID.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:budgetId
— (String
)The budget ID.
-
(AWS.Response)
—
Returns:
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.
Service Reference:
Examples:
Calling the createFarm operation
var params = {
displayName: 'STRING_VALUE', /* required */
clientToken: 'STRING_VALUE',
description: 'STRING_VALUE',
kmsKeyArn: 'STRING_VALUE',
tags: {
'<String>': 'STRING_VALUE',
/* '<String>': ... */
}
};
deadline.createFarm(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
clientToken
— (String
)The unique token which the server uses to recognize retries of the same request.
If a token is not provided, the SDK will use a version 4 UUID.description
— (String
)The description of the farm.
displayName
— (String
)The display name of the farm.
kmsKeyArn
— (String
)The ARN of the KMS key to use on the farm.
tags
— (map<String>
)The tags to add to your farm. Each tag consists of a tag key and a tag value. Tag keys and values are both required, but tag values can be empty strings.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:farmId
— (String
)The farm ID.
-
(AWS.Response)
—
Returns:
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.
Service Reference:
Examples:
Calling the createFleet operation
var params = {
configuration: { /* required */
customerManaged: {
mode: NO_SCALING | EVENT_BASED_AUTO_SCALING, /* required */
workerCapabilities: { /* required */
cpuArchitectureType: x86_64 | arm64, /* required */
memoryMiB: { /* required */
min: 'NUMBER_VALUE', /* required */
max: 'NUMBER_VALUE'
},
osFamily: WINDOWS | LINUX | MACOS, /* required */
vCpuCount: { /* required */
min: 'NUMBER_VALUE', /* required */
max: 'NUMBER_VALUE'
},
acceleratorCount: {
min: 'NUMBER_VALUE', /* required */
max: 'NUMBER_VALUE'
},
acceleratorTotalMemoryMiB: {
min: 'NUMBER_VALUE', /* required */
max: 'NUMBER_VALUE'
},
acceleratorTypes: [
gpu,
/* more items */
],
customAmounts: [
{
min: 'NUMBER_VALUE', /* required */
name: 'STRING_VALUE', /* required */
max: 'NUMBER_VALUE'
},
/* more items */
],
customAttributes: [
{
name: 'STRING_VALUE', /* required */
values: [ /* required */
'STRING_VALUE',
/* more items */
]
},
/* more items */
]
},
storageProfileId: 'STRING_VALUE'
},
serviceManagedEc2: {
instanceCapabilities: { /* required */
cpuArchitectureType: x86_64 | arm64, /* required */
memoryMiB: { /* required */
min: 'NUMBER_VALUE', /* required */
max: 'NUMBER_VALUE'
},
osFamily: WINDOWS | LINUX, /* required */
vCpuCount: { /* required */
min: 'NUMBER_VALUE', /* required */
max: 'NUMBER_VALUE'
},
allowedInstanceTypes: [
'STRING_VALUE',
/* more items */
],
customAmounts: [
{
min: 'NUMBER_VALUE', /* required */
name: 'STRING_VALUE', /* required */
max: 'NUMBER_VALUE'
},
/* more items */
],
customAttributes: [
{
name: 'STRING_VALUE', /* required */
values: [ /* required */
'STRING_VALUE',
/* more items */
]
},
/* more items */
],
excludedInstanceTypes: [
'STRING_VALUE',
/* more items */
],
rootEbsVolume: {
iops: 'NUMBER_VALUE',
sizeGiB: 'NUMBER_VALUE',
throughputMiB: 'NUMBER_VALUE'
}
},
instanceMarketOptions: { /* required */
type: on-demand | spot /* required */
}
}
},
displayName: 'STRING_VALUE', /* required */
farmId: 'STRING_VALUE', /* required */
maxWorkerCount: 'NUMBER_VALUE', /* required */
roleArn: 'STRING_VALUE', /* required */
clientToken: 'STRING_VALUE',
description: 'STRING_VALUE',
minWorkerCount: 'NUMBER_VALUE',
tags: {
'<String>': 'STRING_VALUE',
/* '<String>': ... */
}
};
deadline.createFleet(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
clientToken
— (String
)The unique token which the server uses to recognize retries of the same request.
If a token is not provided, the SDK will use a version 4 UUID.configuration
— (map
)The configuration settings for the fleet. Customer managed fleets are self-managed. Service managed Amazon EC2 fleets are managed by Deadline Cloud.
customerManaged
— (map
)The customer managed fleets within a fleet configuration.
mode
— required — (String
)The Auto Scaling mode for the customer managed fleet configuration.
Possible values include:"NO_SCALING"
"EVENT_BASED_AUTO_SCALING"
storageProfileId
— (String
)The storage profile ID.
workerCapabilities
— required — (map
)The worker capabilities for a customer managed fleet configuration.
acceleratorCount
— (map
)The range of the accelerator.
max
— (Integer
)The maximum GPU for the accelerator.
min
— required — (Integer
)The minimum GPU for the accelerator.
acceleratorTotalMemoryMiB
— (map
)The total memory (MiB) for the customer managed worker capabilities.
max
— (Integer
)The maximum amount of memory to use for the accelerator, measured in MiB.
min
— required — (Integer
)The minimum amount of memory to use for the accelerator, measured in MiB.
acceleratorTypes
— (Array<String>
)The accelerator types for the customer managed worker capabilities.
cpuArchitectureType
— required — (String
)The CPU architecture type for the customer managed worker capabilities.
Possible values include:"x86_64"
"arm64"
customAmounts
— (Array<map>
)Custom requirement ranges for customer managed worker capabilities.
max
— (Float
)The maximum amount of the fleet worker capability.
min
— required — (Float
)The minimum amount of fleet worker capability.
name
— required — (String
)The name of the fleet capability.
customAttributes
— (Array<map>
)Custom attributes for the customer manged worker capabilities.
name
— required — (String
)The name of the fleet attribute capability for the worker.
values
— required — (Array<String>
)The number of fleet attribute capabilities.
memoryMiB
— required — (map
)The memory (MiB).
max
— (Integer
)The maximum amount of memory (in MiB).
min
— required — (Integer
)The minimum amount of memory (in MiB).
osFamily
— required — (String
)The operating system (OS) family.
Possible values include:"WINDOWS"
"LINUX"
"MACOS"
vCpuCount
— required — (map
)The vCPU count for the customer manged worker capabilities.
max
— (Integer
)The maximum amount of vCPU.
min
— required — (Integer
)The minimum amount of vCPU.
serviceManagedEc2
— (map
)The service managed Amazon EC2 instances for a fleet configuration.
instanceCapabilities
— required — (map
)The Amazon EC2 instance capabilities.
allowedInstanceTypes
— (Array<String>
)The allowable Amazon EC2 instance types.
cpuArchitectureType
— required — (String
)The CPU architecture type.
Possible values include:"x86_64"
"arm64"
customAmounts
— (Array<map>
)The custom capability amounts to require for instances in this fleet.
max
— (Float
)The maximum amount of the fleet worker capability.
min
— required — (Float
)The minimum amount of fleet worker capability.
name
— required — (String
)The name of the fleet capability.
customAttributes
— (Array<map>
)The custom capability attributes to require for instances in this fleet.
name
— required — (String
)The name of the fleet attribute capability for the worker.
values
— required — (Array<String>
)The number of fleet attribute capabilities.
excludedInstanceTypes
— (Array<String>
)The instance types to exclude from the fleet.
memoryMiB
— required — (map
)The memory, as MiB, for the Amazon EC2 instance type.
max
— (Integer
)The maximum amount of memory (in MiB).
min
— required — (Integer
)The minimum amount of memory (in MiB).
osFamily
— required — (String
)The operating system (OS) family.
Possible values include:"WINDOWS"
"LINUX"
rootEbsVolume
— (map
)The root EBS volume.
iops
— (Integer
)The IOPS per volume.
sizeGiB
— (Integer
)The EBS volume size in GiB.
throughputMiB
— (Integer
)The throughput per volume in MiB.
vCpuCount
— required — (map
)The amount of vCPU to require for instances in this fleet.
max
— (Integer
)The maximum amount of vCPU.
min
— required — (Integer
)The minimum amount of vCPU.
instanceMarketOptions
— required — (map
)The Amazon EC2 market type.
type
— required — (String
)The Amazon EC2 instance type.
Possible values include:"on-demand"
"spot"
description
— (String
)The description of the fleet.
displayName
— (String
)The display name of the fleet.
farmId
— (String
)The farm ID of the farm to connect to the fleet.
maxWorkerCount
— (Integer
)The maximum number of workers for the fleet.
minWorkerCount
— (Integer
)The minimum number of workers for the fleet.
roleArn
— (String
)The IAM role ARN for the role that the fleet's workers will use.
tags
— (map<String>
)Each tag consists of a tag key and a tag value. Tag keys and values are both required, but tag values can be empty strings.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:fleetId
— (String
)The fleet ID.
-
(AWS.Response)
—
Returns:
createJob(params = {}, callback) ⇒ AWS.Request
Creates a job. A job is a render submission submitted by a user. It contains specific job properties outlined as steps and tasks.
Service Reference:
Examples:
Calling the createJob operation
var params = {
farmId: 'STRING_VALUE', /* required */
priority: 'NUMBER_VALUE', /* required */
queueId: 'STRING_VALUE', /* required */
template: 'STRING_VALUE', /* required */
templateType: JSON | YAML, /* required */
attachments: {
manifests: [ /* required */
{
rootPath: 'STRING_VALUE', /* required */
rootPathFormat: windows | posix, /* required */
fileSystemLocationName: 'STRING_VALUE',
inputManifestHash: 'STRING_VALUE',
inputManifestPath: 'STRING_VALUE',
outputRelativeDirectories: [
'STRING_VALUE',
/* more items */
]
},
/* more items */
],
fileSystem: COPIED | VIRTUAL
},
clientToken: 'STRING_VALUE',
maxFailedTasksCount: 'NUMBER_VALUE',
maxRetriesPerTask: 'NUMBER_VALUE',
parameters: {
'<String>': {
float: 'STRING_VALUE',
int: 'STRING_VALUE',
path: 'STRING_VALUE',
string: 'STRING_VALUE'
},
/* '<String>': ... */
},
storageProfileId: 'STRING_VALUE',
targetTaskRunStatus: READY | SUSPENDED
};
deadline.createJob(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
attachments
— (map
)The attachments for the job. Attach files required for the job to run to a render job.
fileSystem
— (String
)The file system.
Possible values include:"COPIED"
"VIRTUAL"
manifests
— required — (Array<map>
)A list of manifests which describe job attachment configurations.
fileSystemLocationName
— (String
)The file system location name.
inputManifestHash
— (String
)The has value of the file.
inputManifestPath
— (String
)The file path.
outputRelativeDirectories
— (Array<String>
)The file path relative to the directory.
rootPath
— required — (String
)The file's root path.
rootPathFormat
— required — (String
)The format of the root path.
Possible values include:"windows"
"posix"
clientToken
— (String
)The unique token which the server uses to recognize retries of the same request.
If a token is not provided, the SDK will use a version 4 UUID.farmId
— (String
)The farm ID of the farm to connect to the job.
maxFailedTasksCount
— (Integer
)The number of task failures before the job stops running and is marked as
FAILED
.maxRetriesPerTask
— (Integer
)The maximum number of retries for a job.
parameters
— (map<map>
)The parameters for the job.
float
— (String
)A double precision IEEE-754 floating point number represented as a string.
int
— (String
)A signed integer represented as a string.
path
— (String
)A file system path represented as a string.
string
— (String
)A UTF-8 string.
priority
— (Integer
)The priority of the job on a scale of 1 to 100. The highest priority is 1.
queueId
— (String
)The ID of the queue that the job is submitted to.
storageProfileId
— (String
)The storage profile ID for the storage profile to connect to the job.
targetTaskRunStatus
— (String
)The initial status of the job's tasks when they are created. Tasks that are created with a
Possible values include:SUSPENDED
status will not run until you update their status."READY"
"SUSPENDED"
template
— (String
)The job template to use for this job.
templateType
— (String
)The file type for the job template.
Possible values include:"JSON"
"YAML"
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:jobId
— (String
)The job ID.
-
(AWS.Response)
—
Returns:
createLicenseEndpoint(params = {}, callback) ⇒ AWS.Request
Creates a license endpoint to integrate your various licensed software used for rendering on Deadline Cloud.
Service Reference:
Examples:
Calling the createLicenseEndpoint operation
var params = {
securityGroupIds: [ /* required */
'STRING_VALUE',
/* more items */
],
subnetIds: [ /* required */
'STRING_VALUE',
/* more items */
],
vpcId: 'STRING_VALUE', /* required */
clientToken: 'STRING_VALUE',
tags: {
'<String>': 'STRING_VALUE',
/* '<String>': ... */
}
};
deadline.createLicenseEndpoint(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
clientToken
— (String
)The unique token which the server uses to recognize retries of the same request.
If a token is not provided, the SDK will use a version 4 UUID.securityGroupIds
— (Array<String>
)The security group IDs.
subnetIds
— (Array<String>
)The subnet IDs.
tags
— (map<String>
)Each tag consists of a tag key and a tag value. Tag keys and values are both required, but tag values can be empty strings.
vpcId
— (String
)The VPC (virtual private cloud) ID to use with the license endpoint.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:licenseEndpointId
— (String
)The license endpoint ID.
-
(AWS.Response)
—
Returns:
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.
Service Reference:
Examples:
Calling the createMonitor operation
var params = {
displayName: 'STRING_VALUE', /* required */
identityCenterInstanceArn: 'STRING_VALUE', /* required */
roleArn: 'STRING_VALUE', /* required */
subdomain: 'STRING_VALUE', /* required */
clientToken: 'STRING_VALUE'
};
deadline.createMonitor(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
clientToken
— (String
)The unique token which the server uses to recognize retries of the same request.
If a token is not provided, the SDK will use a version 4 UUID.displayName
— (String
)The name that you give the monitor that is displayed in the Deadline Cloud console.
identityCenterInstanceArn
— (String
)The Amazon Resource Name (ARN) of the IAM Identity Center instance that authenticates monitor users.
roleArn
— (String
)The Amazon Resource Name (ARN) of the IAM role that the monitor uses to connect to Deadline Cloud. Every user that signs in to the monitor using IAM Identity Center uses this role to access Deadline Cloud resources.
subdomain
— (String
)The subdomain to use when creating the monitor URL. The full URL of the monitor is subdomain.Region.deadlinecloud.amazonaws.com.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:identityCenterApplicationArn
— (String
)The Amazon Resource Name (ARN) that IAM Identity Center assigns to the monitor.
monitorId
— (String
)The unique identifier of the monitor.
-
(AWS.Response)
—
Returns:
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.
Service Reference:
Examples:
Calling the createQueue operation
var params = {
displayName: 'STRING_VALUE', /* required */
farmId: 'STRING_VALUE', /* required */
allowedStorageProfileIds: [
'STRING_VALUE',
/* more items */
],
clientToken: 'STRING_VALUE',
defaultBudgetAction: NONE | STOP_SCHEDULING_AND_COMPLETE_TASKS | STOP_SCHEDULING_AND_CANCEL_TASKS,
description: 'STRING_VALUE',
jobAttachmentSettings: {
rootPrefix: 'STRING_VALUE', /* required */
s3BucketName: 'STRING_VALUE' /* required */
},
jobRunAsUser: {
runAs: QUEUE_CONFIGURED_USER | WORKER_AGENT_USER, /* required */
posix: {
group: 'STRING_VALUE', /* required */
user: 'STRING_VALUE' /* required */
},
windows: {
passwordArn: 'STRING_VALUE', /* required */
user: 'STRING_VALUE' /* required */
}
},
requiredFileSystemLocationNames: [
'STRING_VALUE',
/* more items */
],
roleArn: 'STRING_VALUE',
tags: {
'<String>': 'STRING_VALUE',
/* '<String>': ... */
}
};
deadline.createQueue(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
allowedStorageProfileIds
— (Array<String>
)The storage profile IDs to include in the queue.
clientToken
— (String
)The unique token which the server uses to recognize retries of the same request.
If a token is not provided, the SDK will use a version 4 UUID.defaultBudgetAction
— (String
)The default action to take on a queue if a budget isn't configured.
Possible values include:"NONE"
"STOP_SCHEDULING_AND_COMPLETE_TASKS"
"STOP_SCHEDULING_AND_CANCEL_TASKS"
description
— (String
)The description of the queue.
displayName
— (String
)The display name of the queue.
farmId
— (String
)The farm ID of the farm to connect to the queue.
jobAttachmentSettings
— (map
)The job attachment settings for the queue. These are the Amazon S3 bucket name and the Amazon S3 prefix.
rootPrefix
— required — (String
)The root prefix.
s3BucketName
— required — (String
)The Amazon S3 bucket name.
jobRunAsUser
— (map
)The jobs in the queue run as the specified POSIX user.
posix
— (map
)The user and group that the jobs in the queue run as.
group
— required — (String
)The name of the POSIX user's group.
user
— required — (String
)The name of the POSIX user.
runAs
— required — (String
)Specifies whether the job should run using the queue's system user or if the job should run using the worker agent system user.
Possible values include:"QUEUE_CONFIGURED_USER"
"WORKER_AGENT_USER"
windows
— (map
)Identifies a Microsoft Windows user.
passwordArn
— required — (String
)The password ARN for the Windows user.
user
— required — (String
)The user.
requiredFileSystemLocationNames
— (Array<String>
)The file system location name to include in the queue.
roleArn
— (String
)The IAM role ARN that workers will use while running jobs for this queue.
tags
— (map<String>
)Each tag consists of a tag key and a tag value. Tag keys and values are both required, but tag values can be empty strings.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:queueId
— (String
)The queue ID.
-
(AWS.Response)
—
Returns:
createQueueEnvironment(params = {}, callback) ⇒ AWS.Request
Creates an environment for a queue that defines how jobs in the queue run.
Service Reference:
Examples:
Calling the createQueueEnvironment operation
var params = {
farmId: 'STRING_VALUE', /* required */
priority: 'NUMBER_VALUE', /* required */
queueId: 'STRING_VALUE', /* required */
template: 'STRING_VALUE', /* required */
templateType: JSON | YAML, /* required */
clientToken: 'STRING_VALUE'
};
deadline.createQueueEnvironment(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
clientToken
— (String
)The unique token which the server uses to recognize retries of the same request.
If a token is not provided, the SDK will use a version 4 UUID.farmId
— (String
)The farm ID of the farm to connect to the environment.
priority
— (Integer
)Sets the priority of the environments in the queue from 0 to 10,000, where 0 is the highest priority. If two environments share the same priority value, the environment created first takes higher priority.
queueId
— (String
)The queue ID to connect the queue and environment.
template
— (String
)The environment template to use in the queue.
templateType
— (String
)The template's file type,
Possible values include:JSON
orYAML
."JSON"
"YAML"
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:queueEnvironmentId
— (String
)The queue environment ID.
-
(AWS.Response)
—
Returns:
createQueueFleetAssociation(params = {}, callback) ⇒ AWS.Request
Creates an association between a queue and a fleet.
Service Reference:
Examples:
Calling the createQueueFleetAssociation operation
var params = {
farmId: 'STRING_VALUE', /* required */
fleetId: 'STRING_VALUE', /* required */
queueId: 'STRING_VALUE' /* required */
};
deadline.createQueueFleetAssociation(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
farmId
— (String
)The ID of the farm that the queue and fleet belong to.
fleetId
— (String
)The fleet ID.
queueId
— (String
)The queue ID.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs.
-
(AWS.Response)
—
Returns:
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.
Service Reference:
Examples:
Calling the createStorageProfile operation
var params = {
displayName: 'STRING_VALUE', /* required */
farmId: 'STRING_VALUE', /* required */
osFamily: WINDOWS | LINUX | MACOS, /* required */
clientToken: 'STRING_VALUE',
fileSystemLocations: [
{
name: 'STRING_VALUE', /* required */
path: 'STRING_VALUE', /* required */
type: SHARED | LOCAL /* required */
},
/* more items */
]
};
deadline.createStorageProfile(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
clientToken
— (String
)The unique token which the server uses to recognize retries of the same request.
If a token is not provided, the SDK will use a version 4 UUID.displayName
— (String
)The display name of the storage profile.
farmId
— (String
)The farm ID of the farm to connect to the storage profile.
fileSystemLocations
— (Array<map>
)File system paths to include in the storage profile.
name
— required — (String
)The location name.
path
— required — (String
)The file path.
type
— required — (String
)The type of file.
Possible values include:"SHARED"
"LOCAL"
osFamily
— (String
)The type of operating system (OS) for the storage profile.
Possible values include:"WINDOWS"
"LINUX"
"MACOS"
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:storageProfileId
— (String
)The storage profile ID.
-
(AWS.Response)
—
Returns:
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.
Service Reference:
Examples:
Calling the createWorker operation
var params = {
farmId: 'STRING_VALUE', /* required */
fleetId: 'STRING_VALUE', /* required */
clientToken: 'STRING_VALUE',
hostProperties: {
hostName: 'STRING_VALUE',
ipAddresses: {
ipV4Addresses: [
'STRING_VALUE',
/* more items */
],
ipV6Addresses: [
'STRING_VALUE',
/* more items */
]
}
}
};
deadline.createWorker(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
clientToken
— (String
)The unique token which the server uses to recognize retries of the same request.
If a token is not provided, the SDK will use a version 4 UUID.farmId
— (String
)The farm ID of the farm to connect to the worker.
fleetId
— (String
)The fleet ID to connect to the worker.
hostProperties
— (map
)The IP address and host name of the worker.
hostName
— (String
)The host name.
ipAddresses
— (map
)The IP address of the host.
ipV4Addresses
— (Array<String>
)The IpV4 address of the network.
ipV6Addresses
— (Array<String>
)The IpV6 address for the network and node component.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:workerId
— (String
)The worker ID.
-
(AWS.Response)
—
Returns:
deleteBudget(params = {}, callback) ⇒ AWS.Request
Deletes a budget.
Service Reference:
Examples:
Calling the deleteBudget operation
var params = {
budgetId: 'STRING_VALUE', /* required */
farmId: 'STRING_VALUE' /* required */
};
deadline.deleteBudget(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
budgetId
— (String
)The budget ID of the budget to delete.
farmId
— (String
)The farm ID of the farm to remove from the budget.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs.
-
(AWS.Response)
—
Returns:
deleteFarm(params = {}, callback) ⇒ AWS.Request
Deletes a farm.
Service Reference:
Examples:
Calling the deleteFarm operation
var params = {
farmId: 'STRING_VALUE' /* required */
};
deadline.deleteFarm(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
farmId
— (String
)The farm ID of the farm to delete.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs.
-
(AWS.Response)
—
Returns:
deleteFleet(params = {}, callback) ⇒ AWS.Request
Deletes a fleet.
Service Reference:
Examples:
Calling the deleteFleet operation
var params = {
farmId: 'STRING_VALUE', /* required */
fleetId: 'STRING_VALUE', /* required */
clientToken: 'STRING_VALUE'
};
deadline.deleteFleet(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
clientToken
— (String
)The unique token which the server uses to recognize retries of the same request.
If a token is not provided, the SDK will use a version 4 UUID.farmId
— (String
)The farm ID of the farm to remove from the fleet.
fleetId
— (String
)The fleet ID of the fleet to delete.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs.
-
(AWS.Response)
—
Returns:
deleteLicenseEndpoint(params = {}, callback) ⇒ AWS.Request
Deletes a license endpoint.
Service Reference:
Examples:
Calling the deleteLicenseEndpoint operation
var params = {
licenseEndpointId: 'STRING_VALUE' /* required */
};
deadline.deleteLicenseEndpoint(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
licenseEndpointId
— (String
)The license endpoint ID of the license endpoint to delete.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs.
-
(AWS.Response)
—
Returns:
deleteMeteredProduct(params = {}, callback) ⇒ AWS.Request
Deletes a metered product.
Service Reference:
Examples:
Calling the deleteMeteredProduct operation
var params = {
licenseEndpointId: 'STRING_VALUE', /* required */
productId: 'STRING_VALUE' /* required */
};
deadline.deleteMeteredProduct(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
licenseEndpointId
— (String
)The ID of the license endpoint from which to remove the metered product.
productId
— (String
)The product ID to remove from the license endpoint.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs.
-
(AWS.Response)
—
Returns:
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.
Service Reference:
Examples:
Calling the deleteMonitor operation
var params = {
monitorId: 'STRING_VALUE' /* required */
};
deadline.deleteMonitor(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
monitorId
— (String
)The unique identifier of the monitor to delete. This ID is returned by the
CreateMonitor
operation, and is included in the response to theGetMonitor
operation.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs.
-
(AWS.Response)
—
Returns:
deleteQueue(params = {}, callback) ⇒ AWS.Request
Deletes a queue.
Service Reference:
Examples:
Calling the deleteQueue operation
var params = {
farmId: 'STRING_VALUE', /* required */
queueId: 'STRING_VALUE' /* required */
};
deadline.deleteQueue(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
farmId
— (String
)The ID of the farm from which to remove the queue.
queueId
— (String
)The queue ID of the queue to delete.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs.
-
(AWS.Response)
—
Returns:
deleteQueueEnvironment(params = {}, callback) ⇒ AWS.Request
Deletes a queue environment.
Service Reference:
Examples:
Calling the deleteQueueEnvironment operation
var params = {
farmId: 'STRING_VALUE', /* required */
queueEnvironmentId: 'STRING_VALUE', /* required */
queueId: 'STRING_VALUE' /* required */
};
deadline.deleteQueueEnvironment(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
farmId
— (String
)The farm ID of the farm from which to remove the queue environment.
queueEnvironmentId
— (String
)The queue environment ID of the queue environment to delete.
queueId
— (String
)The queue ID of the queue environment to delete.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs.
-
(AWS.Response)
—
Returns:
deleteQueueFleetAssociation(params = {}, callback) ⇒ AWS.Request
Deletes a queue-fleet association.
Service Reference:
Examples:
Calling the deleteQueueFleetAssociation operation
var params = {
farmId: 'STRING_VALUE', /* required */
fleetId: 'STRING_VALUE', /* required */
queueId: 'STRING_VALUE' /* required */
};
deadline.deleteQueueFleetAssociation(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
farmId
— (String
)The farm ID of the farm that holds the queue-fleet association.
fleetId
— (String
)The fleet ID of the queue-fleet association.
queueId
— (String
)The queue ID of the queue-fleet association.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs.
-
(AWS.Response)
—
Returns:
deleteStorageProfile(params = {}, callback) ⇒ AWS.Request
Deletes a storage profile.
Service Reference:
Examples:
Calling the deleteStorageProfile operation
var params = {
farmId: 'STRING_VALUE', /* required */
storageProfileId: 'STRING_VALUE' /* required */
};
deadline.deleteStorageProfile(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
farmId
— (String
)The farm ID of the farm from which to remove the storage profile.
storageProfileId
— (String
)The storage profile ID of the storage profile to delete.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs.
-
(AWS.Response)
—
Returns:
deleteWorker(params = {}, callback) ⇒ AWS.Request
Deletes a worker.
Service Reference:
Examples:
Calling the deleteWorker operation
var params = {
farmId: 'STRING_VALUE', /* required */
fleetId: 'STRING_VALUE', /* required */
workerId: 'STRING_VALUE' /* required */
};
deadline.deleteWorker(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
farmId
— (String
)The farm ID of the worker to delete.
fleetId
— (String
)The fleet ID of the worker to delete.
workerId
— (String
)The worker ID of the worker to delete.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs.
-
(AWS.Response)
—
Returns:
disassociateMemberFromFarm(params = {}, callback) ⇒ AWS.Request
Disassociates a member from a farm.
Service Reference:
Examples:
Calling the disassociateMemberFromFarm operation
var params = {
farmId: 'STRING_VALUE', /* required */
principalId: 'STRING_VALUE' /* required */
};
deadline.disassociateMemberFromFarm(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
farmId
— (String
)The farm ID of the farm to disassociate from the member.
principalId
— (String
)A member's principal ID to disassociate from a farm.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs.
-
(AWS.Response)
—
Returns:
disassociateMemberFromFleet(params = {}, callback) ⇒ AWS.Request
Disassociates a member from a fleet.
Service Reference:
Examples:
Calling the disassociateMemberFromFleet operation
var params = {
farmId: 'STRING_VALUE', /* required */
fleetId: 'STRING_VALUE', /* required */
principalId: 'STRING_VALUE' /* required */
};
deadline.disassociateMemberFromFleet(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
farmId
— (String
)The farm ID of the fleet to disassociate a member from.
fleetId
— (String
)The fleet ID of the fleet to from which to disassociate a member.
principalId
— (String
)A member's principal ID to disassociate from a fleet.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs.
-
(AWS.Response)
—
Returns:
disassociateMemberFromJob(params = {}, callback) ⇒ AWS.Request
Disassociates a member from a job.
Service Reference:
Examples:
Calling the disassociateMemberFromJob operation
var params = {
farmId: 'STRING_VALUE', /* required */
jobId: 'STRING_VALUE', /* required */
principalId: 'STRING_VALUE', /* required */
queueId: 'STRING_VALUE' /* required */
};
deadline.disassociateMemberFromJob(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
farmId
— (String
)The farm ID for the job to disassociate from the member.
jobId
— (String
)The job ID to disassociate from a member in a job.
principalId
— (String
)A member's principal ID to disassociate from a job.
queueId
— (String
)The queue ID connected to a job for which you're disassociating a member.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs.
-
(AWS.Response)
—
Returns:
disassociateMemberFromQueue(params = {}, callback) ⇒ AWS.Request
Disassociates a member from a queue.
Service Reference:
Examples:
Calling the disassociateMemberFromQueue operation
var params = {
farmId: 'STRING_VALUE', /* required */
principalId: 'STRING_VALUE', /* required */
queueId: 'STRING_VALUE' /* required */
};
deadline.disassociateMemberFromQueue(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
farmId
— (String
)The farm ID for the queue to disassociate from a member.
principalId
— (String
)A member's principal ID to disassociate from a queue.
queueId
— (String
)The queue ID of the queue in which you're disassociating from a member.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs.
-
(AWS.Response)
—
Returns:
getBudget(params = {}, callback) ⇒ AWS.Request
Get a budget.
Service Reference:
Examples:
Calling the getBudget operation
var params = {
budgetId: 'STRING_VALUE', /* required */
farmId: 'STRING_VALUE' /* required */
};
deadline.getBudget(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
budgetId
— (String
)The budget ID.
farmId
— (String
)The farm ID of the farm connected to the budget.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:actions
— (Array<map>
)The budget actions for the budget.
description
— (String
)The budget action description.
thresholdPercentage
— required — (Float
)The percentage threshold for the budget.
type
— required — (String
)The action taken on the budget once scheduling stops.
Possible values include:"STOP_SCHEDULING_AND_COMPLETE_TASKS"
"STOP_SCHEDULING_AND_CANCEL_TASKS"
approximateDollarLimit
— (Float
)The consumed usage limit for the budget.
budgetId
— (String
)The budget ID.
createdAt
— (Date
)The date and time the resource was created.
createdBy
— (String
)The user or system that created this resource.
description
— (String
)The description of the budget.
displayName
— (String
)The display name of the budget.
queueStoppedAt
— (Date
)The date and time the queue stopped.
schedule
— (map
)The budget schedule.
fixed
— (map
)The fixed start and end time of the budget's schedule.
endTime
— required — (Date
)When the budget ends.
startTime
— required — (Date
)When the budget starts.
status
— (String
)The status of the budget.
-
ACTIVE
–Get a budget being evaluated. -
INACTIVE
–Get an inactive budget. This can include expired, canceled, or deleted statuses.
"ACTIVE"
"INACTIVE"
-
updatedAt
— (Date
)The date and time the resource was updated.
updatedBy
— (String
)The user or system that updated this resource.
usageTrackingResource
— (map
)The resource that the budget is tracking usage for.
queueId
— (String
)The queue ID.
usages
— (map
)The usages of the budget.
approximateDollarUsage
— required — (Float
)The amount of the budget consumed.
-
(AWS.Response)
—
Returns:
getFarm(params = {}, callback) ⇒ AWS.Request
Get a farm.
Service Reference:
Examples:
Calling the getFarm operation
var params = {
farmId: 'STRING_VALUE' /* required */
};
deadline.getFarm(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
farmId
— (String
)The farm ID of the farm.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:createdAt
— (Date
)The date and time the resource was created.
createdBy
— (String
)The user or system that created this resource.
description
— (String
)The description of the farm.
displayName
— (String
)The display name of the farm.
farmId
— (String
)The farm ID of the farm to get.
kmsKeyArn
— (String
)The ARN of the KMS key used on the farm.
updatedAt
— (Date
)The date and time the resource was updated.
updatedBy
— (String
)The user or system that updated this resource.
-
(AWS.Response)
—
Returns:
getFleet(params = {}, callback) ⇒ AWS.Request
Get a fleet.
Service Reference:
Examples:
Calling the getFleet operation
var params = {
farmId: 'STRING_VALUE', /* required */
fleetId: 'STRING_VALUE' /* required */
};
deadline.getFleet(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
farmId
— (String
)The farm ID of the farm in the fleet.
fleetId
— (String
)The fleet ID of the fleet to get.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:autoScalingStatus
— (String
)The Auto Scaling status of the fleet. Either
Possible values include:GROWING
,STEADY
, orSHRINKING
."GROWING"
"STEADY"
"SHRINKING"
capabilities
— (map
)Outlines what the fleet is capable of for minimums, maximums, and naming, in addition to attribute names and values.
amounts
— (Array<map>
)Amount capabilities of the fleet.
max
— (Float
)The maximum amount of the fleet worker capability.
min
— required — (Float
)The minimum amount of fleet worker capability.
name
— required — (String
)The name of the fleet capability.
attributes
— (Array<map>
)Attribute capabilities of the fleet.
name
— required — (String
)The name of the fleet attribute capability for the worker.
values
— required — (Array<String>
)The number of fleet attribute capabilities.
configuration
— (map
)The configuration setting for the fleet.
customerManaged
— (map
)The customer managed fleets within a fleet configuration.
mode
— required — (String
)The Auto Scaling mode for the customer managed fleet configuration.
Possible values include:"NO_SCALING"
"EVENT_BASED_AUTO_SCALING"
storageProfileId
— (String
)The storage profile ID.
workerCapabilities
— required — (map
)The worker capabilities for a customer managed fleet configuration.
acceleratorCount
— (map
)The range of the accelerator.
max
— (Integer
)The maximum GPU for the accelerator.
min
— required — (Integer
)The minimum GPU for the accelerator.
acceleratorTotalMemoryMiB
— (map
)The total memory (MiB) for the customer managed worker capabilities.
max
— (Integer
)The maximum amount of memory to use for the accelerator, measured in MiB.
min
— required — (Integer
)The minimum amount of memory to use for the accelerator, measured in MiB.
acceleratorTypes
— (Array<String>
)The accelerator types for the customer managed worker capabilities.
cpuArchitectureType
— required — (String
)The CPU architecture type for the customer managed worker capabilities.
Possible values include:"x86_64"
"arm64"
customAmounts
— (Array<map>
)Custom requirement ranges for customer managed worker capabilities.
max
— (Float
)The maximum amount of the fleet worker capability.
min
— required — (Float
)The minimum amount of fleet worker capability.
name
— required — (String
)The name of the fleet capability.
customAttributes
— (Array<map>
)Custom attributes for the customer manged worker capabilities.
name
— required — (String
)The name of the fleet attribute capability for the worker.
values
— required — (Array<String>
)The number of fleet attribute capabilities.
memoryMiB
— required — (map
)The memory (MiB).
max
— (Integer
)The maximum amount of memory (in MiB).
min
— required — (Integer
)The minimum amount of memory (in MiB).
osFamily
— required — (String
)The operating system (OS) family.
Possible values include:"WINDOWS"
"LINUX"
"MACOS"
vCpuCount
— required — (map
)The vCPU count for the customer manged worker capabilities.
max
— (Integer
)The maximum amount of vCPU.
min
— required — (Integer
)The minimum amount of vCPU.
serviceManagedEc2
— (map
)The service managed Amazon EC2 instances for a fleet configuration.
instanceCapabilities
— required — (map
)The Amazon EC2 instance capabilities.
allowedInstanceTypes
— (Array<String>
)The allowable Amazon EC2 instance types.
cpuArchitectureType
— required — (String
)The CPU architecture type.
Possible values include:"x86_64"
"arm64"
customAmounts
— (Array<map>
)The custom capability amounts to require for instances in this fleet.
max
— (Float
)The maximum amount of the fleet worker capability.
min
— required — (Float
)The minimum amount of fleet worker capability.
name
— required — (String
)The name of the fleet capability.
customAttributes
— (Array<map>
)The custom capability attributes to require for instances in this fleet.
name
— required — (String
)The name of the fleet attribute capability for the worker.
values
— required — (Array<String>
)The number of fleet attribute capabilities.
excludedInstanceTypes
— (Array<String>
)The instance types to exclude from the fleet.
memoryMiB
— required — (map
)The memory, as MiB, for the Amazon EC2 instance type.
max
— (Integer
)The maximum amount of memory (in MiB).
min
— required — (Integer
)The minimum amount of memory (in MiB).
osFamily
— required — (String
)The operating system (OS) family.
Possible values include:"WINDOWS"
"LINUX"
rootEbsVolume
— (map
)The root EBS volume.
iops
— (Integer
)The IOPS per volume.
sizeGiB
— (Integer
)The EBS volume size in GiB.
throughputMiB
— (Integer
)The throughput per volume in MiB.
vCpuCount
— required — (map
)The amount of vCPU to require for instances in this fleet.
max
— (Integer
)The maximum amount of vCPU.
min
— required — (Integer
)The minimum amount of vCPU.
instanceMarketOptions
— required — (map
)The Amazon EC2 market type.
type
— required — (String
)The Amazon EC2 instance type.
Possible values include:"on-demand"
"spot"
createdAt
— (Date
)The date and time the resource was created.
createdBy
— (String
)The user or system that created this resource.
description
— (String
)The description of the fleet.
displayName
— (String
)The display name of the fleet.
farmId
— (String
)The farm ID of the farm in the fleet.
fleetId
— (String
)The fleet ID.
maxWorkerCount
— (Integer
)The maximum number of workers specified in the fleet.
minWorkerCount
— (Integer
)The minimum number of workers specified in the fleet.
roleArn
— (String
)The IAM role ARN.
status
— (String
)The Auto Scaling status of the fleet.
Possible values include:"ACTIVE"
"CREATE_IN_PROGRESS"
"UPDATE_IN_PROGRESS"
"CREATE_FAILED"
"UPDATE_FAILED"
targetWorkerCount
— (Integer
)The number of target workers in the fleet.
updatedAt
— (Date
)The date and time the resource was updated.
updatedBy
— (String
)The user or system that updated this resource.
workerCount
— (Integer
)The number of workers in the fleet.
-
(AWS.Response)
—
Returns:
Waiter Resource States:
getJob(params = {}, callback) ⇒ AWS.Request
Gets a Deadline Cloud job.
Service Reference:
Examples:
Calling the getJob operation
var params = {
farmId: 'STRING_VALUE', /* required */
jobId: 'STRING_VALUE', /* required */
queueId: 'STRING_VALUE' /* required */
};
deadline.getJob(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
farmId
— (String
)The farm ID of the farm in the job.
jobId
— (String
)The job ID.
queueId
— (String
)The queue ID associated with the job.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:attachments
— (map
)The attachments for the job.
fileSystem
— (String
)The file system.
Possible values include:"COPIED"
"VIRTUAL"
manifests
— required — (Array<map>
)A list of manifests which describe job attachment configurations.
fileSystemLocationName
— (String
)The file system location name.
inputManifestHash
— (String
)The has value of the file.
inputManifestPath
— (String
)The file path.
outputRelativeDirectories
— (Array<String>
)The file path relative to the directory.
rootPath
— required — (String
)The file's root path.
rootPathFormat
— required — (String
)The format of the root path.
Possible values include:"windows"
"posix"
createdAt
— (Date
)The date and time the resource was created.
createdBy
— (String
)The user or system that created this resource.
description
— (String
)The description of the job.
endedAt
— (Date
)The date and time the resource ended running.
jobId
— (String
)The job ID.
lifecycleStatus
— (String
)The life cycle status for the job.
Possible values include:"CREATE_IN_PROGRESS"
"CREATE_FAILED"
"CREATE_COMPLETE"
"UPLOAD_IN_PROGRESS"
"UPLOAD_FAILED"
"UPDATE_IN_PROGRESS"
"UPDATE_FAILED"
"UPDATE_SUCCEEDED"
"ARCHIVED"
lifecycleStatusMessage
— (String
)A message that communicates the status of the life cycle for the job.
maxFailedTasksCount
— (Integer
)The number of task failures before the job stops running and is marked as
FAILED
.maxRetriesPerTask
— (Integer
)The maximum number of retries per failed tasks.
name
— (String
)The name of the job.
parameters
— (map<map>
)The parameters for the job.
float
— (String
)A double precision IEEE-754 floating point number represented as a string.
int
— (String
)A signed integer represented as a string.
path
— (String
)A file system path represented as a string.
string
— (String
)A UTF-8 string.
priority
— (Integer
)The job priority.
startedAt
— (Date
)The date and time the resource started running.
storageProfileId
— (String
)The storage profile ID associated with the job.
targetTaskRunStatus
— (String
)The task status with which the job started.
Possible values include:"READY"
"FAILED"
"SUCCEEDED"
"CANCELED"
"SUSPENDED"
"PENDING"
taskRunStatus
— (String
)The task run status for the job.
Possible values include:"PENDING"
"READY"
"ASSIGNED"
"STARTING"
"SCHEDULED"
"INTERRUPTING"
"RUNNING"
"SUSPENDED"
"CANCELED"
"FAILED"
"SUCCEEDED"
"NOT_COMPATIBLE"
taskRunStatusCounts
— (map<Integer>
)The number of tasks running on the job.
updatedAt
— (Date
)The date and time the resource was updated.
updatedBy
— (String
)The user or system that updated this resource.
-
(AWS.Response)
—
Returns:
Waiter Resource States:
getLicenseEndpoint(params = {}, callback) ⇒ AWS.Request
Gets a licence endpoint.
Service Reference:
Examples:
Calling the getLicenseEndpoint operation
var params = {
licenseEndpointId: 'STRING_VALUE' /* required */
};
deadline.getLicenseEndpoint(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
licenseEndpointId
— (String
)The license endpoint ID.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:dnsName
— (String
)The DNS name.
licenseEndpointId
— (String
)The license endpoint ID.
securityGroupIds
— (Array<String>
)The security group IDs for the license endpoint.
status
— (String
)The status of the license endpoint.
Possible values include:"CREATE_IN_PROGRESS"
"DELETE_IN_PROGRESS"
"READY"
"NOT_READY"
statusMessage
— (String
)The status message of the license endpoint.
subnetIds
— (Array<String>
)The subnet IDs.
vpcId
— (String
)The VCP(virtual private cloud) ID associated with the license endpoint.
-
(AWS.Response)
—
Returns:
Waiter Resource States:
getMonitor(params = {}, callback) ⇒ AWS.Request
Gets information about the specified monitor.
Service Reference:
Examples:
Calling the getMonitor operation
var params = {
monitorId: 'STRING_VALUE' /* required */
};
deadline.getMonitor(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
monitorId
— (String
)The unique identifier for the monitor. This ID is returned by the
CreateMonitor
operation.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:createdAt
— (Date
)The UNIX timestamp of the date and time that the monitor was created.
createdBy
— (String
)The user name of the person that created the monitor.
displayName
— (String
)The name used to identify the monitor on the Deadline Cloud console.
identityCenterApplicationArn
— (String
)The Amazon Resource Name (ARN) that the IAM Identity Center assigned to the monitor when it was created.
identityCenterInstanceArn
— (String
)The Amazon Resource Name (ARN) of the IAM Identity Center instance responsible for authenticating monitor users.
monitorId
— (String
)The unique identifier for the monitor.
roleArn
— (String
)The Amazon Resource Name (ARN) of the IAM role for the monitor. Users of the monitor use this role to access Deadline Cloud resources.
subdomain
— (String
)The subdomain used for the monitor URL. The full URL of the monitor is subdomain.Region.deadlinecloud.amazonaws.com.
updatedAt
— (Date
)The UNIX timestamp of the last date and time that the monitor was updated.
updatedBy
— (String
)The user name of the person that last updated the monitor.
url
— (String
)The complete URL of the monitor. The full URL of the monitor is subdomain.Region.deadlinecloud.amazonaws.com.
-
(AWS.Response)
—
Returns:
getQueue(params = {}, callback) ⇒ AWS.Request
Gets a queue.
Service Reference:
Examples:
Calling the getQueue operation
var params = {
farmId: 'STRING_VALUE', /* required */
queueId: 'STRING_VALUE' /* required */
};
deadline.getQueue(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
farmId
— (String
)The farm ID of the farm in the queue.
queueId
— (String
)The queue ID for the queue to retrieve.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:allowedStorageProfileIds
— (Array<String>
)The storage profile IDs for the queue.
blockedReason
— (String
)The reason the queue was blocked.
Possible values include:"NO_BUDGET_CONFIGURED"
"BUDGET_THRESHOLD_REACHED"
createdAt
— (Date
)The date and time the resource was created.
createdBy
— (String
)The user or system that created this resource.
defaultBudgetAction
— (String
)The default action taken on a queue if a budget wasn't configured.
Possible values include:"NONE"
"STOP_SCHEDULING_AND_COMPLETE_TASKS"
"STOP_SCHEDULING_AND_CANCEL_TASKS"
description
— (String
)The description of the queue.
displayName
— (String
)The display name of the queue.
farmId
— (String
)The farm ID for the queue.
jobAttachmentSettings
— (map
)The job attachment settings for the queue.
rootPrefix
— required — (String
)The root prefix.
s3BucketName
— required — (String
)The Amazon S3 bucket name.
jobRunAsUser
— (map
)The jobs in the queue ran as this specified POSIX user.
posix
— (map
)The user and group that the jobs in the queue run as.
group
— required — (String
)The name of the POSIX user's group.
user
— required — (String
)The name of the POSIX user.
runAs
— required — (String
)Specifies whether the job should run using the queue's system user or if the job should run using the worker agent system user.
Possible values include:"QUEUE_CONFIGURED_USER"
"WORKER_AGENT_USER"
windows
— (map
)Identifies a Microsoft Windows user.
passwordArn
— required — (String
)The password ARN for the Windows user.
user
— required — (String
)The user.
queueId
— (String
)The queue ID.
requiredFileSystemLocationNames
— (Array<String>
)A list of the required file system location names in the queue.
roleArn
— (String
)The IAM role ARN.
status
— (String
)The status of the queue.
-
ACTIVE
–The queue is active. -
SCHEDULING
–The queue is scheduling. -
SCHEDULING_BLOCKED
–The queue scheduling is blocked. See the provided reason.
"IDLE"
"SCHEDULING"
"SCHEDULING_BLOCKED"
-
updatedAt
— (Date
)The date and time the resource was updated.
updatedBy
— (String
)The user or system that updated this resource.
-
(AWS.Response)
—
Returns:
Waiter Resource States:
getQueueEnvironment(params = {}, callback) ⇒ AWS.Request
Gets a queue environment.
Service Reference:
Examples:
Calling the getQueueEnvironment operation
var params = {
farmId: 'STRING_VALUE', /* required */
queueEnvironmentId: 'STRING_VALUE', /* required */
queueId: 'STRING_VALUE' /* required */
};
deadline.getQueueEnvironment(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
farmId
— (String
)The farm ID for the queue environment.
queueEnvironmentId
— (String
)The queue environment ID.
queueId
— (String
)The queue ID for the queue environment.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:createdAt
— (Date
)The date and time the resource was created.
createdBy
— (String
)The user or system that created this resource.>
name
— (String
)The name of the queue environment.
priority
— (Integer
)The priority of the queue environment.
queueEnvironmentId
— (String
)The queue environment ID.
template
— (String
)The template for the queue environment.
templateType
— (String
)The type of template for the queue environment.
Possible values include:"JSON"
"YAML"
updatedAt
— (Date
)The date and time the resource was updated.
updatedBy
— (String
)The user or system that updated this resource.
-
(AWS.Response)
—
Returns:
getQueueFleetAssociation(params = {}, callback) ⇒ AWS.Request
Gets a queue-fleet association.
Service Reference:
Examples:
Calling the getQueueFleetAssociation operation
var params = {
farmId: 'STRING_VALUE', /* required */
fleetId: 'STRING_VALUE', /* required */
queueId: 'STRING_VALUE' /* required */
};
deadline.getQueueFleetAssociation(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
farmId
— (String
)The farm ID of the farm that contains the queue-fleet association.
fleetId
— (String
)The fleet ID for the queue-fleet association.
queueId
— (String
)The queue ID for the queue-fleet association.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:createdAt
— (Date
)The date and time the resource was created.
createdBy
— (String
)The user or system that created this resource.
fleetId
— (String
)The fleet ID for the queue-fleet association.
queueId
— (String
)The queue ID for the queue-fleet association.
status
— (String
)The status of the queue-fleet association.
Possible values include:"ACTIVE"
"STOP_SCHEDULING_AND_COMPLETE_TASKS"
"STOP_SCHEDULING_AND_CANCEL_TASKS"
"STOPPED"
updatedAt
— (Date
)The date and time the resource was updated.
updatedBy
— (String
)The user or system that updated this resource.
-
(AWS.Response)
—
Returns:
Waiter Resource States:
getSession(params = {}, callback) ⇒ AWS.Request
Gets a session.
Service Reference:
Examples:
Calling the getSession operation
var params = {
farmId: 'STRING_VALUE', /* required */
jobId: 'STRING_VALUE', /* required */
queueId: 'STRING_VALUE', /* required */
sessionId: 'STRING_VALUE' /* required */
};
deadline.getSession(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
farmId
— (String
)The farm ID for the session.
jobId
— (String
)The job ID for the session.
queueId
— (String
)The queue ID for the session.
sessionId
— (String
)The session ID.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:endedAt
— (Date
)The date and time the resource ended running.
fleetId
— (String
)The fleet ID for the session.
hostProperties
— (map
)Provides the Amazon EC2 properties of the host.
ec2InstanceArn
— (String
)The ARN of the host EC2 instance.
ec2InstanceType
— (String
)The instance type of the host EC2 instance.
hostName
— (String
)The host name.
ipAddresses
— (map
)The IP address of the host.
ipV4Addresses
— (Array<String>
)The IpV4 address of the network.
ipV6Addresses
— (Array<String>
)The IpV6 address for the network and node component.
lifecycleStatus
— (String
)The life cycle status of the session.
Possible values include:"STARTED"
"UPDATE_IN_PROGRESS"
"UPDATE_SUCCEEDED"
"UPDATE_FAILED"
"ENDED"
log
— (map
)The session log.
error
— (String
)The log configuration error details.
logDriver
— required — (String
)The log drivers for worker related logs.
options
— (map<String>
)The options for a log driver.
parameters
— (map<String>
)The parameters for the log configuration.
sessionId
— (String
)The session ID.
startedAt
— (Date
)The date and time the resource started running.
targetLifecycleStatus
— (String
)The life cycle status with which the session started.
Possible values include:"ENDED"
updatedAt
— (Date
)The date and time the resource was updated.
updatedBy
— (String
)The user or system that updated this resource.
workerId
— (String
)The worker ID for the session.
workerLog
— (map
)The worker log for the session.
error
— (String
)The log configuration error details.
logDriver
— required — (String
)The log drivers for worker related logs.
options
— (map<String>
)The options for a log driver.
parameters
— (map<String>
)The parameters for the log configuration.
-
(AWS.Response)
—
Returns:
getSessionAction(params = {}, callback) ⇒ AWS.Request
Gets a session action for the job.
Service Reference:
Examples:
Calling the getSessionAction operation
var params = {
farmId: 'STRING_VALUE', /* required */
jobId: 'STRING_VALUE', /* required */
queueId: 'STRING_VALUE', /* required */
sessionActionId: 'STRING_VALUE' /* required */
};
deadline.getSessionAction(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
farmId
— (String
)The farm ID for the session action.
jobId
— (String
)The job ID for the session.
queueId
— (String
)The queue ID for the session action.
sessionActionId
— (String
)The session action ID for the session.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:definition
— (map
)The session action definition.
envEnter
— (map
)The environment to enter into.
environmentId
— required — (String
)The environment ID.
envExit
— (map
)The environment to exit from.
environmentId
— required — (String
)The environment ID.
syncInputJobAttachments
— (map
)The job attachments to sync with a session action.
stepId
— (String
)The step ID for the step in the job attachment.
taskRun
— (map
)The task run in the session.
parameters
— required — (map<map>
)The task parameters.
float
— (String
)A double precision IEEE-754 floating point number represented as a string.
int
— (String
)A signed integer represented as a string.
path
— (String
)A file system path represented as a string.
string
— (String
)A UTF-8 string.
stepId
— required — (String
)The step ID.
taskId
— required — (String
)The task ID.
endedAt
— (Date
)The date and time the resource ended running.
processExitCode
— (Integer
)The exit code to exit the session.
progressMessage
— (String
)The message that communicates the progress of the session action.
progressPercent
— (Float
)The percentage completed for a session action.
sessionActionId
— (String
)The session action ID.
sessionId
— (String
)The session ID for the session action.
startedAt
— (Date
)The date and time the resource started running.
status
— (String
)The status of the session action.
Possible values include:"ASSIGNED"
"RUNNING"
"CANCELING"
"SUCCEEDED"
"FAILED"
"INTERRUPTED"
"CANCELED"
"NEVER_ATTEMPTED"
"SCHEDULED"
"RECLAIMING"
"RECLAIMED"
workerUpdatedAt
— (Date
)The Linux timestamp of the date and time the session action was last updated.
-
(AWS.Response)
—
Returns:
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.
Service Reference:
Examples:
Calling the getSessionsStatisticsAggregation operation
var params = {
aggregationId: 'STRING_VALUE', /* required */
farmId: 'STRING_VALUE', /* required */
maxResults: 'NUMBER_VALUE',
nextToken: 'STRING_VALUE'
};
deadline.getSessionsStatisticsAggregation(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
aggregationId
— (String
)The identifier returned by the
StartSessionsStatisticsAggregation
operation that identifies the aggregated statistics.farmId
— (String
)The identifier of the farm to include in the statistics. This should be the same as the farm ID used in the call to the
StartSessionsStatisticsAggregation
operation.maxResults
— (Integer
)The maximum number of results to return. Use this parameter with
NextToken
to get results as a set of sequential pages.nextToken
— (String
)The token for the next set of results, or
null
to start from the beginning.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:nextToken
— (String
)If Deadline Cloud returns
nextToken
, then there are more results available. The value ofnextToken
is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, thennextToken
is set tonull
. Each pagination token expires after 24 hours. If you provide a token that isn't valid, then you receive an HTTP 400ValidationException
error.statistics
— (Array<map>
)The statistics for the specified fleets or queues.
aggregationEndTime
— (Date
)The end time for the aggregation.
aggregationStartTime
— (Date
)The start time for the aggregation.
costInUsd
— required — (map
)How the statistics should appear in USD. Options include: minimum, maximum, average or sum.
avg
— (Float
)The average of the usage statistics.
max
— (Float
)The maximum among the usage statistics.
min
— (Float
)The minimum of the usage statistics.
sum
— (Float
)The sum of the usage statistics.
count
— required — (Integer
)The number of instances in a list of statistics.
fleetId
— (String
)The fleet ID.
instanceType
— (String
)The type of instance.
jobId
— (String
)The job ID.
jobName
— (String
)The job name.
licenseProduct
— (String
)The licensed product.
queueId
— (String
)The queue ID.
runtimeInSeconds
— required — (map
)The total aggregated runtime.
avg
— (Float
)The average of the usage statistics.
max
— (Float
)The maximum among the usage statistics.
min
— (Float
)The minimum of the usage statistics.
sum
— (Float
)The sum of the usage statistics.
usageType
— (String
)The type of usage for the statistics.
Possible values include:"COMPUTE"
"LICENSE"
userId
— (String
)The user ID.
status
— (String
)The status of the aggregated results.
Possible values include:"IN_PROGRESS"
"TIMEOUT"
"FAILED"
"COMPLETED"
statusMessage
— (String
)A message that describes the status.
-
(AWS.Response)
—
Returns:
getStep(params = {}, callback) ⇒ AWS.Request
Gets a step.
Service Reference:
Examples:
Calling the getStep operation
var params = {
farmId: 'STRING_VALUE', /* required */
jobId: 'STRING_VALUE', /* required */
queueId: 'STRING_VALUE', /* required */
stepId: 'STRING_VALUE' /* required */
};
deadline.getStep(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
farmId
— (String
)The farm ID for the step.
jobId
— (String
)The job ID for the step.
queueId
— (String
)The queue ID for the step.
stepId
— (String
)The step ID.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:createdAt
— (Date
)The date and time the resource was created.
createdBy
— (String
)The user or system that created this resource.
dependencyCounts
— (map
)The number of dependencies in the step.
consumersResolved
— required — (Integer
)The number of consumers resolved.
consumersUnresolved
— required — (Integer
)The number of unresolved consumers.
dependenciesResolved
— required — (Integer
)The number of resolved dependencies.
dependenciesUnresolved
— required — (Integer
)The number of unresolved dependencies.
description
— (String
)The description of the step.
endedAt
— (Date
)The date and time the resource ended running.
lifecycleStatus
— (String
)The life cycle status of the step.
Possible values include:"CREATE_COMPLETE"
"UPDATE_IN_PROGRESS"
"UPDATE_FAILED"
"UPDATE_SUCCEEDED"
lifecycleStatusMessage
— (String
)A message that describes the lifecycle status of the step.
name
— (String
)The name of the step.
parameterSpace
— (map
)A list of step parameters and the combination expression for the step.
combination
— (String
)The combination expression to use in the search.
parameters
— required — (Array<map>
)The parameters to search for.
name
— required — (String
)The name of the parameter.
type
— required — (String
)The data type of the parameter.
Possible values include:"INT"
"FLOAT"
"STRING"
"PATH"
requiredCapabilities
— (map
)The required capabilities of the step.
amounts
— required — (Array<map>
)The capability amounts that the step requires.
max
— (Float
)The maximum amount.
min
— (Float
)The minimum amount.
name
— required — (String
)The name of the step.
value
— (Float
)The amount value.
attributes
— required — (Array<map>
)The capability attributes that the step requires.
allOf
— (Array<String>
)Requires all of the step attribute values.
anyOf
— (Array<String>
)Requires any of the step attributes in a given list.
name
— required — (String
)The name of the step attribute.
startedAt
— (Date
)The date and time the resource started running.
stepId
— (String
)The step ID.
targetTaskRunStatus
— (String
)The task status with which the job started.
Possible values include:"READY"
"FAILED"
"SUCCEEDED"
"CANCELED"
"SUSPENDED"
"PENDING"
taskRunStatus
— (String
)The task run status for the job.
Possible values include:"PENDING"
"READY"
"ASSIGNED"
"STARTING"
"SCHEDULED"
"INTERRUPTING"
"RUNNING"
"SUSPENDED"
"CANCELED"
"FAILED"
"SUCCEEDED"
"NOT_COMPATIBLE"
taskRunStatusCounts
— (map<Integer>
)The number of tasks running on the job.
updatedAt
— (Date
)The date and time the resource was updated.
updatedBy
— (String
)The user or system that updated this resource.
-
(AWS.Response)
—
Returns:
getStorageProfile(params = {}, callback) ⇒ AWS.Request
Gets a storage profile.
Service Reference:
Examples:
Calling the getStorageProfile operation
var params = {
farmId: 'STRING_VALUE', /* required */
storageProfileId: 'STRING_VALUE' /* required */
};
deadline.getStorageProfile(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
farmId
— (String
)The farm ID for the storage profile.
storageProfileId
— (String
)The storage profile ID.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:createdAt
— (Date
)The date and time the resource was created.
createdBy
— (String
)The user or system that created this resource.
displayName
— (String
)The display name of the storage profile.
fileSystemLocations
— (Array<map>
)The location of the files for the storage profile.
name
— required — (String
)The location name.
path
— required — (String
)The file path.
type
— required — (String
)The type of file.
Possible values include:"SHARED"
"LOCAL"
osFamily
— (String
)The operating system (OS) for the storage profile.
Possible values include:"WINDOWS"
"LINUX"
"MACOS"
storageProfileId
— (String
)The storage profile ID.
updatedAt
— (Date
)The date and time the resource was updated.
updatedBy
— (String
)The user or system that updated this resource.
-
(AWS.Response)
—
Returns:
getStorageProfileForQueue(params = {}, callback) ⇒ AWS.Request
Gets a storage profile for a queue.
Service Reference:
Examples:
Calling the getStorageProfileForQueue operation
var params = {
farmId: 'STRING_VALUE', /* required */
queueId: 'STRING_VALUE', /* required */
storageProfileId: 'STRING_VALUE' /* required */
};
deadline.getStorageProfileForQueue(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
farmId
— (String
)The farm ID for the queue in storage profile.
queueId
— (String
)The queue ID the queue in the storage profile.
storageProfileId
— (String
)The storage profile ID for the storage profile in the queue.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:displayName
— (String
)The display name of the storage profile connected to a queue.
fileSystemLocations
— (Array<map>
)The location of the files for the storage profile within the queue.
name
— required — (String
)The location name.
path
— required — (String
)The file path.
type
— required — (String
)The type of file.
Possible values include:"SHARED"
"LOCAL"
osFamily
— (String
)The operating system of the storage profile in the queue.
Possible values include:"WINDOWS"
"LINUX"
"MACOS"
storageProfileId
— (String
)The storage profile ID.
-
(AWS.Response)
—
Returns:
getTask(params = {}, callback) ⇒ AWS.Request
Gets a task.
Service Reference:
Examples:
Calling the getTask operation
var params = {
farmId: 'STRING_VALUE', /* required */
jobId: 'STRING_VALUE', /* required */
queueId: 'STRING_VALUE', /* required */
stepId: 'STRING_VALUE', /* required */
taskId: 'STRING_VALUE' /* required */
};
deadline.getTask(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
farmId
— (String
)The farm ID of the farm connected to the task.
jobId
— (String
)The job ID of the job connected to the task.
queueId
— (String
)The queue ID for the queue connected to the task.
stepId
— (String
)The step ID for the step connected to the task.
taskId
— (String
)The task ID.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:createdAt
— (Date
)The date and time the resource was created.
createdBy
— (String
)The user or system that created this resource.
endedAt
— (Date
)The date and time the resource ended running.
failureRetryCount
— (Integer
)The number of times that the task failed and was retried.
latestSessionActionId
— (String
)The latest session ID for the task.
parameters
— (map<map>
)The parameters for the task.
float
— (String
)A double precision IEEE-754 floating point number represented as a string.
int
— (String
)A signed integer represented as a string.
path
— (String
)A file system path represented as a string.
string
— (String
)A UTF-8 string.
runStatus
— (String
)The run status for the task.
Possible values include:"PENDING"
"READY"
"ASSIGNED"
"STARTING"
"SCHEDULED"
"INTERRUPTING"
"RUNNING"
"SUSPENDED"
"CANCELED"
"FAILED"
"SUCCEEDED"
"NOT_COMPATIBLE"
startedAt
— (Date
)The date and time the resource started running.
targetRunStatus
— (String
)The run status with which to start the task.
Possible values include:"READY"
"FAILED"
"SUCCEEDED"
"CANCELED"
"SUSPENDED"
"PENDING"
taskId
— (String
)The task ID.
updatedAt
— (Date
)The date and time the resource was updated.
updatedBy
— (String
)The user or system that updated this resource.
-
(AWS.Response)
—
Returns:
getWorker(params = {}, callback) ⇒ AWS.Request
Gets a worker.
Service Reference:
Examples:
Calling the getWorker operation
var params = {
farmId: 'STRING_VALUE', /* required */
fleetId: 'STRING_VALUE', /* required */
workerId: 'STRING_VALUE' /* required */
};
deadline.getWorker(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
farmId
— (String
)The farm ID for the worker.
fleetId
— (String
)The fleet ID of the worker.
workerId
— (String
)The worker ID.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:createdAt
— (Date
)The date and time the resource was created.
createdBy
— (String
)The user or system that created this resource.
farmId
— (String
)The farm ID.
fleetId
— (String
)The fleet ID.
hostProperties
— (map
)The host properties for the worker.
ec2InstanceArn
— (String
)The ARN of the host EC2 instance.
ec2InstanceType
— (String
)The instance type of the host EC2 instance.
hostName
— (String
)The host name.
ipAddresses
— (map
)The IP address of the host.
ipV4Addresses
— (Array<String>
)The IpV4 address of the network.
ipV6Addresses
— (Array<String>
)The IpV6 address for the network and node component.
log
— (map
)The logs for the associated worker.
error
— (String
)The log configuration error details.
logDriver
— required — (String
)The log drivers for worker related logs.
options
— (map<String>
)The options for a log driver.
parameters
— (map<String>
)The parameters for the log configuration.
status
— (String
)The status of the worker.
Possible values include:"CREATED"
"STARTED"
"STOPPING"
"STOPPED"
"NOT_RESPONDING"
"NOT_COMPATIBLE"
"RUNNING"
"IDLE"
updatedAt
— (Date
)The date and time the resource was updated.
updatedBy
— (String
)The user or system that updated this resource.
workerId
— (String
)The worker ID.
-
(AWS.Response)
—
Returns:
listAvailableMeteredProducts(params = {}, callback) ⇒ AWS.Request
A list of the available metered products.
Service Reference:
Examples:
Calling the listAvailableMeteredProducts operation
var params = {
maxResults: 'NUMBER_VALUE',
nextToken: 'STRING_VALUE'
};
deadline.listAvailableMeteredProducts(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
maxResults
— (Integer
)The maximum number of results to return. Use this parameter with
NextToken
to get results as a set of sequential pages.nextToken
— (String
)The token for the next set of results, or
null
to start from the beginning.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:meteredProducts
— (Array<map>
)The metered products.
family
— required — (String
)The family to which the metered product belongs.
port
— required — (Integer
)The port on which the metered product should run.
productId
— required — (String
)The product ID.
vendor
— required — (String
)The vendor.
nextToken
— (String
)If Deadline Cloud returns
nextToken
, then there are more results available. The value ofnextToken
is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, thennextToken
is set tonull
. Each pagination token expires after 24 hours. If you provide a token that isn't valid, then you receive an HTTP 400ValidationException
error.
-
(AWS.Response)
—
Returns:
listBudgets(params = {}, callback) ⇒ AWS.Request
A list of budgets in a farm.
Service Reference:
Examples:
Calling the listBudgets operation
var params = {
farmId: 'STRING_VALUE', /* required */
maxResults: 'NUMBER_VALUE',
nextToken: 'STRING_VALUE',
status: ACTIVE | INACTIVE
};
deadline.listBudgets(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
farmId
— (String
)The farm ID associated with the budgets.
maxResults
— (Integer
)The maximum number of results to return. Use this parameter with
NextToken
to get results as a set of sequential pages.nextToken
— (String
)The token for the next set of results, or
null
to start from the beginning.status
— (String
)The status to list for the budgets.
Possible values include:"ACTIVE"
"INACTIVE"
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:budgets
— (Array<map>
)The budgets to include on the list.
approximateDollarLimit
— required — (Float
)The approximate dollar limit of the budget.
budgetId
— required — (String
)The budget ID.
createdAt
— required — (Date
)The date and time the resource was created.
createdBy
— required — (String
)The user or system that created this resource.
description
— (String
)The description of the budget summary.
displayName
— required — (String
)The display name of the budget summary to update.
status
— required — (String
)The status of the budget.
-
ACTIVE
–The budget is being evaluated. -
INACTIVE
–The budget is inactive. This can include Expired, Canceled, or deleted Deleted statuses.
"ACTIVE"
"INACTIVE"
-
updatedAt
— (Date
)The date and time the resource was updated.
updatedBy
— (String
)The user or system that updated this resource.
usageTrackingResource
— required — (map
)The resource used to track expenditure in the budget.
queueId
— (String
)The queue ID.
usages
— required — (map
)The consumed usage for the budget.
approximateDollarUsage
— required — (Float
)The amount of the budget consumed.
nextToken
— (String
)If Deadline Cloud returns
nextToken
, then there are more results available. The value ofnextToken
is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, thennextToken
is set tonull
. Each pagination token expires after 24 hours. If you provide a token that isn't valid, then you receive an HTTP 400ValidationException
error.
-
(AWS.Response)
—
Returns:
listFarmMembers(params = {}, callback) ⇒ AWS.Request
Lists the members of a farm.
Service Reference:
Examples:
Calling the listFarmMembers operation
var params = {
farmId: 'STRING_VALUE', /* required */
maxResults: 'NUMBER_VALUE',
nextToken: 'STRING_VALUE'
};
deadline.listFarmMembers(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
farmId
— (String
)The farm ID.
maxResults
— (Integer
)The maximum number of results to return. Use this parameter with
NextToken
to get results as a set of sequential pages.nextToken
— (String
)The token for the next set of results, or
null
to start from the beginning.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:members
— (Array<map>
)The members on the list.
farmId
— required — (String
)The farm ID of the farm member.
identityStoreId
— required — (String
)The identity store ID of the farm member.
membershipLevel
— required — (String
)The farm member's membership level.
Possible values include:"VIEWER"
"CONTRIBUTOR"
"OWNER"
"MANAGER"
principalId
— required — (String
)The principal ID of the farm member.
principalType
— required — (String
)The principal type of the farm member.
Possible values include:"USER"
"GROUP"
nextToken
— (String
)If Deadline Cloud returns
nextToken
, then there are more results available. The value ofnextToken
is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, thennextToken
is set tonull
. Each pagination token expires after 24 hours. If you provide a token that isn't valid, then you receive an HTTP 400ValidationException
error.
-
(AWS.Response)
—
Returns:
listFarms(params = {}, callback) ⇒ AWS.Request
Lists farms.
Service Reference:
Examples:
Calling the listFarms operation
var params = {
maxResults: 'NUMBER_VALUE',
nextToken: 'STRING_VALUE',
principalId: 'STRING_VALUE'
};
deadline.listFarms(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
maxResults
— (Integer
)The maximum number of results to return. Use this parameter with
NextToken
to get results as a set of sequential pages.nextToken
— (String
)The token for the next set of results, or
null
to start from the beginning.principalId
— (String
)The principal ID of the member to list on the farm.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:farms
— (Array<map>
)Farms on the list.
createdAt
— required — (Date
)The date and time the resource was created.
createdBy
— required — (String
)The user or system that created this resource.
displayName
— required — (String
)The display name of the farm.
farmId
— required — (String
)The farm ID.
kmsKeyArn
— (String
)The ARN for the KMS key.
updatedAt
— (Date
)The date and time the resource was updated.
updatedBy
— (String
)The user or system that updated this resource.
nextToken
— (String
)If Deadline Cloud returns
nextToken
, then there are more results available. The value ofnextToken
is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, thennextToken
is set tonull
. Each pagination token expires after 24 hours. If you provide a token that isn't valid, then you receive an HTTP 400ValidationException
error.
-
(AWS.Response)
—
Returns:
listFleetMembers(params = {}, callback) ⇒ AWS.Request
Lists fleet members.
Service Reference:
Examples:
Calling the listFleetMembers operation
var params = {
farmId: 'STRING_VALUE', /* required */
fleetId: 'STRING_VALUE', /* required */
maxResults: 'NUMBER_VALUE',
nextToken: 'STRING_VALUE'
};
deadline.listFleetMembers(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
farmId
— (String
)The farm ID of the fleet.
fleetId
— (String
)The fleet ID to include on the list.
maxResults
— (Integer
)The maximum number of results to return. Use this parameter with
NextToken
to get results as a set of sequential pages.nextToken
— (String
)The token for the next set of results, or
null
to start from the beginning.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:members
— (Array<map>
)The members on the list.
farmId
— required — (String
)The farm ID.
fleetId
— required — (String
)The fleet ID.
identityStoreId
— required — (String
)The identity store ID.
membershipLevel
— required — (String
)The fleet member's membership level.
Possible values include:"VIEWER"
"CONTRIBUTOR"
"OWNER"
"MANAGER"
principalId
— required — (String
)The principal ID of the fleet member.
principalType
— required — (String
)The principal type of the fleet member.
Possible values include:"USER"
"GROUP"
nextToken
— (String
)If Deadline Cloud returns
nextToken
, then there are more results available. The value ofnextToken
is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, thennextToken
is set tonull
. Each pagination token expires after 24 hours. If you provide a token that isn't valid, then you receive an HTTP 400ValidationException
error.
-
(AWS.Response)
—
Returns:
listFleets(params = {}, callback) ⇒ AWS.Request
Lists fleets.
Service Reference:
Examples:
Calling the listFleets operation
var params = {
farmId: 'STRING_VALUE', /* required */
displayName: 'STRING_VALUE',
maxResults: 'NUMBER_VALUE',
nextToken: 'STRING_VALUE',
principalId: 'STRING_VALUE',
status: ACTIVE | CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | CREATE_FAILED | UPDATE_FAILED
};
deadline.listFleets(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
displayName
— (String
)The display names of a list of fleets.
farmId
— (String
)The farm ID of the fleets.
maxResults
— (Integer
)The maximum number of results to return. Use this parameter with
NextToken
to get results as a set of sequential pages.nextToken
— (String
)The token for the next set of results, or
null
to start from the beginning.principalId
— (String
)The principal ID of the members to include in the fleet.
status
— (String
)The status of the fleet.
Possible values include:"ACTIVE"
"CREATE_IN_PROGRESS"
"UPDATE_IN_PROGRESS"
"CREATE_FAILED"
"UPDATE_FAILED"
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:fleets
— (Array<map>
)The fleets on the list.
autoScalingStatus
— (String
)The Auto Scaling status of a fleet.
Possible values include:"GROWING"
"STEADY"
"SHRINKING"
configuration
— required — (map
)The configuration details for the fleet.
customerManaged
— (map
)The customer managed fleets within a fleet configuration.
mode
— required — (String
)The Auto Scaling mode for the customer managed fleet configuration.
Possible values include:"NO_SCALING"
"EVENT_BASED_AUTO_SCALING"
storageProfileId
— (String
)The storage profile ID.
workerCapabilities
— required — (map
)The worker capabilities for a customer managed fleet configuration.
acceleratorCount
— (map
)The range of the accelerator.
max
— (Integer
)The maximum GPU for the accelerator.
min
— required — (Integer
)The minimum GPU for the accelerator.
acceleratorTotalMemoryMiB
— (map
)The total memory (MiB) for the customer managed worker capabilities.
max
— (Integer
)The maximum amount of memory to use for the accelerator, measured in MiB.
min
— required — (Integer
)The minimum amount of memory to use for the accelerator, measured in MiB.
acceleratorTypes
— (Array<String>
)The accelerator types for the customer managed worker capabilities.
cpuArchitectureType
— required — (String
)The CPU architecture type for the customer managed worker capabilities.
Possible values include:"x86_64"
"arm64"
customAmounts
— (Array<map>
)Custom requirement ranges for customer managed worker capabilities.
max
— (Float
)The maximum amount of the fleet worker capability.
min
— required — (Float
)The minimum amount of fleet worker capability.
name
— required — (String
)The name of the fleet capability.
customAttributes
— (Array<map>
)Custom attributes for the customer manged worker capabilities.
name
— required — (String
)The name of the fleet attribute capability for the worker.
values
— required — (Array<String>
)The number of fleet attribute capabilities.
memoryMiB
— required — (map
)The memory (MiB).
max
— (Integer
)The maximum amount of memory (in MiB).
min
— required — (Integer
)The minimum amount of memory (in MiB).
osFamily
— required — (String
)The operating system (OS) family.
Possible values include:"WINDOWS"
"LINUX"
"MACOS"
vCpuCount
— required — (map
)The vCPU count for the customer manged worker capabilities.
max
— (Integer
)The maximum amount of vCPU.
min
— required — (Integer
)The minimum amount of vCPU.
serviceManagedEc2
— (map
)The service managed Amazon EC2 instances for a fleet configuration.
instanceCapabilities
— required — (map
)The Amazon EC2 instance capabilities.
allowedInstanceTypes
— (Array<String>
)The allowable Amazon EC2 instance types.
cpuArchitectureType
— required — (String
)The CPU architecture type.
Possible values include:"x86_64"
"arm64"
customAmounts
— (Array<map>
)The custom capability amounts to require for instances in this fleet.
max
— (Float
)The maximum amount of the fleet worker capability.
min
— required — (Float
)The minimum amount of fleet worker capability.
name
— required — (String
)The name of the fleet capability.
customAttributes
— (Array<map>
)The custom capability attributes to require for instances in this fleet.
name
— required — (String
)The name of the fleet attribute capability for the worker.
values
— required — (Array<String>
)The number of fleet attribute capabilities.
excludedInstanceTypes
— (Array<String>
)The instance types to exclude from the fleet.
memoryMiB
— required — (map
)The memory, as MiB, for the Amazon EC2 instance type.
max
— (Integer
)The maximum amount of memory (in MiB).
min
— required — (Integer
)The minimum amount of memory (in MiB).
osFamily
— required — (String
)The operating system (OS) family.
Possible values include:"WINDOWS"
"LINUX"
rootEbsVolume
— (map
)The root EBS volume.
iops
— (Integer
)The IOPS per volume.
sizeGiB
— (Integer
)The EBS volume size in GiB.
throughputMiB
— (Integer
)The throughput per volume in MiB.
vCpuCount
— required — (map
)The amount of vCPU to require for instances in this fleet.
max
— (Integer
)The maximum amount of vCPU.
min
— required — (Integer
)The minimum amount of vCPU.
instanceMarketOptions
— required — (map
)The Amazon EC2 market type.
type
— required — (String
)The Amazon EC2 instance type.
Possible values include:"on-demand"
"spot"
createdAt
— required — (Date
)The date and time the resource was created.
createdBy
— required — (String
)The user or system that created this resource.
displayName
— required — (String
)The display name of the fleet summary to update.
farmId
— required — (String
)The farm ID.
fleetId
— required — (String
)The fleet ID.
maxWorkerCount
— required — (Integer
)The maximum number of workers specified in the fleet.
minWorkerCount
— required — (Integer
)The minimum number of workers in the fleet.
status
— required — (String
)The status of the fleet.
Possible values include:"ACTIVE"
"CREATE_IN_PROGRESS"
"UPDATE_IN_PROGRESS"
"CREATE_FAILED"
"UPDATE_FAILED"
targetWorkerCount
— (Integer
)The target number of workers in a fleet.
updatedAt
— (Date
)The date and time the resource was updated.
updatedBy
— (String
)The user or system that updated this resource.
workerCount
— required — (Integer
)The number of workers in the fleet summary.
nextToken
— (String
)If Deadline Cloud returns
nextToken
, then there are more results available. The value ofnextToken
is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, thennextToken
is set tonull
. Each pagination token expires after 24 hours. If you provide a token that isn't valid, then you receive an HTTP 400ValidationException
error.
-
(AWS.Response)
—
Returns:
listJobMembers(params = {}, callback) ⇒ AWS.Request
Lists members on a job.
Service Reference:
Examples:
Calling the listJobMembers operation
var params = {
farmId: 'STRING_VALUE', /* required */
jobId: 'STRING_VALUE', /* required */
queueId: 'STRING_VALUE', /* required */
maxResults: 'NUMBER_VALUE',
nextToken: 'STRING_VALUE'
};
deadline.listJobMembers(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
farmId
— (String
)The farm ID of the job to list.
jobId
— (String
)The job ID to include on the list.
maxResults
— (Integer
)The maximum number of results to return. Use this parameter with
NextToken
to get results as a set of sequential pages.nextToken
— (String
)The token for the next set of results, or
null
to start from the beginning.queueId
— (String
)The queue ID to include on the list.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:members
— (Array<map>
)The members on the list.
farmId
— required — (String
)The farm ID.
identityStoreId
— required — (String
)The identity store ID.
jobId
— required — (String
)The job ID.
membershipLevel
— required — (String
)The job member's membership level.
Possible values include:"VIEWER"
"CONTRIBUTOR"
"OWNER"
"MANAGER"
principalId
— required — (String
)The principal ID of the job member.
principalType
— required — (String
)The principal type of the job member.
Possible values include:"USER"
"GROUP"
queueId
— required — (String
)The queue ID.
nextToken
— (String
)If Deadline Cloud returns
nextToken
, then there are more results available. The value ofnextToken
is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, thennextToken
is set tonull
. Each pagination token expires after 24 hours. If you provide a token that isn't valid, then you receive an HTTP 400ValidationException
error.
-
(AWS.Response)
—
Returns:
listJobs(params = {}, callback) ⇒ AWS.Request
Lists jobs.
Service Reference:
Examples:
Calling the listJobs operation
var params = {
farmId: 'STRING_VALUE', /* required */
queueId: 'STRING_VALUE', /* required */
maxResults: 'NUMBER_VALUE',
nextToken: 'STRING_VALUE',
principalId: 'STRING_VALUE'
};
deadline.listJobs(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
farmId
— (String
)The farm ID for the jobs.
maxResults
— (Integer
)The maximum number of results to return. Use this parameter with
NextToken
to get results as a set of sequential pages.nextToken
— (String
)The token for the next set of results, or
null
to start from the beginning.principalId
— (String
)The principal ID of the members on the jobs.
queueId
— (String
)The queue ID for the job.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:jobs
— (Array<map>
)The jobs on the list.
createdAt
— required — (Date
)The date and time the resource was created.
createdBy
— required — (String
)The user or system that created this resource.
endedAt
— (Date
)The date and time the resource ended running.
jobId
— required — (String
)The job ID.
lifecycleStatus
— required — (String
)The life cycle status.
Possible values include:"CREATE_IN_PROGRESS"
"CREATE_FAILED"
"CREATE_COMPLETE"
"UPLOAD_IN_PROGRESS"
"UPLOAD_FAILED"
"UPDATE_IN_PROGRESS"
"UPDATE_FAILED"
"UPDATE_SUCCEEDED"
"ARCHIVED"
lifecycleStatusMessage
— required — (String
)The life cycle status message.
maxFailedTasksCount
— (Integer
)The number of task failures before the job stops running and is marked as
FAILED
.maxRetriesPerTask
— (Integer
)The maximum number of retries for a job.
name
— required — (String
)The job name.
priority
— required — (Integer
)The job priority.
startedAt
— (Date
)The date and time the resource started running.
targetTaskRunStatus
— (String
)The task status to start with on the job.
Possible values include:"READY"
"FAILED"
"SUCCEEDED"
"CANCELED"
"SUSPENDED"
"PENDING"
taskRunStatus
— (String
)The task run status for the job.
-
PENDING
–pending and waiting for resources. -
READY
–ready to be processed. -
ASSIGNED
–assigned and will run next on a worker. -
SCHEDULED
–scheduled to be run on a worker. -
INTERRUPTING
–being interrupted. -
RUNNING
–running on a worker. -
SUSPENDED
–the task is suspended. -
CANCELED
–the task has been canceled. -
FAILED
–the task has failed. -
SUCCEEDED
–the task has succeeded.
"PENDING"
"READY"
"ASSIGNED"
"STARTING"
"SCHEDULED"
"INTERRUPTING"
"RUNNING"
"SUSPENDED"
"CANCELED"
"FAILED"
"SUCCEEDED"
"NOT_COMPATIBLE"
-
taskRunStatusCounts
— (map<Integer>
)The number of tasks running on the job.
updatedAt
— (Date
)The date and time the resource was updated.
updatedBy
— (String
)The user or system that updated this resource.
nextToken
— (String
)If Deadline Cloud returns
nextToken
, then there are more results available. The value ofnextToken
is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, thennextToken
is set tonull
. Each pagination token expires after 24 hours. If you provide a token that isn't valid, then you receive an HTTP 400ValidationException
error.
-
(AWS.Response)
—
Returns:
listLicenseEndpoints(params = {}, callback) ⇒ AWS.Request
Lists license endpoints.
Service Reference:
Examples:
Calling the listLicenseEndpoints operation
var params = {
maxResults: 'NUMBER_VALUE',
nextToken: 'STRING_VALUE'
};
deadline.listLicenseEndpoints(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
maxResults
— (Integer
)The maximum number of results to return. Use this parameter with
NextToken
to get results as a set of sequential pages.nextToken
— (String
)The token for the next set of results, or
null
to start from the beginning.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:licenseEndpoints
— (Array<map>
)The license endpoints.
licenseEndpointId
— (String
)The license endpoint ID.
status
— (String
)The status of the license endpoint.
Possible values include:"CREATE_IN_PROGRESS"
"DELETE_IN_PROGRESS"
"READY"
"NOT_READY"
statusMessage
— (String
)The status message of the license endpoint.
vpcId
— (String
)The VCP(virtual private cloud) ID associated with the license endpoint.
nextToken
— (String
)If Deadline Cloud returns
nextToken
, then there are more results available. The value ofnextToken
is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, thennextToken
is set tonull
. Each pagination token expires after 24 hours. If you provide a token that isn't valid, then you receive an HTTP 400ValidationException
error.
-
(AWS.Response)
—
Returns:
listMeteredProducts(params = {}, callback) ⇒ AWS.Request
Lists metered products.
Service Reference:
Examples:
Calling the listMeteredProducts operation
var params = {
licenseEndpointId: 'STRING_VALUE', /* required */
maxResults: 'NUMBER_VALUE',
nextToken: 'STRING_VALUE'
};
deadline.listMeteredProducts(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
licenseEndpointId
— (String
)The license endpoint ID to include on the list of metered products.
maxResults
— (Integer
)The maximum number of results to return. Use this parameter with
NextToken
to get results as a set of sequential pages.nextToken
— (String
)The token for the next set of results, or
null
to start from the beginning.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:meteredProducts
— (Array<map>
)The metered products to list.
family
— required — (String
)The family to which the metered product belongs.
port
— required — (Integer
)The port on which the metered product should run.
productId
— required — (String
)The product ID.
vendor
— required — (String
)The vendor.
nextToken
— (String
)If Deadline Cloud returns
nextToken
, then there are more results available. The value ofnextToken
is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, thennextToken
is set tonull
. Each pagination token expires after 24 hours. If you provide a token that isn't valid, then you receive an HTTP 400ValidationException
error.
-
(AWS.Response)
—
Returns:
listMonitors(params = {}, callback) ⇒ AWS.Request
Gets a list of your monitors in Deadline Cloud.
Service Reference:
Examples:
Calling the listMonitors operation
var params = {
maxResults: 'NUMBER_VALUE',
nextToken: 'STRING_VALUE'
};
deadline.listMonitors(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
maxResults
— (Integer
)The maximum number of results to return. Use this parameter with
NextToken
to get results as a set of sequential pages.nextToken
— (String
)The token for the next set of results, or
null
to start from the beginning.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:monitors
— (Array<map>
)A list of
MonitorSummary
objects that describe your monitors in the Deadline Cloud.createdAt
— required — (Date
)The UNIX timestamp of the date and time that the monitor was created.
createdBy
— required — (String
)The user name of the person that created the monitor.
displayName
— required — (String
)The name of the monitor that displays on the Deadline Cloud console.
identityCenterApplicationArn
— required — (String
)The Amazon Resource Name (ARN) that the IAM Identity Center assigned to the monitor when it was created.
identityCenterInstanceArn
— required — (String
)The Amazon Resource Name (ARN) of the IAM Identity Center instance responsible for authenticating monitor users.
monitorId
— required — (String
)The unique identifier for the monitor.
roleArn
— required — (String
)The Amazon Resource Name (ARN) of the IAM role for the monitor. Users of the monitor use this role to access Deadline Cloud resources.
subdomain
— required — (String
)The subdomain used for the monitor URL. The full URL of the monitor is subdomain.Region.deadlinecloud.amazonaws.com.
updatedAt
— (Date
)The UNIX timestamp of the date and time that the monitor was last updated.
updatedBy
— (String
)The user name of the person that last updated the monitor.
url
— required — (String
)The complete URL of the monitor. The full URL of the monitor is subdomain.Region.deadlinecloud.amazonaws.com.
nextToken
— (String
)If Deadline Cloud returns
nextToken
, then there are more results available. The value ofnextToken
is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, thennextToken
is set tonull
. Each pagination token expires after 24 hours. If you provide a token that isn't valid, then you receive an HTTP 400ValidationException
error.
-
(AWS.Response)
—
Returns:
listQueueEnvironments(params = {}, callback) ⇒ AWS.Request
Lists queue environments.
Service Reference:
Examples:
Calling the listQueueEnvironments operation
var params = {
farmId: 'STRING_VALUE', /* required */
queueId: 'STRING_VALUE', /* required */
maxResults: 'NUMBER_VALUE',
nextToken: 'STRING_VALUE'
};
deadline.listQueueEnvironments(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
farmId
— (String
)The farm ID for the queue environment list.
maxResults
— (Integer
)The maximum number of results to return. Use this parameter with
NextToken
to get results as a set of sequential pages.nextToken
— (String
)The token for the next set of results, or
null
to start from the beginning.queueId
— (String
)The queue ID for the queue environment list.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:environments
— (Array<map>
)The environments to include in the queue environments list.
name
— required — (String
)The name of the queue environment.
priority
— required — (Integer
)The queue environment's priority.
queueEnvironmentId
— required — (String
)The queue environment ID.
nextToken
— (String
)If Deadline Cloud returns
nextToken
, then there are more results available. The value ofnextToken
is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, thennextToken
is set tonull
. Each pagination token expires after 24 hours. If you provide a token that isn't valid, then you receive an HTTP 400ValidationException
error.
-
(AWS.Response)
—
Returns:
listQueueFleetAssociations(params = {}, callback) ⇒ AWS.Request
Lists queue-fleet associations.
Service Reference:
Examples:
Calling the listQueueFleetAssociations operation
var params = {
farmId: 'STRING_VALUE', /* required */
fleetId: 'STRING_VALUE',
maxResults: 'NUMBER_VALUE',
nextToken: 'STRING_VALUE',
queueId: 'STRING_VALUE'
};
deadline.listQueueFleetAssociations(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
farmId
— (String
)The farm ID for the queue-fleet association list.
fleetId
— (String
)The fleet ID for the queue-fleet association list.
maxResults
— (Integer
)The maximum number of results to return. Use this parameter with
NextToken
to get results as a set of sequential pages.nextToken
— (String
)The token for the next set of results, or
null
to start from the beginning.queueId
— (String
)The queue ID for the queue-fleet association list.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:nextToken
— (String
)If Deadline Cloud returns
nextToken
, then there are more results available. The value ofnextToken
is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, thennextToken
is set tonull
. Each pagination token expires after 24 hours. If you provide a token that isn't valid, then you receive an HTTP 400ValidationException
error.queueFleetAssociations
— (Array<map>
)The queue-fleet associations on the list.
createdAt
— required — (Date
)The date and time the resource was created.
createdBy
— required — (String
)The user or system that created this resource.
fleetId
— required — (String
)The fleet ID.
queueId
— required — (String
)The queue ID.
status
— required — (String
)The status of task scheduling in the queue-fleet association.
-
ACTIVE
–Association is active. -
STOP_SCHEDULING_AND_COMPLETE_TASKS
–Association has stopped scheduling new tasks and is completing current tasks. -
STOP_SCHEDULING_AND_CANCEL_TASKS
–Association has stopped scheduling new tasks and is canceling current tasks. -
STOPPED
–Association has been stopped.
"ACTIVE"
"STOP_SCHEDULING_AND_COMPLETE_TASKS"
"STOP_SCHEDULING_AND_CANCEL_TASKS"
"STOPPED"
-
updatedAt
— (Date
)The date and time the resource was updated.
updatedBy
— (String
)The user or system that updated this resource.
-
(AWS.Response)
—
Returns:
listQueueMembers(params = {}, callback) ⇒ AWS.Request
Lists the members in a queue.
Service Reference:
Examples:
Calling the listQueueMembers operation
var params = {
farmId: 'STRING_VALUE', /* required */
queueId: 'STRING_VALUE', /* required */
maxResults: 'NUMBER_VALUE',
nextToken: 'STRING_VALUE'
};
deadline.listQueueMembers(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
farmId
— (String
)The farm ID for the queue.
maxResults
— (Integer
)The maximum number of results to return. Use this parameter with
NextToken
to get results as a set of sequential pages.nextToken
— (String
)The token for the next set of results, or
null
to start from the beginning.queueId
— (String
)The queue ID to include on the list.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:members
— (Array<map>
)The members on the list.
farmId
— required — (String
)The farm ID.
identityStoreId
— required — (String
)The identity store ID.
membershipLevel
— required — (String
)The queue member's membership level.
Possible values include:"VIEWER"
"CONTRIBUTOR"
"OWNER"
"MANAGER"
principalId
— required — (String
)The principal ID of the queue member.
principalType
— required — (String
)The principal type of the queue member.
Possible values include:"USER"
"GROUP"
queueId
— required — (String
)The queue ID.
nextToken
— (String
)If Deadline Cloud returns
nextToken
, then there are more results available. The value ofnextToken
is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, thennextToken
is set tonull
. Each pagination token expires after 24 hours. If you provide a token that isn't valid, then you receive an HTTP 400ValidationException
error.
-
(AWS.Response)
—
Returns:
listQueues(params = {}, callback) ⇒ AWS.Request
Lists queues.
Service Reference:
Examples:
Calling the listQueues operation
var params = {
farmId: 'STRING_VALUE', /* required */
maxResults: 'NUMBER_VALUE',
nextToken: 'STRING_VALUE',
principalId: 'STRING_VALUE',
status: IDLE | SCHEDULING | SCHEDULING_BLOCKED
};
deadline.listQueues(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
farmId
— (String
)The farm ID of the queue.
maxResults
— (Integer
)The maximum number of results to return. Use this parameter with
NextToken
to get results as a set of sequential pages.nextToken
— (String
)The token for the next set of results, or
null
to start from the beginning.principalId
— (String
)The principal ID. This filter is only valid when using Nimble Studio credentials and should match the user ID in the credentials of the caller.
status
— (String
)The status of the queues listed.
-
ACTIVE
–The queues are active. -
SCHEDULING
–The queues are scheduling. -
SCHEDULING_BLOCKED
–The queue scheduling is blocked for these queues.
"IDLE"
"SCHEDULING"
"SCHEDULING_BLOCKED"
-
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:nextToken
— (String
)If Deadline Cloud returns
nextToken
, then there are more results available. The value ofnextToken
is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, thennextToken
is set tonull
. Each pagination token expires after 24 hours. If you provide a token that isn't valid, then you receive an HTTP 400ValidationException
error.queues
— (Array<map>
)The queues on the list.
blockedReason
— (String
)The reason the queue is blocked, if applicable.
Possible values include:"NO_BUDGET_CONFIGURED"
"BUDGET_THRESHOLD_REACHED"
createdAt
— required — (Date
)The date and time the resource was created.
createdBy
— required — (String
)The user or system that created this resource.
defaultBudgetAction
— required — (String
)The default action taken on a queue summary if a budget wasn't configured.
Possible values include:"NONE"
"STOP_SCHEDULING_AND_COMPLETE_TASKS"
"STOP_SCHEDULING_AND_CANCEL_TASKS"
displayName
— required — (String
)The display name of the queue summary to update.
farmId
— required — (String
)The farm ID.
queueId
— required — (String
)The queue ID.
status
— required — (String
)That status of the queue.
Possible values include:"IDLE"
"SCHEDULING"
"SCHEDULING_BLOCKED"
updatedAt
— (Date
)The date and time the resource was updated.
updatedBy
— (String
)The user or system that updated this resource.
-
(AWS.Response)
—
Returns:
listSessionActions(params = {}, callback) ⇒ AWS.Request
Lists session actions.
Service Reference:
Examples:
Calling the listSessionActions operation
var params = {
farmId: 'STRING_VALUE', /* required */
jobId: 'STRING_VALUE', /* required */
queueId: 'STRING_VALUE', /* required */
maxResults: 'NUMBER_VALUE',
nextToken: 'STRING_VALUE',
sessionId: 'STRING_VALUE',
taskId: 'STRING_VALUE'
};
deadline.listSessionActions(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
farmId
— (String
)The farm ID for the session actions list.
jobId
— (String
)The job ID for the session actions list.
maxResults
— (Integer
)The maximum number of results to return. Use this parameter with
NextToken
to get results as a set of sequential pages.nextToken
— (String
)The token for the next set of results, or
null
to start from the beginning.queueId
— (String
)The queue ID for the session actions list.
sessionId
— (String
)The session ID to include on the sessions action list.
taskId
— (String
)The task ID for the session actions list.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:nextToken
— (String
)If Deadline Cloud returns
nextToken
, then there are more results available. The value ofnextToken
is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, thennextToken
is set tonull
. Each pagination token expires after 24 hours. If you provide a token that isn't valid, then you receive an HTTP 400ValidationException
error.sessionActions
— (Array<map>
)The session actions.
definition
— required — (map
)The session action definition.
envEnter
— (map
)The environment to enter into.
environmentId
— required — (String
)The environment ID.
envExit
— (map
)The environment to exit from.
environmentId
— required — (String
)The environment ID.
syncInputJobAttachments
— (map
)The job attachments to sync with the session action definition.
stepId
— (String
)The step ID of the step in the job attachment.
taskRun
— (map
)The task run.
stepId
— required — (String
)The step ID.
taskId
— required — (String
)The task ID.
endedAt
— (Date
)The date and time the resource ended running.
progressPercent
— (Float
)The completion percentage for the session action.
sessionActionId
— required — (String
)The session action ID.
startedAt
— (Date
)The date and time the resource started running.
status
— required — (String
)The status of the session action.
Possible values include:"ASSIGNED"
"RUNNING"
"CANCELING"
"SUCCEEDED"
"FAILED"
"INTERRUPTED"
"CANCELED"
"NEVER_ATTEMPTED"
"SCHEDULED"
"RECLAIMING"
"RECLAIMED"
workerUpdatedAt
— (Date
)The Linux timestamp of the last date and time that the session action was updated.
-
(AWS.Response)
—
Returns:
listSessions(params = {}, callback) ⇒ AWS.Request
Lists sessions.
Service Reference:
Examples:
Calling the listSessions operation
var params = {
farmId: 'STRING_VALUE', /* required */
jobId: 'STRING_VALUE', /* required */
queueId: 'STRING_VALUE', /* required */
maxResults: 'NUMBER_VALUE',
nextToken: 'STRING_VALUE'
};
deadline.listSessions(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
farmId
— (String
)The farm ID for the list of sessions.
jobId
— (String
)The job ID for the list of sessions.
maxResults
— (Integer
)The maximum number of results to return. Use this parameter with
NextToken
to get results as a set of sequential pages.nextToken
— (String
)The token for the next set of results, or
null
to start from the beginning.queueId
— (String
)The queue ID for the list of sessions
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:nextToken
— (String
)If Deadline Cloud returns
nextToken
, then there are more results available. The value ofnextToken
is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, thennextToken
is set tonull
. Each pagination token expires after 24 hours. If you provide a token that isn't valid, then you receive an HTTP 400ValidationException
error.sessions
— (Array<map>
)The sessions on the list.
endedAt
— (Date
)The date and time the resource ended running.
fleetId
— required — (String
)The fleet ID.
lifecycleStatus
— required — (String
)The life cycle status for the session.
Possible values include:"STARTED"
"UPDATE_IN_PROGRESS"
"UPDATE_SUCCEEDED"
"UPDATE_FAILED"
"ENDED"
sessionId
— required — (String
)The session ID.
startedAt
— required — (Date
)The date and time the resource started running.
targetLifecycleStatus
— (String
)The target life cycle status for the session.
Possible values include:"ENDED"
updatedAt
— (Date
)The date and time the resource was updated.
updatedBy
— (String
)The user or system that updated this resource.
workerId
— required — (String
)The worker ID.
-
(AWS.Response)
—
Returns:
listSessionsForWorker(params = {}, callback) ⇒ AWS.Request
Lists sessions for a worker.
Service Reference:
Examples:
Calling the listSessionsForWorker operation
var params = {
farmId: 'STRING_VALUE', /* required */
fleetId: 'STRING_VALUE', /* required */
workerId: 'STRING_VALUE', /* required */
maxResults: 'NUMBER_VALUE',
nextToken: 'STRING_VALUE'
};
deadline.listSessionsForWorker(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
farmId
— (String
)The farm ID for the session.
fleetId
— (String
)The fleet ID for the session.
maxResults
— (Integer
)The maximum number of results to return. Use this parameter with
NextToken
to get results as a set of sequential pages.nextToken
— (String
)The token for the next set of results, or
null
to start from the beginning.workerId
— (String
)The worker ID for the session.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:nextToken
— (String
)The token for the next set of results, or
null
to start from the beginning.sessions
— (Array<map>
)The sessions in the response.
endedAt
— (Date
)The date and time the resource ended running.
jobId
— required — (String
)The job ID for the job associated with the worker's session.
lifecycleStatus
— required — (String
)The life cycle status for the worker's session.
Possible values include:"STARTED"
"UPDATE_IN_PROGRESS"
"UPDATE_SUCCEEDED"
"UPDATE_FAILED"
"ENDED"
queueId
— required — (String
)The queue ID for the queue associated to the worker.
sessionId
— required — (String
)The session ID for the session action.
startedAt
— required — (Date
)The date and time the resource started running.
targetLifecycleStatus
— (String
)The life cycle status
Possible values include:"ENDED"
-
(AWS.Response)
—
Returns:
listStepConsumers(params = {}, callback) ⇒ AWS.Request
Lists step consumers.
Service Reference:
Examples:
Calling the listStepConsumers operation
var params = {
farmId: 'STRING_VALUE', /* required */
jobId: 'STRING_VALUE', /* required */
queueId: 'STRING_VALUE', /* required */
stepId: 'STRING_VALUE', /* required */
maxResults: 'NUMBER_VALUE',
nextToken: 'STRING_VALUE'
};
deadline.listStepConsumers(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
farmId
— (String
)The farm ID for the list of step consumers.
jobId
— (String
)The job ID for the step consumer.
maxResults
— (Integer
)The maximum number of results to return. Use this parameter with
NextToken
to get results as a set of sequential pages.nextToken
— (String
)The token for the next set of results, or
null
to start from the beginning.queueId
— (String
)The queue ID for the step consumer.
stepId
— (String
)The step ID to include on the list.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:consumers
— (Array<map>
)The consumers on the list.
status
— required — (String
)The step consumer status.
Possible values include:"RESOLVED"
"UNRESOLVED"
stepId
— required — (String
)The step ID.
nextToken
— (String
)If Deadline Cloud returns
nextToken
, then there are more results available. The value ofnextToken
is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, thennextToken
is set tonull
. Each pagination token expires after 24 hours. If you provide a token that isn't valid, then you receive an HTTP 400ValidationException
error.
-
(AWS.Response)
—
Returns:
listStepDependencies(params = {}, callback) ⇒ AWS.Request
Lists the dependencies for a step.
Service Reference:
Examples:
Calling the listStepDependencies operation
var params = {
farmId: 'STRING_VALUE', /* required */
jobId: 'STRING_VALUE', /* required */
queueId: 'STRING_VALUE', /* required */
stepId: 'STRING_VALUE', /* required */
maxResults: 'NUMBER_VALUE',
nextToken: 'STRING_VALUE'
};
deadline.listStepDependencies(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
farmId
— (String
)The farm ID for the step dependencies list.
jobId
— (String
)The job ID for the step dependencies list.
maxResults
— (Integer
)The maximum number of results to return. Use this parameter with
NextToken
to get results as a set of sequential pages.nextToken
— (String
)The token for the next set of results, or
null
to start from the beginning.queueId
— (String
)The queue ID for the step dependencies list.
stepId
— (String
)The step ID to include on the list.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:dependencies
— (Array<map>
)The dependencies on the list.
status
— required — (String
)The step dependency status.
Possible values include:"RESOLVED"
"UNRESOLVED"
stepId
— required — (String
)The step ID.
nextToken
— (String
)If Deadline Cloud returns
nextToken
, then there are more results available. The value ofnextToken
is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, thennextToken
is set tonull
. Each pagination token expires after 24 hours. If you provide a token that isn't valid, then you receive an HTTP 400ValidationException
error.
-
(AWS.Response)
—
Returns:
listSteps(params = {}, callback) ⇒ AWS.Request
Lists steps for a job.
Service Reference:
Examples:
Calling the listSteps operation
var params = {
farmId: 'STRING_VALUE', /* required */
jobId: 'STRING_VALUE', /* required */
queueId: 'STRING_VALUE', /* required */
maxResults: 'NUMBER_VALUE',
nextToken: 'STRING_VALUE'
};
deadline.listSteps(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
farmId
— (String
)The farm ID to include on the list of steps.
jobId
— (String
)The job ID to include on the list of steps.
maxResults
— (Integer
)The maximum number of results to return. Use this parameter with
NextToken
to get results as a set of sequential pages.nextToken
— (String
)The token for the next set of results, or
null
to start from the beginning.queueId
— (String
)The queue ID to include on the list of steps.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:nextToken
— (String
)If Deadline Cloud returns
nextToken
, then there are more results available. The value ofnextToken
is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, thennextToken
is set tonull
. Each pagination token expires after 24 hours. If you provide a token that isn't valid, then you receive an HTTP 400ValidationException
error.steps
— (Array<map>
)The steps on the list.
createdAt
— required — (Date
)The date and time the resource was created.
createdBy
— required — (String
)The user or system that created this resource.
dependencyCounts
— (map
)The number of dependencies for the step.
consumersResolved
— required — (Integer
)The number of consumers resolved.
consumersUnresolved
— required — (Integer
)The number of unresolved consumers.
dependenciesResolved
— required — (Integer
)The number of resolved dependencies.
dependenciesUnresolved
— required — (Integer
)The number of unresolved dependencies.
endedAt
— (Date
)The date and time the resource ended running.
lifecycleStatus
— required — (String
)The life cycle status.
Possible values include:"CREATE_COMPLETE"
"UPDATE_IN_PROGRESS"
"UPDATE_FAILED"
"UPDATE_SUCCEEDED"
lifecycleStatusMessage
— (String
)A message that describes the lifecycle of the step.
name
— required — (String
)The name of the step.
startedAt
— (Date
)The date and time the resource started running.
stepId
— required — (String
)The step ID.
targetTaskRunStatus
— (String
)The task status to start with on the job.
Possible values include:"READY"
"FAILED"
"SUCCEEDED"
"CANCELED"
"SUSPENDED"
"PENDING"
taskRunStatus
— required — (String
)The task run status for the job.
-
PENDING
–pending and waiting for resources. -
READY
–ready to process. -
ASSIGNED
–assigned and will run next on a worker. -
SCHEDULED
–scheduled to run on a worker. -
INTERRUPTING
–being interrupted. -
RUNNING
–running on a worker. -
SUSPENDED
–the task is suspended. -
CANCELED
–the task has been canceled. -
FAILED
–the task has failed. -
SUCCEEDED
–the task has succeeded.
"PENDING"
"READY"
"ASSIGNED"
"STARTING"
"SCHEDULED"
"INTERRUPTING"
"RUNNING"
"SUSPENDED"
"CANCELED"
"FAILED"
"SUCCEEDED"
"NOT_COMPATIBLE"
-
taskRunStatusCounts
— required — (map<Integer>
)The number of tasks running on the job.
updatedAt
— (Date
)The date and time the resource was updated.
updatedBy
— (String
)The user or system that updated this resource.
-
(AWS.Response)
—
Returns:
listStorageProfiles(params = {}, callback) ⇒ AWS.Request
Lists storage profiles.
Service Reference:
Examples:
Calling the listStorageProfiles operation
var params = {
farmId: 'STRING_VALUE', /* required */
maxResults: 'NUMBER_VALUE',
nextToken: 'STRING_VALUE'
};
deadline.listStorageProfiles(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
farmId
— (String
)The farm ID of the storage profile.
maxResults
— (Integer
)The maximum number of results to return. Use this parameter with
NextToken
to get results as a set of sequential pages.nextToken
— (String
)The token for the next set of results, or
null
to start from the beginning.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:nextToken
— (String
)If Deadline Cloud returns
nextToken
, then there are more results available. The value ofnextToken
is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, thennextToken
is set tonull
. Each pagination token expires after 24 hours. If you provide a token that isn't valid, then you receive an HTTP 400ValidationException
error.storageProfiles
— (Array<map>
)The storage profiles.
displayName
— required — (String
)The display name of the storage profile summary to update.
osFamily
— required — (String
)The operating system (OS) family.
Possible values include:"WINDOWS"
"LINUX"
"MACOS"
storageProfileId
— required — (String
)The storage profile ID.
-
(AWS.Response)
—
Returns:
listStorageProfilesForQueue(params = {}, callback) ⇒ AWS.Request
Lists storage profiles for a queue.
Service Reference:
Examples:
Calling the listStorageProfilesForQueue operation
var params = {
farmId: 'STRING_VALUE', /* required */
queueId: 'STRING_VALUE', /* required */
maxResults: 'NUMBER_VALUE',
nextToken: 'STRING_VALUE'
};
deadline.listStorageProfilesForQueue(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
farmId
— (String
)The farm ID of the queue's storage profile.
maxResults
— (Integer
)The maximum number of results to return. Use this parameter with
NextToken
to get results as a set of sequential pages.nextToken
— (String
)The token for the next set of results, or
null
to start from the beginning.queueId
— (String
)The queue ID for the storage profile.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:nextToken
— (String
)If Deadline Cloud returns
nextToken
, then there are more results available. The value ofnextToken
is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, thennextToken
is set tonull
. Each pagination token expires after 24 hours. If you provide a token that isn't valid, then you receive an HTTP 400ValidationException
error.storageProfiles
— (Array<map>
)The storage profiles in the queue.
displayName
— required — (String
)The display name of the storage profile summary to update.
osFamily
— required — (String
)The operating system (OS) family.
Possible values include:"WINDOWS"
"LINUX"
"MACOS"
storageProfileId
— required — (String
)The storage profile ID.
-
(AWS.Response)
—
Returns:
listTagsForResource(params = {}, callback) ⇒ AWS.Request
Lists tags for a resource.
Service Reference:
Examples:
Calling the listTagsForResource operation
var params = {
resourceArn: 'STRING_VALUE' /* required */
};
deadline.listTagsForResource(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
resourceArn
— (String
)The resource ARN to list tags for.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:tags
— (map<String>
)Each tag consists of a tag key and a tag value. Tag keys and values are both required, but tag values can be empty strings.
-
(AWS.Response)
—
Returns:
listTasks(params = {}, callback) ⇒ AWS.Request
Lists tasks for a job.
Service Reference:
Examples:
Calling the listTasks operation
var params = {
farmId: 'STRING_VALUE', /* required */
jobId: 'STRING_VALUE', /* required */
queueId: 'STRING_VALUE', /* required */
stepId: 'STRING_VALUE', /* required */
maxResults: 'NUMBER_VALUE',
nextToken: 'STRING_VALUE'
};
deadline.listTasks(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
farmId
— (String
)The farm ID connected to the tasks.
jobId
— (String
)The job ID for the tasks.
maxResults
— (Integer
)The maximum number of results to return. Use this parameter with
NextToken
to get results as a set of sequential pages.nextToken
— (String
)The token for the next set of results, or
null
to start from the beginning.queueId
— (String
)The queue ID connected to the tasks.
stepId
— (String
)The step ID for the tasks.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:nextToken
— (String
)If Deadline Cloud returns
nextToken
, then there are more results available. The value ofnextToken
is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, thennextToken
is set tonull
. Each pagination token expires after 24 hours. If you provide a token that isn't valid, then you receive an HTTP 400ValidationException
error.tasks
— (Array<map>
)Tasks for the job.
createdAt
— required — (Date
)The date and time the resource was created.
createdBy
— required — (String
)The user or system that created this resource.
endedAt
— (Date
)The date and time the resource ended running.
failureRetryCount
— (Integer
)The number of times that the task failed and was retried.
latestSessionActionId
— (String
)The latest session action for the task.
parameters
— (map<map>
)The task parameters.
float
— (String
)A double precision IEEE-754 floating point number represented as a string.
int
— (String
)A signed integer represented as a string.
path
— (String
)A file system path represented as a string.
string
— (String
)A UTF-8 string.
runStatus
— required — (String
)The run status of the task.
Possible values include:"PENDING"
"READY"
"ASSIGNED"
"STARTING"
"SCHEDULED"
"INTERRUPTING"
"RUNNING"
"SUSPENDED"
"CANCELED"
"FAILED"
"SUCCEEDED"
"NOT_COMPATIBLE"
startedAt
— (Date
)The date and time the resource started running.
targetRunStatus
— (String
)The run status on which the started.
Possible values include:"READY"
"FAILED"
"SUCCEEDED"
"CANCELED"
"SUSPENDED"
"PENDING"
taskId
— required — (String
)The task ID.
updatedAt
— (Date
)The date and time the resource was updated.
updatedBy
— (String
)The user or system that updated this resource.
-
(AWS.Response)
—
Returns:
listWorkers(params = {}, callback) ⇒ AWS.Request
Lists workers.
Service Reference:
Examples:
Calling the listWorkers operation
var params = {
farmId: 'STRING_VALUE', /* required */
fleetId: 'STRING_VALUE', /* required */
maxResults: 'NUMBER_VALUE',
nextToken: 'STRING_VALUE'
};
deadline.listWorkers(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
farmId
— (String
)The farm ID connected to the workers.
fleetId
— (String
)The fleet ID of the workers.
maxResults
— (Integer
)The maximum number of results to return. Use this parameter with
NextToken
to get results as a set of sequential pages.nextToken
— (String
)The token for the next set of results, or
null
to start from the beginning.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:nextToken
— (String
)If Deadline Cloud returns
nextToken
, then there are more results available. The value ofnextToken
is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, thennextToken
is set tonull
. Each pagination token expires after 24 hours. If you provide a token that isn't valid, then you receive an HTTP 400ValidationException
error.workers
— (Array<map>
)The workers on the list.
createdAt
— required — (Date
)The date and time the resource was created.
createdBy
— required — (String
)The user or system that created this resource.
farmId
— required — (String
)The farm ID.
fleetId
— required — (String
)The fleet ID.
hostProperties
— (map
)The host properties of the worker.
ec2InstanceArn
— (String
)The ARN of the host EC2 instance.
ec2InstanceType
— (String
)The instance type of the host EC2 instance.
hostName
— (String
)The host name.
ipAddresses
— (map
)The IP address of the host.
ipV4Addresses
— (Array<String>
)The IpV4 address of the network.
ipV6Addresses
— (Array<String>
)The IpV6 address for the network and node component.
log
— (map
)The log configuration for the worker.
error
— (String
)The log configuration error details.
logDriver
— required — (String
)The log drivers for worker related logs.
options
— (map<String>
)The options for a log driver.
parameters
— (map<String>
)The parameters for the log configuration.
status
— required — (String
)The status of the worker.
Possible values include:"CREATED"
"STARTED"
"STOPPING"
"STOPPED"
"NOT_RESPONDING"
"NOT_COMPATIBLE"
"RUNNING"
"IDLE"
updatedAt
— (Date
)The date and time the resource was updated.
updatedBy
— (String
)The user or system that updated this resource.
workerId
— required — (String
)The worker ID.
-
(AWS.Response)
—
Returns:
putMeteredProduct(params = {}, callback) ⇒ AWS.Request
Adds a metered product.
Service Reference:
Examples:
Calling the putMeteredProduct operation
var params = {
licenseEndpointId: 'STRING_VALUE', /* required */
productId: 'STRING_VALUE' /* required */
};
deadline.putMeteredProduct(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
licenseEndpointId
— (String
)The license endpoint ID to add to the metered product.
productId
— (String
)The product ID to add to the metered product.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs.
-
(AWS.Response)
—
Returns:
searchJobs(params = {}, callback) ⇒ AWS.Request
Searches for jobs.
Service Reference:
Examples:
Calling the searchJobs operation
var params = {
farmId: 'STRING_VALUE', /* required */
itemOffset: 'NUMBER_VALUE', /* required */
queueIds: [ /* required */
'STRING_VALUE',
/* more items */
],
filterExpressions: { /* SearchGroupedFilterExpressions */
filters: [ /* required */
{
dateTimeFilter: {
dateTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, /* required */
name: 'STRING_VALUE', /* required */
operator: EQUAL | NOT_EQUAL | GREATER_THAN_EQUAL_TO | GREATER_THAN | LESS_THAN_EQUAL_TO | LESS_THAN /* required */
},
groupFilter: /* recursive SearchGroupedFilterExpressions */,
parameterFilter: {
name: 'STRING_VALUE', /* required */
operator: EQUAL | NOT_EQUAL | GREATER_THAN_EQUAL_TO | GREATER_THAN | LESS_THAN_EQUAL_TO | LESS_THAN, /* required */
value: 'STRING_VALUE' /* required */
},
searchTermFilter: {
searchTerm: 'STRING_VALUE' /* required */
},
stringFilter: {
name: 'STRING_VALUE', /* required */
operator: EQUAL | NOT_EQUAL | GREATER_THAN_EQUAL_TO | GREATER_THAN | LESS_THAN_EQUAL_TO | LESS_THAN, /* required */
value: 'STRING_VALUE' /* required */
}
},
/* more items */
],
operator: AND | OR /* required */
},
pageSize: 'NUMBER_VALUE',
sortExpressions: [
{
fieldSort: {
name: 'STRING_VALUE', /* required */
sortOrder: ASCENDING | DESCENDING /* required */
},
parameterSort: {
name: 'STRING_VALUE', /* required */
sortOrder: ASCENDING | DESCENDING /* required */
},
userJobsFirst: {
userIdentityId: 'STRING_VALUE' /* required */
}
},
/* more items */
]
};
deadline.searchJobs(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
farmId
— (String
)The farm ID of the job.
filterExpressions
— (map
)The filter expression,
AND
orOR
, to use when searching among a group of search strings in a resource.You can use two groupings per search each within parenthesis
()
.filters
— required — (Array<map>
)The filters to use for the search.
dateTimeFilter
— (map
)Filters based on date and time.
dateTime
— required — (Date
)The date and time.
name
— required — (String
)The name of the date-time field to filter on.
operator
— required — (String
)The type of comparison to use to filter the results.
Possible values include:"EQUAL"
"NOT_EQUAL"
"GREATER_THAN_EQUAL_TO"
"GREATER_THAN"
"LESS_THAN_EQUAL_TO"
"LESS_THAN"
groupFilter
— (map
)Filters by group.
operator
— required — (String
)The operators to include in the search.
Possible values include:"AND"
"OR"
parameterFilter
— (map
)Filters by parameter.
name
— required — (String
)The name of the parameter to filter on.
operator
— required — (String
)The type of comparison to use to filter results.
Possible values include:"EQUAL"
"NOT_EQUAL"
"GREATER_THAN_EQUAL_TO"
"GREATER_THAN"
"LESS_THAN_EQUAL_TO"
"LESS_THAN"
value
— required — (String
)The parameter's value.
searchTermFilter
— (map
)Filters by a specified search term.
searchTerm
— required — (String
)The term to search for.
stringFilter
— (map
)Filters by a string.
name
— required — (String
)The field name to search.
operator
— required — (String
)The type of comparison to use for this search.
Possible values include:"EQUAL"
"NOT_EQUAL"
"GREATER_THAN_EQUAL_TO"
"GREATER_THAN"
"LESS_THAN_EQUAL_TO"
"LESS_THAN"
value
— required — (String
)The string to search for.
operator
— required — (String
)The operators to include in the search.
Possible values include:"AND"
"OR"
itemOffset
— (Integer
)Defines how far into the scrollable list to start the return of results.
pageSize
— (Integer
)Specifies the number of items per page for the resource.
queueIds
— (Array<String>
)The queue ID to use in the job search.
sortExpressions
— (Array<map>
)The search terms for a resource.
fieldSort
— (map
)Options for sorting by a field.
name
— required — (String
)The name of the field.
sortOrder
— required — (String
)The sort order for the field.
Possible values include:"ASCENDING"
"DESCENDING"
parameterSort
— (map
)Options for sorting by a parameter.
name
— required — (String
)The parameter name to sort by.
sortOrder
— required — (String
)The sort order for the parameter.
Possible values include:"ASCENDING"
"DESCENDING"
userJobsFirst
— (map
)Options for sorting a particular user's jobs first.
userIdentityId
— required — (String
)The user's ID.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:jobs
— (Array<map>
)The jobs in the search.
createdAt
— (Date
)The date and time the resource was created.
createdBy
— (String
)The user or system that created this resource.
endedAt
— (Date
)The date and time the resource ended running.
jobId
— (String
)The job ID.
jobParameters
— (map<map>
)The job parameters.
float
— (String
)A double precision IEEE-754 floating point number represented as a string.
int
— (String
)A signed integer represented as a string.
path
— (String
)A file system path represented as a string.
string
— (String
)A UTF-8 string.
lifecycleStatus
— (String
)The life cycle status.
Possible values include:"CREATE_IN_PROGRESS"
"CREATE_FAILED"
"CREATE_COMPLETE"
"UPLOAD_IN_PROGRESS"
"UPLOAD_FAILED"
"UPDATE_IN_PROGRESS"
"UPDATE_FAILED"
"UPDATE_SUCCEEDED"
"ARCHIVED"
lifecycleStatusMessage
— (String
)The life cycle status message.
maxFailedTasksCount
— (Integer
)The number of task failures before the job stops running and is marked as
FAILED
.maxRetriesPerTask
— (Integer
)The maximum number of retries for a job.
name
— (String
)The job name.
priority
— (Integer
)The job priority.
queueId
— (String
)The queue ID.
startedAt
— (Date
)The date and time the resource started running.
targetTaskRunStatus
— (String
)The task status to start with on the job.
Possible values include:"READY"
"FAILED"
"SUCCEEDED"
"CANCELED"
"SUSPENDED"
"PENDING"
taskRunStatus
— (String
)task run status for the job.
-
PENDING
–pending and waiting for resources. -
READY
–ready to be processed. -
ASSIGNED
–assigned and will run next on a worker. -
SCHEDULED
–scheduled to be run on a worker. -
INTERRUPTING
–being interrupted. -
RUNNING
–running on a worker. -
SUSPENDED
–the task is suspended. -
CANCELED
–the task has been canceled. -
FAILED
–the task has failed. -
SUCCEEDED
–the task has succeeded.
"PENDING"
"READY"
"ASSIGNED"
"STARTING"
"SCHEDULED"
"INTERRUPTING"
"RUNNING"
"SUSPENDED"
"CANCELED"
"FAILED"
"SUCCEEDED"
"NOT_COMPATIBLE"
-
taskRunStatusCounts
— (map<Integer>
)The number of tasks running on the job.
nextItemOffset
— (Integer
)The next incremental starting point after the defined
itemOffset
.totalResults
— (Integer
)The total number of results in the search.
-
(AWS.Response)
—
Returns:
searchSteps(params = {}, callback) ⇒ AWS.Request
Searches for steps.
Service Reference:
Examples:
Calling the searchSteps operation
var params = {
farmId: 'STRING_VALUE', /* required */
itemOffset: 'NUMBER_VALUE', /* required */
queueIds: [ /* required */
'STRING_VALUE',
/* more items */
],
filterExpressions: { /* SearchGroupedFilterExpressions */
filters: [ /* required */
{
dateTimeFilter: {
dateTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, /* required */
name: 'STRING_VALUE', /* required */
operator: EQUAL | NOT_EQUAL | GREATER_THAN_EQUAL_TO | GREATER_THAN | LESS_THAN_EQUAL_TO | LESS_THAN /* required */
},
groupFilter: /* recursive SearchGroupedFilterExpressions */,
parameterFilter: {
name: 'STRING_VALUE', /* required */
operator: EQUAL | NOT_EQUAL | GREATER_THAN_EQUAL_TO | GREATER_THAN | LESS_THAN_EQUAL_TO | LESS_THAN, /* required */
value: 'STRING_VALUE' /* required */
},
searchTermFilter: {
searchTerm: 'STRING_VALUE' /* required */
},
stringFilter: {
name: 'STRING_VALUE', /* required */
operator: EQUAL | NOT_EQUAL | GREATER_THAN_EQUAL_TO | GREATER_THAN | LESS_THAN_EQUAL_TO | LESS_THAN, /* required */
value: 'STRING_VALUE' /* required */
}
},
/* more items */
],
operator: AND | OR /* required */
},
jobId: 'STRING_VALUE',
pageSize: 'NUMBER_VALUE',
sortExpressions: [
{
fieldSort: {
name: 'STRING_VALUE', /* required */
sortOrder: ASCENDING | DESCENDING /* required */
},
parameterSort: {
name: 'STRING_VALUE', /* required */
sortOrder: ASCENDING | DESCENDING /* required */
},
userJobsFirst: {
userIdentityId: 'STRING_VALUE' /* required */
}
},
/* more items */
]
};
deadline.searchSteps(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
farmId
— (String
)The farm ID to use for the step search.
filterExpressions
— (map
)The filter expression,
AND
orOR
, to use when searching among a group of search strings in a resource.You can use two groupings per search each within parenthesis
()
.filters
— required — (Array<map>
)The filters to use for the search.
dateTimeFilter
— (map
)Filters based on date and time.
dateTime
— required — (Date
)The date and time.
name
— required — (String
)The name of the date-time field to filter on.
operator
— required — (String
)The type of comparison to use to filter the results.
Possible values include:"EQUAL"
"NOT_EQUAL"
"GREATER_THAN_EQUAL_TO"
"GREATER_THAN"
"LESS_THAN_EQUAL_TO"
"LESS_THAN"
groupFilter
— (map
)Filters by group.
operator
— required — (String
)The operators to include in the search.
Possible values include:"AND"
"OR"
parameterFilter
— (map
)Filters by parameter.
name
— required — (String
)The name of the parameter to filter on.
operator
— required — (String
)The type of comparison to use to filter results.
Possible values include:"EQUAL"
"NOT_EQUAL"
"GREATER_THAN_EQUAL_TO"
"GREATER_THAN"
"LESS_THAN_EQUAL_TO"
"LESS_THAN"
value
— required — (String
)The parameter's value.
searchTermFilter
— (map
)Filters by a specified search term.
searchTerm
— required — (String
)The term to search for.
stringFilter
— (map
)Filters by a string.
name
— required — (String
)The field name to search.
operator
— required — (String
)The type of comparison to use for this search.
Possible values include:"EQUAL"
"NOT_EQUAL"
"GREATER_THAN_EQUAL_TO"
"GREATER_THAN"
"LESS_THAN_EQUAL_TO"
"LESS_THAN"
value
— required — (String
)The string to search for.
operator
— required — (String
)The operators to include in the search.
Possible values include:"AND"
"OR"
itemOffset
— (Integer
)Defines how far into the scrollable list to start the return of results.
jobId
— (String
)The job ID to use in the step search.
pageSize
— (Integer
)Specifies the number of items per page for the resource.
queueIds
— (Array<String>
)The queue IDs in the step search.
sortExpressions
— (Array<map>
)The search terms for a resource.
fieldSort
— (map
)Options for sorting by a field.
name
— required — (String
)The name of the field.
sortOrder
— required — (String
)The sort order for the field.
Possible values include:"ASCENDING"
"DESCENDING"
parameterSort
— (map
)Options for sorting by a parameter.
name
— required — (String
)The parameter name to sort by.
sortOrder
— required — (String
)The sort order for the parameter.
Possible values include:"ASCENDING"
"DESCENDING"
userJobsFirst
— (map
)Options for sorting a particular user's jobs first.
userIdentityId
— required — (String
)The user's ID.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:nextItemOffset
— (Integer
)The next incremental starting point after the defined
itemOffset
.steps
— (Array<map>
)The steps in the search.
createdAt
— (Date
)The date and time the resource was created.
endedAt
— (Date
)The date and time the resource ended running.
jobId
— (String
)The job ID.
lifecycleStatus
— (String
)The life cycle status.
Possible values include:"CREATE_COMPLETE"
"UPDATE_IN_PROGRESS"
"UPDATE_FAILED"
"UPDATE_SUCCEEDED"
lifecycleStatusMessage
— (String
)The life cycle status message.
name
— (String
)The step name.
parameterSpace
— (map
)The parameters and combination expressions for the search.
combination
— (String
)The combination expression to use in the search.
parameters
— required — (Array<map>
)The parameters to search for.
name
— required — (String
)The name of the parameter.
type
— required — (String
)The data type of the parameter.
Possible values include:"INT"
"FLOAT"
"STRING"
"PATH"
queueId
— (String
)The queue ID.
startedAt
— (Date
)The date and time the resource started running.
stepId
— (String
)The step ID.
targetTaskRunStatus
— (String
)The task status to start with on the job.
Possible values include:"READY"
"FAILED"
"SUCCEEDED"
"CANCELED"
"SUSPENDED"
"PENDING"
taskRunStatus
— (String
)The task run status for the job.
-
PENDING
–pending and waiting for resources. -
READY
–ready to be processed. -
ASSIGNED
–assigned and will run next on a worker. -
SCHEDULED
–scheduled to be run on a worker. -
INTERRUPTING
–being interrupted. -
RUNNING
–running on a worker. -
SUSPENDED
–the task is suspended. -
CANCELED
–the task has been canceled. -
FAILED
–the task has failed. -
SUCCEEDED
–the task has succeeded.
"PENDING"
"READY"
"ASSIGNED"
"STARTING"
"SCHEDULED"
"INTERRUPTING"
"RUNNING"
"SUSPENDED"
"CANCELED"
"FAILED"
"SUCCEEDED"
"NOT_COMPATIBLE"
-
taskRunStatusCounts
— (map<Integer>
)The number of tasks running on the job.
totalResults
— (Integer
)The total number of results in the search.
-
(AWS.Response)
—
Returns:
searchTasks(params = {}, callback) ⇒ AWS.Request
Searches for tasks.
Service Reference:
Examples:
Calling the searchTasks operation
var params = {
farmId: 'STRING_VALUE', /* required */
itemOffset: 'NUMBER_VALUE', /* required */
queueIds: [ /* required */
'STRING_VALUE',
/* more items */
],
filterExpressions: { /* SearchGroupedFilterExpressions */
filters: [ /* required */
{
dateTimeFilter: {
dateTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, /* required */
name: 'STRING_VALUE', /* required */
operator: EQUAL | NOT_EQUAL | GREATER_THAN_EQUAL_TO | GREATER_THAN | LESS_THAN_EQUAL_TO | LESS_THAN /* required */
},
groupFilter: /* recursive SearchGroupedFilterExpressions */,
parameterFilter: {
name: 'STRING_VALUE', /* required */
operator: EQUAL | NOT_EQUAL | GREATER_THAN_EQUAL_TO | GREATER_THAN | LESS_THAN_EQUAL_TO | LESS_THAN, /* required */
value: 'STRING_VALUE' /* required */
},
searchTermFilter: {
searchTerm: 'STRING_VALUE' /* required */
},
stringFilter: {
name: 'STRING_VALUE', /* required */
operator: EQUAL | NOT_EQUAL | GREATER_THAN_EQUAL_TO | GREATER_THAN | LESS_THAN_EQUAL_TO | LESS_THAN, /* required */
value: 'STRING_VALUE' /* required */
}
},
/* more items */
],
operator: AND | OR /* required */
},
jobId: 'STRING_VALUE',
pageSize: 'NUMBER_VALUE',
sortExpressions: [
{
fieldSort: {
name: 'STRING_VALUE', /* required */
sortOrder: ASCENDING | DESCENDING /* required */
},
parameterSort: {
name: 'STRING_VALUE', /* required */
sortOrder: ASCENDING | DESCENDING /* required */
},
userJobsFirst: {
userIdentityId: 'STRING_VALUE' /* required */
}
},
/* more items */
]
};
deadline.searchTasks(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
farmId
— (String
)The farm ID of the task.
filterExpressions
— (map
)The filter expression,
AND
orOR
, to use when searching among a group of search strings in a resource.You can use two groupings per search each within parenthesis
()
.filters
— required — (Array<map>
)The filters to use for the search.
dateTimeFilter
— (map
)Filters based on date and time.
dateTime
— required — (Date
)The date and time.
name
— required — (String
)The name of the date-time field to filter on.
operator
— required — (String
)The type of comparison to use to filter the results.
Possible values include:"EQUAL"
"NOT_EQUAL"
"GREATER_THAN_EQUAL_TO"
"GREATER_THAN"
"LESS_THAN_EQUAL_TO"
"LESS_THAN"
groupFilter
— (map
)Filters by group.
operator
— required — (String
)The operators to include in the search.
Possible values include:"AND"
"OR"
parameterFilter
— (map
)Filters by parameter.
name
— required — (String
)The name of the parameter to filter on.
operator
— required — (String
)The type of comparison to use to filter results.
Possible values include:"EQUAL"
"NOT_EQUAL"
"GREATER_THAN_EQUAL_TO"
"GREATER_THAN"
"LESS_THAN_EQUAL_TO"
"LESS_THAN"
value
— required — (String
)The parameter's value.
searchTermFilter
— (map
)Filters by a specified search term.
searchTerm
— required — (String
)The term to search for.
stringFilter
— (map
)Filters by a string.
name
— required — (String
)The field name to search.
operator
— required — (String
)The type of comparison to use for this search.
Possible values include:"EQUAL"
"NOT_EQUAL"
"GREATER_THAN_EQUAL_TO"
"GREATER_THAN"
"LESS_THAN_EQUAL_TO"
"LESS_THAN"
value
— required — (String
)The string to search for.
operator
— required — (String
)The operators to include in the search.
Possible values include:"AND"
"OR"
itemOffset
— (Integer
)Defines how far into the scrollable list to start the return of results.
jobId
— (String
)The job ID for the task search.
pageSize
— (Integer
)Specifies the number of items per page for the resource.
queueIds
— (Array<String>
)The queue IDs to include in the search.
sortExpressions
— (Array<map>
)The search terms for a resource.
fieldSort
— (map
)Options for sorting by a field.
name
— required — (String
)The name of the field.
sortOrder
— required — (String
)The sort order for the field.
Possible values include:"ASCENDING"
"DESCENDING"
parameterSort
— (map
)Options for sorting by a parameter.
name
— required — (String
)The parameter name to sort by.
sortOrder
— required — (String
)The sort order for the parameter.
Possible values include:"ASCENDING"
"DESCENDING"
userJobsFirst
— (map
)Options for sorting a particular user's jobs first.
userIdentityId
— required — (String
)The user's ID.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:nextItemOffset
— (Integer
)The next incremental starting point after the defined
itemOffset
.tasks
— (Array<map>
)Tasks in the search.
endedAt
— (Date
)The date and time the resource ended running.
failureRetryCount
— (Integer
)The number of times that the task failed and was retried.
jobId
— (String
)The job ID.
parameters
— (map<map>
)The parameters to search for.
float
— (String
)A double precision IEEE-754 floating point number represented as a string.
int
— (String
)A signed integer represented as a string.
path
— (String
)A file system path represented as a string.
string
— (String
)A UTF-8 string.
queueId
— (String
)The queue ID.
runStatus
— (String
)The run status of the task.
Possible values include:"PENDING"
"READY"
"ASSIGNED"
"STARTING"
"SCHEDULED"
"INTERRUPTING"
"RUNNING"
"SUSPENDED"
"CANCELED"
"FAILED"
"SUCCEEDED"
"NOT_COMPATIBLE"
startedAt
— (Date
)The date and time the resource started running.
stepId
— (String
)The step ID.
targetRunStatus
— (String
)The run status that the task is being updated to.
Possible values include:"READY"
"FAILED"
"SUCCEEDED"
"CANCELED"
"SUSPENDED"
"PENDING"
taskId
— (String
)The task ID.
totalResults
— (Integer
)The total number of results in the search.
-
(AWS.Response)
—
Returns:
searchWorkers(params = {}, callback) ⇒ AWS.Request
Searches for workers.
Service Reference:
Examples:
Calling the searchWorkers operation
var params = {
farmId: 'STRING_VALUE', /* required */
fleetIds: [ /* required */
'STRING_VALUE',
/* more items */
],
itemOffset: 'NUMBER_VALUE', /* required */
filterExpressions: { /* SearchGroupedFilterExpressions */
filters: [ /* required */
{
dateTimeFilter: {
dateTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, /* required */
name: 'STRING_VALUE', /* required */
operator: EQUAL | NOT_EQUAL | GREATER_THAN_EQUAL_TO | GREATER_THAN | LESS_THAN_EQUAL_TO | LESS_THAN /* required */
},
groupFilter: /* recursive SearchGroupedFilterExpressions */,
parameterFilter: {
name: 'STRING_VALUE', /* required */
operator: EQUAL | NOT_EQUAL | GREATER_THAN_EQUAL_TO | GREATER_THAN | LESS_THAN_EQUAL_TO | LESS_THAN, /* required */
value: 'STRING_VALUE' /* required */
},
searchTermFilter: {
searchTerm: 'STRING_VALUE' /* required */
},
stringFilter: {
name: 'STRING_VALUE', /* required */
operator: EQUAL | NOT_EQUAL | GREATER_THAN_EQUAL_TO | GREATER_THAN | LESS_THAN_EQUAL_TO | LESS_THAN, /* required */
value: 'STRING_VALUE' /* required */
}
},
/* more items */
],
operator: AND | OR /* required */
},
pageSize: 'NUMBER_VALUE',
sortExpressions: [
{
fieldSort: {
name: 'STRING_VALUE', /* required */
sortOrder: ASCENDING | DESCENDING /* required */
},
parameterSort: {
name: 'STRING_VALUE', /* required */
sortOrder: ASCENDING | DESCENDING /* required */
},
userJobsFirst: {
userIdentityId: 'STRING_VALUE' /* required */
}
},
/* more items */
]
};
deadline.searchWorkers(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
farmId
— (String
)The farm ID in the workers search.
filterExpressions
— (map
)The filter expression,
AND
orOR
, to use when searching among a group of search strings in a resource.You can use two groupings per search each within parenthesis
()
.filters
— required — (Array<map>
)The filters to use for the search.
dateTimeFilter
— (map
)Filters based on date and time.
dateTime
— required — (Date
)The date and time.
name
— required — (String
)The name of the date-time field to filter on.
operator
— required — (String
)The type of comparison to use to filter the results.
Possible values include:"EQUAL"
"NOT_EQUAL"
"GREATER_THAN_EQUAL_TO"
"GREATER_THAN"
"LESS_THAN_EQUAL_TO"
"LESS_THAN"
groupFilter
— (map
)Filters by group.
operator
— required — (String
)The operators to include in the search.
Possible values include:"AND"
"OR"
parameterFilter
— (map
)Filters by parameter.
name
— required — (String
)The name of the parameter to filter on.
operator
— required — (String
)The type of comparison to use to filter results.
Possible values include:"EQUAL"
"NOT_EQUAL"
"GREATER_THAN_EQUAL_TO"
"GREATER_THAN"
"LESS_THAN_EQUAL_TO"
"LESS_THAN"
value
— required — (String
)The parameter's value.
searchTermFilter
— (map
)Filters by a specified search term.
searchTerm
— required — (String
)The term to search for.
stringFilter
— (map
)Filters by a string.
name
— required — (String
)The field name to search.
operator
— required — (String
)The type of comparison to use for this search.
Possible values include:"EQUAL"
"NOT_EQUAL"
"GREATER_THAN_EQUAL_TO"
"GREATER_THAN"
"LESS_THAN_EQUAL_TO"
"LESS_THAN"
value
— required — (String
)The string to search for.
operator
— required — (String
)The operators to include in the search.
Possible values include:"AND"
"OR"
fleetIds
— (Array<String>
)The fleet ID of the workers to search for.
itemOffset
— (Integer
)Defines how far into the scrollable list to start the return of results.
pageSize
— (Integer
)Specifies the number of items per page for the resource.
sortExpressions
— (Array<map>
)The search terms for a resource.
fieldSort
— (map
)Options for sorting by a field.
name
— required — (String
)The name of the field.
sortOrder
— required — (String
)The sort order for the field.
Possible values include:"ASCENDING"
"DESCENDING"
parameterSort
— (map
)Options for sorting by a parameter.
name
— required — (String
)The parameter name to sort by.
sortOrder
— required — (String
)The sort order for the parameter.
Possible values include:"ASCENDING"
"DESCENDING"
userJobsFirst
— (map
)Options for sorting a particular user's jobs first.
userIdentityId
— required — (String
)The user's ID.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:nextItemOffset
— (Integer
)The next incremental starting point after the defined
itemOffset
.totalResults
— (Integer
)The total number of results in the search.
workers
— (Array<map>
)The workers for the search.
createdAt
— (Date
)The date and time the resource was created.
createdBy
— (String
)The user or system that created this resource.
fleetId
— (String
)The fleet ID.
hostProperties
— (map
)Provides the Amazon EC2 instance properties of the worker host.
ec2InstanceArn
— (String
)The ARN of the host EC2 instance.
ec2InstanceType
— (String
)The instance type of the host EC2 instance.
hostName
— (String
)The host name.
ipAddresses
— (map
)The IP address of the host.
ipV4Addresses
— (Array<String>
)The IpV4 address of the network.
ipV6Addresses
— (Array<String>
)The IpV6 address for the network and node component.
status
— (String
)The status of the worker search.
Possible values include:"CREATED"
"STARTED"
"STOPPING"
"STOPPED"
"NOT_RESPONDING"
"NOT_COMPATIBLE"
"RUNNING"
"IDLE"
updatedAt
— (Date
)The date and time the resource was updated.
updatedBy
— (String
)The user or system that updated this resource.
workerId
— (String
)The worker ID.
-
(AWS.Response)
—
Returns:
startSessionsStatisticsAggregation(params = {}, callback) ⇒ AWS.Request
Starts an asynchronous request for getting aggregated statistics about queues and farms. Get the statistics using the GetSessionsStatisticsAggregation
operation. Statistics are available for 1 hour after you call the StartSessionsStatisticsAggregation
operation.
Service Reference:
Examples:
Calling the startSessionsStatisticsAggregation operation
var params = {
endTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, /* required */
farmId: 'STRING_VALUE', /* required */
groupBy: [ /* required */
QUEUE_ID | FLEET_ID | JOB_ID | USER_ID | USAGE_TYPE | INSTANCE_TYPE | LICENSE_PRODUCT,
/* more items */
],
resourceIds: { /* required */
fleetIds: [
'STRING_VALUE',
/* more items */
],
queueIds: [
'STRING_VALUE',
/* more items */
]
},
startTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, /* required */
statistics: [ /* required */
SUM | MIN | MAX | AVG,
/* more items */
],
period: HOURLY | DAILY | WEEKLY | MONTHLY,
timezone: 'STRING_VALUE'
};
deadline.startSessionsStatisticsAggregation(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
endTime
— (Date
)The Linux timestamp of the date and time that the statistics end.
farmId
— (String
)The identifier of the farm that contains queues or fleets to return statistics for.
groupBy
— (Array<String>
)The field to use to group the statistics.
period
— (String
)The period to aggregate the statistics.
Possible values include:"HOURLY"
"DAILY"
"WEEKLY"
"MONTHLY"
resourceIds
— (map
)A list of fleet IDs or queue IDs to gather statistics for.
fleetIds
— (Array<String>
)One to 10 fleet IDs that specify the fleets to return statistics for. If you specify the
fleetIds
field, you can't specify thequeueIds
field.queueIds
— (Array<String>
)One to 10 queue IDs that specify the queues to return statistics for. If you specify the
queueIds
field, you can't specify thefleetIds
field.
startTime
— (Date
)The Linux timestamp of the date and time that the statistics start.
statistics
— (Array<String>
)One to four statistics to return.
timezone
— (String
)The timezone to use for the statistics. Use UTC notation such as "UTC+8."
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:aggregationId
— (String
)A unique identifier for the aggregated statistics. Use this identifier with the
GetAggregatedStatisticsForSessions
operation to return the statistics.
-
(AWS.Response)
—
Returns:
tagResource(params = {}, callback) ⇒ AWS.Request
Tags a resource using the resource's ARN and desired tags.
Service Reference:
Examples:
Calling the tagResource operation
var params = {
resourceArn: 'STRING_VALUE', /* required */
tags: {
'<String>': 'STRING_VALUE',
/* '<String>': ... */
}
};
deadline.tagResource(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
resourceArn
— (String
)The ARN of the resource to apply tags to.
tags
— (map<String>
)Each tag consists of a tag key and a tag value. Tag keys and values are both required, but tag values can be empty strings.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs.
-
(AWS.Response)
—
Returns:
untagResource(params = {}, callback) ⇒ AWS.Request
Removes a tag from a resource using the resource's ARN and tag to remove.
Service Reference:
Examples:
Calling the untagResource operation
var params = {
resourceArn: 'STRING_VALUE', /* required */
tagKeys: [ /* required */
'STRING_VALUE',
/* more items */
]
};
deadline.untagResource(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
resourceArn
— (String
)The ARN of the resource to remove the tag from.
tagKeys
— (Array<String>
)They keys of the tag.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs.
-
(AWS.Response)
—
Returns:
updateBudget(params = {}, callback) ⇒ AWS.Request
Updates a budget that sets spending thresholds for rendering activity.
Service Reference:
Examples:
Calling the updateBudget operation
var params = {
budgetId: 'STRING_VALUE', /* required */
farmId: 'STRING_VALUE', /* required */
actionsToAdd: [
{
thresholdPercentage: 'NUMBER_VALUE', /* required */
type: STOP_SCHEDULING_AND_COMPLETE_TASKS | STOP_SCHEDULING_AND_CANCEL_TASKS, /* required */
description: 'STRING_VALUE'
},
/* more items */
],
actionsToRemove: [
{
thresholdPercentage: 'NUMBER_VALUE', /* required */
type: STOP_SCHEDULING_AND_COMPLETE_TASKS | STOP_SCHEDULING_AND_CANCEL_TASKS /* required */
},
/* more items */
],
approximateDollarLimit: 'NUMBER_VALUE',
clientToken: 'STRING_VALUE',
description: 'STRING_VALUE',
displayName: 'STRING_VALUE',
schedule: {
fixed: {
endTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, /* required */
startTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789 /* required */
}
},
status: ACTIVE | INACTIVE
};
deadline.updateBudget(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
actionsToAdd
— (Array<map>
)The budget actions to add. Budget actions specify what happens when the budget runs out.
description
— (String
)A description for the budget action to add.
thresholdPercentage
— required — (Float
)The percentage threshold for the budget action to add.
type
— required — (String
)The type of budget action to add.
Possible values include:"STOP_SCHEDULING_AND_COMPLETE_TASKS"
"STOP_SCHEDULING_AND_CANCEL_TASKS"
actionsToRemove
— (Array<map>
)The budget actions to remove from the budget.
thresholdPercentage
— required — (Float
)The percentage threshold for the budget action to remove.
type
— required — (String
)The type of budget action to remove.
Possible values include:"STOP_SCHEDULING_AND_COMPLETE_TASKS"
"STOP_SCHEDULING_AND_CANCEL_TASKS"
approximateDollarLimit
— (Float
)The dollar limit to update on the budget. Based on consumed usage.
budgetId
— (String
)The budget ID to update.
clientToken
— (String
)The unique token which the server uses to recognize retries of the same request.
If a token is not provided, the SDK will use a version 4 UUID.description
— (String
)The description of the budget to update.
displayName
— (String
)The display name of the budget to update.
farmId
— (String
)The farm ID of the budget to update.
schedule
— (map
)The schedule to update.
fixed
— (map
)The fixed start and end time of the budget's schedule.
endTime
— required — (Date
)When the budget ends.
startTime
— required — (Date
)When the budget starts.
status
— (String
)Updates the status of the budget.
-
ACTIVE
–The budget is being evaluated. -
INACTIVE
–The budget is inactive. This can include Expired, Canceled, or deleted Deleted statuses.
"ACTIVE"
"INACTIVE"
-
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs.
-
(AWS.Response)
—
Returns:
updateFarm(params = {}, callback) ⇒ AWS.Request
Updates a farm.
Service Reference:
Examples:
Calling the updateFarm operation
var params = {
farmId: 'STRING_VALUE', /* required */
description: 'STRING_VALUE',
displayName: 'STRING_VALUE'
};
deadline.updateFarm(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
description
— (String
)The description of the farm to update.
displayName
— (String
)The display name of the farm to update.
farmId
— (String
)The farm ID to update.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs.
-
(AWS.Response)
—
Returns:
updateFleet(params = {}, callback) ⇒ AWS.Request
Updates a fleet.
Service Reference:
Examples:
Calling the updateFleet operation
var params = {
farmId: 'STRING_VALUE', /* required */
fleetId: 'STRING_VALUE', /* required */
clientToken: 'STRING_VALUE',
configuration: {
customerManaged: {
mode: NO_SCALING | EVENT_BASED_AUTO_SCALING, /* required */
workerCapabilities: { /* required */
cpuArchitectureType: x86_64 | arm64, /* required */
memoryMiB: { /* required */
min: 'NUMBER_VALUE', /* required */
max: 'NUMBER_VALUE'
},
osFamily: WINDOWS | LINUX | MACOS, /* required */
vCpuCount: { /* required */
min: 'NUMBER_VALUE', /* required */
max: 'NUMBER_VALUE'
},
acceleratorCount: {
min: 'NUMBER_VALUE', /* required */
max: 'NUMBER_VALUE'
},
acceleratorTotalMemoryMiB: {
min: 'NUMBER_VALUE', /* required */
max: 'NUMBER_VALUE'
},
acceleratorTypes: [
gpu,
/* more items */
],
customAmounts: [
{
min: 'NUMBER_VALUE', /* required */
name: 'STRING_VALUE', /* required */
max: 'NUMBER_VALUE'
},
/* more items */
],
customAttributes: [
{
name: 'STRING_VALUE', /* required */
values: [ /* required */
'STRING_VALUE',
/* more items */
]
},
/* more items */
]
},
storageProfileId: 'STRING_VALUE'
},
serviceManagedEc2: {
instanceCapabilities: { /* required */
cpuArchitectureType: x86_64 | arm64, /* required */
memoryMiB: { /* required */
min: 'NUMBER_VALUE', /* required */
max: 'NUMBER_VALUE'
},
osFamily: WINDOWS | LINUX, /* required */
vCpuCount: { /* required */
min: 'NUMBER_VALUE', /* required */
max: 'NUMBER_VALUE'
},
allowedInstanceTypes: [
'STRING_VALUE',
/* more items */
],
customAmounts: [
{
min: 'NUMBER_VALUE', /* required */
name: 'STRING_VALUE', /* required */
max: 'NUMBER_VALUE'
},
/* more items */
],
customAttributes: [
{
name: 'STRING_VALUE', /* required */
values: [ /* required */
'STRING_VALUE',
/* more items */
]
},
/* more items */
],
excludedInstanceTypes: [
'STRING_VALUE',
/* more items */
],
rootEbsVolume: {
iops: 'NUMBER_VALUE',
sizeGiB: 'NUMBER_VALUE',
throughputMiB: 'NUMBER_VALUE'
}
},
instanceMarketOptions: { /* required */
type: on-demand | spot /* required */
}
}
},
description: 'STRING_VALUE',
displayName: 'STRING_VALUE',
maxWorkerCount: 'NUMBER_VALUE',
minWorkerCount: 'NUMBER_VALUE',
roleArn: 'STRING_VALUE'
};
deadline.updateFleet(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
clientToken
— (String
)The unique token which the server uses to recognize retries of the same request.
If a token is not provided, the SDK will use a version 4 UUID.configuration
— (map
)The fleet configuration to update.
customerManaged
— (map
)The customer managed fleets within a fleet configuration.
mode
— required — (String
)The Auto Scaling mode for the customer managed fleet configuration.
Possible values include:"NO_SCALING"
"EVENT_BASED_AUTO_SCALING"
storageProfileId
— (String
)The storage profile ID.
workerCapabilities
— required — (map
)The worker capabilities for a customer managed fleet configuration.
acceleratorCount
— (map
)The range of the accelerator.
max
— (Integer
)The maximum GPU for the accelerator.
min
— required — (Integer
)The minimum GPU for the accelerator.
acceleratorTotalMemoryMiB
— (map
)The total memory (MiB) for the customer managed worker capabilities.
max
— (Integer
)The maximum amount of memory to use for the accelerator, measured in MiB.
min
— required — (Integer
)The minimum amount of memory to use for the accelerator, measured in MiB.
acceleratorTypes
— (Array<String>
)The accelerator types for the customer managed worker capabilities.
cpuArchitectureType
— required — (String
)The CPU architecture type for the customer managed worker capabilities.
Possible values include:"x86_64"
"arm64"
customAmounts
— (Array<map>
)Custom requirement ranges for customer managed worker capabilities.
max
— (Float
)The maximum amount of the fleet worker capability.
min
— required — (Float
)The minimum amount of fleet worker capability.
name
— required — (String
)The name of the fleet capability.
customAttributes
— (Array<map>
)Custom attributes for the customer manged worker capabilities.
name
— required — (String
)The name of the fleet attribute capability for the worker.
values
— required — (Array<String>
)The number of fleet attribute capabilities.
memoryMiB
— required — (map
)The memory (MiB).
max
— (Integer
)The maximum amount of memory (in MiB).
min
— required — (Integer
)The minimum amount of memory (in MiB).
osFamily
— required — (String
)The operating system (OS) family.
Possible values include:"WINDOWS"
"LINUX"
"MACOS"
vCpuCount
— required — (map
)The vCPU count for the customer manged worker capabilities.
max
— (Integer
)The maximum amount of vCPU.
min
— required — (Integer
)The minimum amount of vCPU.
serviceManagedEc2
— (map
)The service managed Amazon EC2 instances for a fleet configuration.
instanceCapabilities
— required — (map
)The Amazon EC2 instance capabilities.
allowedInstanceTypes
— (Array<String>
)The allowable Amazon EC2 instance types.
cpuArchitectureType
— required — (String
)The CPU architecture type.
Possible values include:"x86_64"
"arm64"
customAmounts
— (Array<map>
)The custom capability amounts to require for instances in this fleet.
max
— (Float
)The maximum amount of the fleet worker capability.
min
— required — (Float
)The minimum amount of fleet worker capability.
name
— required — (String
)The name of the fleet capability.
customAttributes
— (Array<map>
)The custom capability attributes to require for instances in this fleet.
name
— required — (String
)The name of the fleet attribute capability for the worker.
values
— required — (Array<String>
)The number of fleet attribute capabilities.
excludedInstanceTypes
— (Array<String>
)The instance types to exclude from the fleet.
memoryMiB
— required — (map
)The memory, as MiB, for the Amazon EC2 instance type.
max
— (Integer
)The maximum amount of memory (in MiB).
min
— required — (Integer
)The minimum amount of memory (in MiB).
osFamily
— required — (String
)The operating system (OS) family.
Possible values include:"WINDOWS"
"LINUX"
rootEbsVolume
— (map
)The root EBS volume.
iops
— (Integer
)The IOPS per volume.
sizeGiB
— (Integer
)The EBS volume size in GiB.
throughputMiB
— (Integer
)The throughput per volume in MiB.
vCpuCount
— required — (map
)The amount of vCPU to require for instances in this fleet.
max
— (Integer
)The maximum amount of vCPU.
min
— required — (Integer
)The minimum amount of vCPU.
instanceMarketOptions
— required — (map
)The Amazon EC2 market type.
type
— required — (String
)The Amazon EC2 instance type.
Possible values include:"on-demand"
"spot"
description
— (String
)The description of the fleet to update.
displayName
— (String
)The display name of the fleet to update.
farmId
— (String
)The farm ID to update.
fleetId
— (String
)The fleet ID to update.
maxWorkerCount
— (Integer
)The maximum number of workers in the fleet.
minWorkerCount
— (Integer
)The minimum number of workers in the fleet.
roleArn
— (String
)The IAM role ARN that the fleet's workers assume while running jobs.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs.
-
(AWS.Response)
—
Returns:
updateJob(params = {}, callback) ⇒ AWS.Request
Updates a job.
Service Reference:
Examples:
Calling the updateJob operation
var params = {
farmId: 'STRING_VALUE', /* required */
jobId: 'STRING_VALUE', /* required */
queueId: 'STRING_VALUE', /* required */
clientToken: 'STRING_VALUE',
lifecycleStatus: ARCHIVED,
maxFailedTasksCount: 'NUMBER_VALUE',
maxRetriesPerTask: 'NUMBER_VALUE',
priority: 'NUMBER_VALUE',
targetTaskRunStatus: READY | FAILED | SUCCEEDED | CANCELED | SUSPENDED | PENDING
};
deadline.updateJob(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
clientToken
— (String
)The unique token which the server uses to recognize retries of the same request.
If a token is not provided, the SDK will use a version 4 UUID.farmId
— (String
)The farm ID of the job to update.
jobId
— (String
)The job ID to update.
lifecycleStatus
— (String
)The status of a job in its lifecycle.
Possible values include:"ARCHIVED"
maxFailedTasksCount
— (Integer
)The number of task failures before the job stops running and is marked as
FAILED
.maxRetriesPerTask
— (Integer
)The maximum number of retries for a job.
priority
— (Integer
)The job priority to update.
queueId
— (String
)The queue ID of the job to update.
targetTaskRunStatus
— (String
)The task status to update the job's tasks to.
Possible values include:"READY"
"FAILED"
"SUCCEEDED"
"CANCELED"
"SUSPENDED"
"PENDING"
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs.
-
(AWS.Response)
—
Returns:
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
.
Service Reference:
Examples:
Calling the updateMonitor operation
var params = {
monitorId: 'STRING_VALUE', /* required */
displayName: 'STRING_VALUE',
roleArn: 'STRING_VALUE',
subdomain: 'STRING_VALUE'
};
deadline.updateMonitor(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
displayName
— (String
)The new value to use for the monitor's display name.
monitorId
— (String
)The unique identifier of the monitor to update.
roleArn
— (String
)The Amazon Resource Name (ARN) of the new IAM role to use with the monitor.
subdomain
— (String
)The new value of the subdomain to use when forming the monitor URL.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs.
-
(AWS.Response)
—
Returns:
updateQueue(params = {}, callback) ⇒ AWS.Request
Updates a queue.
Service Reference:
Examples:
Calling the updateQueue operation
var params = {
farmId: 'STRING_VALUE', /* required */
queueId: 'STRING_VALUE', /* required */
allowedStorageProfileIdsToAdd: [
'STRING_VALUE',
/* more items */
],
allowedStorageProfileIdsToRemove: [
'STRING_VALUE',
/* more items */
],
clientToken: 'STRING_VALUE',
defaultBudgetAction: NONE | STOP_SCHEDULING_AND_COMPLETE_TASKS | STOP_SCHEDULING_AND_CANCEL_TASKS,
description: 'STRING_VALUE',
displayName: 'STRING_VALUE',
jobAttachmentSettings: {
rootPrefix: 'STRING_VALUE', /* required */
s3BucketName: 'STRING_VALUE' /* required */
},
jobRunAsUser: {
runAs: QUEUE_CONFIGURED_USER | WORKER_AGENT_USER, /* required */
posix: {
group: 'STRING_VALUE', /* required */
user: 'STRING_VALUE' /* required */
},
windows: {
passwordArn: 'STRING_VALUE', /* required */
user: 'STRING_VALUE' /* required */
}
},
requiredFileSystemLocationNamesToAdd: [
'STRING_VALUE',
/* more items */
],
requiredFileSystemLocationNamesToRemove: [
'STRING_VALUE',
/* more items */
],
roleArn: 'STRING_VALUE'
};
deadline.updateQueue(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
allowedStorageProfileIdsToAdd
— (Array<String>
)The storage profile IDs to add.
allowedStorageProfileIdsToRemove
— (Array<String>
)The storage profile ID to remove.
clientToken
— (String
)The idempotency token to update in the queue.
If a token is not provided, the SDK will use a version 4 UUID.defaultBudgetAction
— (String
)The default action to take for a queue update if a budget isn't configured.
Possible values include:"NONE"
"STOP_SCHEDULING_AND_COMPLETE_TASKS"
"STOP_SCHEDULING_AND_CANCEL_TASKS"
description
— (String
)The description of the queue to update.
displayName
— (String
)The display name of the queue to update.
farmId
— (String
)The farm ID to update in the queue.
jobAttachmentSettings
— (map
)The job attachment settings to update for the queue.
rootPrefix
— required — (String
)The root prefix.
s3BucketName
— required — (String
)The Amazon S3 bucket name.
jobRunAsUser
— (map
)Update the jobs in the queue to run as a specified POSIX user.
posix
— (map
)The user and group that the jobs in the queue run as.
group
— required — (String
)The name of the POSIX user's group.
user
— required — (String
)The name of the POSIX user.
runAs
— required — (String
)Specifies whether the job should run using the queue's system user or if the job should run using the worker agent system user.
Possible values include:"QUEUE_CONFIGURED_USER"
"WORKER_AGENT_USER"
windows
— (map
)Identifies a Microsoft Windows user.
passwordArn
— required — (String
)The password ARN for the Windows user.
user
— required — (String
)The user.
queueId
— (String
)The queue ID to update.
requiredFileSystemLocationNamesToAdd
— (Array<String>
)The required file system location names to add to the queue.
requiredFileSystemLocationNamesToRemove
— (Array<String>
)The required file system location names to remove from the queue.
roleArn
— (String
)The IAM role ARN that's used to run jobs from this queue.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs.
-
(AWS.Response)
—
Returns:
updateQueueEnvironment(params = {}, callback) ⇒ AWS.Request
Updates the queue environment.
Service Reference:
Examples:
Calling the updateQueueEnvironment operation
var params = {
farmId: 'STRING_VALUE', /* required */
queueEnvironmentId: 'STRING_VALUE', /* required */
queueId: 'STRING_VALUE', /* required */
clientToken: 'STRING_VALUE',
priority: 'NUMBER_VALUE',
template: 'STRING_VALUE',
templateType: JSON | YAML
};
deadline.updateQueueEnvironment(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
clientToken
— (String
)The unique token which the server uses to recognize retries of the same request.
If a token is not provided, the SDK will use a version 4 UUID.farmId
— (String
)The farm ID of the queue environment to update.
priority
— (Integer
)The priority to update.
queueEnvironmentId
— (String
)The queue environment ID to update.
queueId
— (String
)The queue ID of the queue environment to update.
template
— (String
)The template to update.
templateType
— (String
)The template type to update.
Possible values include:"JSON"
"YAML"
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs.
-
(AWS.Response)
—
Returns:
updateQueueFleetAssociation(params = {}, callback) ⇒ AWS.Request
Updates a queue-fleet association.
Service Reference:
Examples:
Calling the updateQueueFleetAssociation operation
var params = {
farmId: 'STRING_VALUE', /* required */
fleetId: 'STRING_VALUE', /* required */
queueId: 'STRING_VALUE', /* required */
status: ACTIVE | STOP_SCHEDULING_AND_COMPLETE_TASKS | STOP_SCHEDULING_AND_CANCEL_TASKS /* required */
};
deadline.updateQueueFleetAssociation(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
farmId
— (String
)The farm ID to update.
fleetId
— (String
)The fleet ID to update.
queueId
— (String
)The queue ID to update.
status
— (String
)The status to update.
Possible values include:"ACTIVE"
"STOP_SCHEDULING_AND_COMPLETE_TASKS"
"STOP_SCHEDULING_AND_CANCEL_TASKS"
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs.
-
(AWS.Response)
—
Returns:
updateSession(params = {}, callback) ⇒ AWS.Request
Updates a session.
Service Reference:
Examples:
Calling the updateSession operation
var params = {
farmId: 'STRING_VALUE', /* required */
jobId: 'STRING_VALUE', /* required */
queueId: 'STRING_VALUE', /* required */
sessionId: 'STRING_VALUE', /* required */
targetLifecycleStatus: ENDED, /* required */
clientToken: 'STRING_VALUE'
};
deadline.updateSession(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
clientToken
— (String
)The unique token which the server uses to recognize retries of the same request.
If a token is not provided, the SDK will use a version 4 UUID.farmId
— (String
)The farm ID to update in the session.
jobId
— (String
)The job ID to update in the session.
queueId
— (String
)The queue ID to update in the session.
sessionId
— (String
)The session ID to update.
targetLifecycleStatus
— (String
)The life cycle status to update in the session.
Possible values include:"ENDED"
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs.
-
(AWS.Response)
—
Returns:
updateStep(params = {}, callback) ⇒ AWS.Request
Updates a step.
Service Reference:
Examples:
Calling the updateStep operation
var params = {
farmId: 'STRING_VALUE', /* required */
jobId: 'STRING_VALUE', /* required */
queueId: 'STRING_VALUE', /* required */
stepId: 'STRING_VALUE', /* required */
targetTaskRunStatus: READY | FAILED | SUCCEEDED | CANCELED | SUSPENDED | PENDING, /* required */
clientToken: 'STRING_VALUE'
};
deadline.updateStep(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
clientToken
— (String
)The unique token which the server uses to recognize retries of the same request.
If a token is not provided, the SDK will use a version 4 UUID.farmId
— (String
)The farm ID to update.
jobId
— (String
)The job ID to update.
queueId
— (String
)The queue ID to update.
stepId
— (String
)The step ID to update.
targetTaskRunStatus
— (String
)The task status to update the step's tasks to.
Possible values include:"READY"
"FAILED"
"SUCCEEDED"
"CANCELED"
"SUSPENDED"
"PENDING"
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs.
-
(AWS.Response)
—
Returns:
updateStorageProfile(params = {}, callback) ⇒ AWS.Request
Updates a storage profile.
Service Reference:
Examples:
Calling the updateStorageProfile operation
var params = {
farmId: 'STRING_VALUE', /* required */
storageProfileId: 'STRING_VALUE', /* required */
clientToken: 'STRING_VALUE',
displayName: 'STRING_VALUE',
fileSystemLocationsToAdd: [
{
name: 'STRING_VALUE', /* required */
path: 'STRING_VALUE', /* required */
type: SHARED | LOCAL /* required */
},
/* more items */
],
fileSystemLocationsToRemove: [
{
name: 'STRING_VALUE', /* required */
path: 'STRING_VALUE', /* required */
type: SHARED | LOCAL /* required */
},
/* more items */
],
osFamily: WINDOWS | LINUX | MACOS
};
deadline.updateStorageProfile(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
clientToken
— (String
)The unique token which the server uses to recognize retries of the same request.
If a token is not provided, the SDK will use a version 4 UUID.displayName
— (String
)The display name of the storage profile to update.
farmId
— (String
)The farm ID to update.
fileSystemLocationsToAdd
— (Array<map>
)The file system location names to add.
name
— required — (String
)The location name.
path
— required — (String
)The file path.
type
— required — (String
)The type of file.
Possible values include:"SHARED"
"LOCAL"
fileSystemLocationsToRemove
— (Array<map>
)The file system location names to remove.
name
— required — (String
)The location name.
path
— required — (String
)The file path.
type
— required — (String
)The type of file.
Possible values include:"SHARED"
"LOCAL"
osFamily
— (String
)The OS system to update.
Possible values include:"WINDOWS"
"LINUX"
"MACOS"
storageProfileId
— (String
)The storage profile ID to update.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs.
-
(AWS.Response)
—
Returns:
updateTask(params = {}, callback) ⇒ AWS.Request
Updates a task.
Service Reference:
Examples:
Calling the updateTask operation
var params = {
farmId: 'STRING_VALUE', /* required */
jobId: 'STRING_VALUE', /* required */
queueId: 'STRING_VALUE', /* required */
stepId: 'STRING_VALUE', /* required */
targetRunStatus: READY | FAILED | SUCCEEDED | CANCELED | SUSPENDED | PENDING, /* required */
taskId: 'STRING_VALUE', /* required */
clientToken: 'STRING_VALUE'
};
deadline.updateTask(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
clientToken
— (String
)The unique token which the server uses to recognize retries of the same request.
If a token is not provided, the SDK will use a version 4 UUID.farmId
— (String
)The farm ID to update.
jobId
— (String
)The job ID to update.
queueId
— (String
)The queue ID to update.
stepId
— (String
)The step ID to update.
targetRunStatus
— (String
)The run status with which to start the task.
Possible values include:"READY"
"FAILED"
"SUCCEEDED"
"CANCELED"
"SUSPENDED"
"PENDING"
taskId
— (String
)The task ID to update.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs.
-
(AWS.Response)
—
Returns:
updateWorker(params = {}, callback) ⇒ AWS.Request
Updates a worker.
Service Reference:
Examples:
Calling the updateWorker operation
var params = {
farmId: 'STRING_VALUE', /* required */
fleetId: 'STRING_VALUE', /* required */
workerId: 'STRING_VALUE', /* required */
capabilities: {
amounts: [ /* required */
{
name: 'STRING_VALUE', /* required */
value: 'NUMBER_VALUE' /* required */
},
/* more items */
],
attributes: [ /* required */
{
name: 'STRING_VALUE', /* required */
values: [ /* required */
'STRING_VALUE',
/* more items */
]
},
/* more items */
]
},
hostProperties: {
hostName: 'STRING_VALUE',
ipAddresses: {
ipV4Addresses: [
'STRING_VALUE',
/* more items */
],
ipV6Addresses: [
'STRING_VALUE',
/* more items */
]
}
},
status: STARTED | STOPPING | STOPPED
};
deadline.updateWorker(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
capabilities
— (map
)The worker capabilities to update.
amounts
— required — (Array<map>
)The worker capabilities amounts on a list of worker capabilities.
name
— required — (String
)The name of the worker amount capability.
value
— required — (Float
)The value of the worker amount capability.
attributes
— required — (Array<map>
)The worker attribute capabilities in the list of attribute capabilities.
name
— required — (String
)The name of the worker attribute capability.
values
— required — (Array<String>
)The values of the worker amount capability.
farmId
— (String
)The farm ID to update.
fleetId
— (String
)The fleet ID to update.
hostProperties
— (map
)The host properties to update.
hostName
— (String
)The host name.
ipAddresses
— (map
)The IP address of the host.
ipV4Addresses
— (Array<String>
)The IpV4 address of the network.
ipV6Addresses
— (Array<String>
)The IpV6 address for the network and node component.
status
— (String
)The worker status to update.
Possible values include:"STARTED"
"STOPPING"
"STOPPED"
workerId
— (String
)The worker ID to update.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:log
— (map
)The worker log to update.
error
— (String
)The log configuration error details.
logDriver
— required — (String
)The log drivers for worker related logs.
options
— (map<String>
)The options for a log driver.
parameters
— (map<String>
)The parameters for the log configuration.
-
(AWS.Response)
—
Returns:
updateWorkerSchedule(params = {}, callback) ⇒ AWS.Request
Updates the schedule for a worker.
Service Reference:
Examples:
Calling the updateWorkerSchedule operation
var params = {
farmId: 'STRING_VALUE', /* required */
fleetId: 'STRING_VALUE', /* required */
workerId: 'STRING_VALUE', /* required */
updatedSessionActions: {
'<SessionActionId>': {
completedStatus: SUCCEEDED | FAILED | INTERRUPTED | CANCELED | NEVER_ATTEMPTED,
endedAt: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
processExitCode: 'NUMBER_VALUE',
progressMessage: 'STRING_VALUE',
progressPercent: 'NUMBER_VALUE',
startedAt: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
updatedAt: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789
},
/* '<SessionActionId>': ... */
}
};
deadline.updateWorkerSchedule(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
farmId
— (String
)The farm ID to update.
fleetId
— (String
)The fleet ID to update.
updatedSessionActions
— (map<map>
)The session actions associated with the worker schedule to update.
completedStatus
— (String
)The status of the session upon completion.
Possible values include:"SUCCEEDED"
"FAILED"
"INTERRUPTED"
"CANCELED"
"NEVER_ATTEMPTED"
endedAt
— (Date
)The date and time the resource ended running.
processExitCode
— (Integer
)The process exit code.
progressMessage
— (String
)A message to indicate the progress of the updated session action.
progressPercent
— (Float
)The percentage completed.
startedAt
— (Date
)The date and time the resource started running.
updatedAt
— (Date
)The updated time.
workerId
— (String
)The worker ID to update.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:assignedSessions
— (map<map>
)The assigned sessions to update.
jobId
— required — (String
)The job ID for the assigned session.
logConfiguration
— required — (map
)The log configuration for the worker's assigned session.
error
— (String
)The log configuration error details.
logDriver
— required — (String
)The log drivers for worker related logs.
options
— (map<String>
)The options for a log driver.
parameters
— (map<String>
)The parameters for the log configuration.
queueId
— required — (String
)The queue ID of the assigned session.
sessionActions
— required — (Array<map>
)The session actions to apply to the assigned session.
definition
— required — (map
)The definition of the assigned session action.
envEnter
— (map
)The environment a session starts on.
environmentId
— required — (String
)The environment ID of the assigned environment at the start of a session.
envExit
— (map
)The environment a session exits from.
environmentId
— required — (String
)The environment ID of the assigned environment when exiting a session.
syncInputJobAttachments
— (map
)The job attachment to sync with an assigned session action.
stepId
— (String
)The step ID.
taskRun
— (map
)The task run.
parameters
— required — (map<map>
)The parameters to include.
float
— (String
)A double precision IEEE-754 floating point number represented as a string.
int
— (String
)A signed integer represented as a string.
path
— (String
)A file system path represented as a string.
string
— (String
)A UTF-8 string.
stepId
— required — (String
)The step ID.
taskId
— required — (String
)The task ID.
sessionActionId
— required — (String
)The session action ID for the assigned session.
cancelSessionActions
— (map<Array<String>>
)The session actions associated with the worker schedule to cancel.
desiredWorkerStatus
— (String
)The status to update the worker to.
Possible values include:"STOPPED"
updateIntervalSeconds
— (Integer
)Updates the time interval (in seconds) for the schedule.
-
(AWS.Response)
—
Returns:
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.
Examples:
Waiting for the fleetActive state
var params = {
farmId: 'STRING_VALUE', /* required */
fleetId: 'STRING_VALUE' /* required */
};
deadline.waitFor('fleetActive', params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
state
(String)
—
the resource state to wait for. Available states for this service are listed in "Waiter Resource States" below.
-
params
(map)
(defaults to: {})
—
a list of parameters for the given state. See each waiter resource state for required parameters.
Callback (callback):
-
function(err, data) { ... }
Callback containing error and data information. See the respective resource state for the expected error or data information.
If the waiter times out its requests, it will return a
ResourceNotReady
error.
Returns:
Waiter Resource States:
Waiter Resource Details
deadline.waitFor('fleetActive', params = {}, [callback]) ⇒ AWS.Request
Waits for the fleetActive
state by periodically calling the underlying
Deadline.getFleet() operation every 5 seconds
(at most 180 times).
Examples:
Waiting for the fleetActive state
var params = {
farmId: 'STRING_VALUE', /* required */
fleetId: 'STRING_VALUE' /* required */
};
deadline.waitFor('fleetActive', params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
—
farmId
— (String
)The farm ID of the farm in the fleet.
fleetId
— (String
)The fleet ID of the fleet to get.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:autoScalingStatus
— (String
)The Auto Scaling status of the fleet. Either
Possible values include:GROWING
,STEADY
, orSHRINKING
."GROWING"
"STEADY"
"SHRINKING"
capabilities
— (map
)Outlines what the fleet is capable of for minimums, maximums, and naming, in addition to attribute names and values.
amounts
— (Array<map>
)Amount capabilities of the fleet.
max
— (Float
)The maximum amount of the fleet worker capability.
min
— required — (Float
)The minimum amount of fleet worker capability.
name
— required — (String
)The name of the fleet capability.
attributes
— (Array<map>
)Attribute capabilities of the fleet.
name
— required — (String
)The name of the fleet attribute capability for the worker.
values
— required — (Array<String>
)The number of fleet attribute capabilities.
configuration
— (map
)The configuration setting for the fleet.
customerManaged
— (map
)The customer managed fleets within a fleet configuration.
mode
— required — (String
)The Auto Scaling mode for the customer managed fleet configuration.
Possible values include:"NO_SCALING"
"EVENT_BASED_AUTO_SCALING"
storageProfileId
— (String
)The storage profile ID.
workerCapabilities
— required — (map
)The worker capabilities for a customer managed fleet configuration.
acceleratorCount
— (map
)The range of the accelerator.
max
— (Integer
)The maximum GPU for the accelerator.
min
— required — (Integer
)The minimum GPU for the accelerator.
acceleratorTotalMemoryMiB
— (map
)The total memory (MiB) for the customer managed worker capabilities.
max
— (Integer
)The maximum amount of memory to use for the accelerator, measured in MiB.
min
— required — (Integer
)The minimum amount of memory to use for the accelerator, measured in MiB.
acceleratorTypes
— (Array<String>
)The accelerator types for the customer managed worker capabilities.
cpuArchitectureType
— required — (String
)The CPU architecture type for the customer managed worker capabilities.
Possible values include:"x86_64"
"arm64"
customAmounts
— (Array<map>
)Custom requirement ranges for customer managed worker capabilities.
max
— (Float
)The maximum amount of the fleet worker capability.
min
— required — (Float
)The minimum amount of fleet worker capability.
name
— required — (String
)The name of the fleet capability.
customAttributes
— (Array<map>
)Custom attributes for the customer manged worker capabilities.
name
— required — (String
)The name of the fleet attribute capability for the worker.
values
— required — (Array<String>
)The number of fleet attribute capabilities.
memoryMiB
— required — (map
)The memory (MiB).
max
— (Integer
)The maximum amount of memory (in MiB).
min
— required — (Integer
)The minimum amount of memory (in MiB).
osFamily
— required — (String
)The operating system (OS) family.
Possible values include:"WINDOWS"
"LINUX"
"MACOS"
vCpuCount
— required — (map
)The vCPU count for the customer manged worker capabilities.
max
— (Integer
)The maximum amount of vCPU.
min
— required — (Integer
)The minimum amount of vCPU.
serviceManagedEc2
— (map
)The service managed Amazon EC2 instances for a fleet configuration.
instanceCapabilities
— required — (map
)The Amazon EC2 instance capabilities.
allowedInstanceTypes
— (Array<String>
)The allowable Amazon EC2 instance types.
cpuArchitectureType
— required — (String
)The CPU architecture type.
Possible values include:"x86_64"
"arm64"
customAmounts
— (Array<map>
)The custom capability amounts to require for instances in this fleet.
max
— (Float
)The maximum amount of the fleet worker capability.
min
— required — (Float
)The minimum amount of fleet worker capability.
name
— required — (String
)The name of the fleet capability.
customAttributes
— (Array<map>
)The custom capability attributes to require for instances in this fleet.
name
— required — (String
)The name of the fleet attribute capability for the worker.
values
— required — (Array<String>
)The number of fleet attribute capabilities.
excludedInstanceTypes
— (Array<String>
)The instance types to exclude from the fleet.
memoryMiB
— required — (map
)The memory, as MiB, for the Amazon EC2 instance type.
max
— (Integer
)The maximum amount of memory (in MiB).
min
— required — (Integer
)The minimum amount of memory (in MiB).
osFamily
— required — (String
)The operating system (OS) family.
Possible values include:"WINDOWS"
"LINUX"
rootEbsVolume
— (map
)The root EBS volume.
iops
— (Integer
)The IOPS per volume.
sizeGiB
— (Integer
)The EBS volume size in GiB.
throughputMiB
— (Integer
)The throughput per volume in MiB.
vCpuCount
— required — (map
)The amount of vCPU to require for instances in this fleet.
max
— (Integer
)The maximum amount of vCPU.
min
— required — (Integer
)The minimum amount of vCPU.
instanceMarketOptions
— required — (map
)The Amazon EC2 market type.
type
— required — (String
)The Amazon EC2 instance type.
Possible values include:"on-demand"
"spot"
createdAt
— (Date
)The date and time the resource was created.
createdBy
— (String
)The user or system that created this resource.
description
— (String
)The description of the fleet.
displayName
— (String
)The display name of the fleet.
farmId
— (String
)The farm ID of the farm in the fleet.
fleetId
— (String
)The fleet ID.
maxWorkerCount
— (Integer
)The maximum number of workers specified in the fleet.
minWorkerCount
— (Integer
)The minimum number of workers specified in the fleet.
roleArn
— (String
)The IAM role ARN.
status
— (String
)The Auto Scaling status of the fleet.
Possible values include:"ACTIVE"
"CREATE_IN_PROGRESS"
"UPDATE_IN_PROGRESS"
"CREATE_FAILED"
"UPDATE_FAILED"
targetWorkerCount
— (Integer
)The number of target workers in the fleet.
updatedAt
— (Date
)The date and time the resource was updated.
updatedBy
— (String
)The user or system that updated this resource.
workerCount
— (Integer
)The number of workers in the fleet.
-
(AWS.Response)
—
Returns:
See Also:
deadline.waitFor('jobCreateComplete', params = {}, [callback]) ⇒ AWS.Request
Waits for the jobCreateComplete
state by periodically calling the underlying
Deadline.getJob() operation every 1 seconds
(at most 120 times).
Examples:
Waiting for the jobCreateComplete state
var params = {
farmId: 'STRING_VALUE', /* required */
jobId: 'STRING_VALUE', /* required */
queueId: 'STRING_VALUE' /* required */
};
deadline.waitFor('jobCreateComplete', params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
—
farmId
— (String
)The farm ID of the farm in the job.
jobId
— (String
)The job ID.
queueId
— (String
)The queue ID associated with the job.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:attachments
— (map
)The attachments for the job.
fileSystem
— (String
)The file system.
Possible values include:"COPIED"
"VIRTUAL"
manifests
— required — (Array<map>
)A list of manifests which describe job attachment configurations.
fileSystemLocationName
— (String
)The file system location name.
inputManifestHash
— (String
)The has value of the file.
inputManifestPath
— (String
)The file path.
outputRelativeDirectories
— (Array<String>
)The file path relative to the directory.
rootPath
— required — (String
)The file's root path.
rootPathFormat
— required — (String
)The format of the root path.
Possible values include:"windows"
"posix"
createdAt
— (Date
)The date and time the resource was created.
createdBy
— (String
)The user or system that created this resource.
description
— (String
)The description of the job.
endedAt
— (Date
)The date and time the resource ended running.
jobId
— (String
)The job ID.
lifecycleStatus
— (String
)The life cycle status for the job.
Possible values include:"CREATE_IN_PROGRESS"
"CREATE_FAILED"
"CREATE_COMPLETE"
"UPLOAD_IN_PROGRESS"
"UPLOAD_FAILED"
"UPDATE_IN_PROGRESS"
"UPDATE_FAILED"
"UPDATE_SUCCEEDED"
"ARCHIVED"
lifecycleStatusMessage
— (String
)A message that communicates the status of the life cycle for the job.
maxFailedTasksCount
— (Integer
)The number of task failures before the job stops running and is marked as
FAILED
.maxRetriesPerTask
— (Integer
)The maximum number of retries per failed tasks.
name
— (String
)The name of the job.
parameters
— (map<map>
)The parameters for the job.
float
— (String
)A double precision IEEE-754 floating point number represented as a string.
int
— (String
)A signed integer represented as a string.
path
— (String
)A file system path represented as a string.
string
— (String
)A UTF-8 string.
priority
— (Integer
)The job priority.
startedAt
— (Date
)The date and time the resource started running.
storageProfileId
— (String
)The storage profile ID associated with the job.
targetTaskRunStatus
— (String
)The task status with which the job started.
Possible values include:"READY"
"FAILED"
"SUCCEEDED"
"CANCELED"
"SUSPENDED"
"PENDING"
taskRunStatus
— (String
)The task run status for the job.
Possible values include:"PENDING"
"READY"
"ASSIGNED"
"STARTING"
"SCHEDULED"
"INTERRUPTING"
"RUNNING"
"SUSPENDED"
"CANCELED"
"FAILED"
"SUCCEEDED"
"NOT_COMPATIBLE"
taskRunStatusCounts
— (map<Integer>
)The number of tasks running on the job.
updatedAt
— (Date
)The date and time the resource was updated.
updatedBy
— (String
)The user or system that updated this resource.
-
(AWS.Response)
—
Returns:
See Also:
deadline.waitFor('licenseEndpointDeleted', params = {}, [callback]) ⇒ AWS.Request
Waits for the licenseEndpointDeleted
state by periodically calling the underlying
Deadline.getLicenseEndpoint() operation every 10 seconds
(at most 234 times).
Examples:
Waiting for the licenseEndpointDeleted state
var params = {
licenseEndpointId: 'STRING_VALUE' /* required */
};
deadline.waitFor('licenseEndpointDeleted', params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
—
licenseEndpointId
— (String
)The license endpoint ID.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:dnsName
— (String
)The DNS name.
licenseEndpointId
— (String
)The license endpoint ID.
securityGroupIds
— (Array<String>
)The security group IDs for the license endpoint.
status
— (String
)The status of the license endpoint.
Possible values include:"CREATE_IN_PROGRESS"
"DELETE_IN_PROGRESS"
"READY"
"NOT_READY"
statusMessage
— (String
)The status message of the license endpoint.
subnetIds
— (Array<String>
)The subnet IDs.
vpcId
— (String
)The VCP(virtual private cloud) ID associated with the license endpoint.
-
(AWS.Response)
—
Returns:
See Also:
deadline.waitFor('licenseEndpointValid', params = {}, [callback]) ⇒ AWS.Request
Waits for the licenseEndpointValid
state by periodically calling the underlying
Deadline.getLicenseEndpoint() operation every 10 seconds
(at most 114 times).
Examples:
Waiting for the licenseEndpointValid state
var params = {
licenseEndpointId: 'STRING_VALUE' /* required */
};
deadline.waitFor('licenseEndpointValid', params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
—
licenseEndpointId
— (String
)The license endpoint ID.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:dnsName
— (String
)The DNS name.
licenseEndpointId
— (String
)The license endpoint ID.
securityGroupIds
— (Array<String>
)The security group IDs for the license endpoint.
status
— (String
)The status of the license endpoint.
Possible values include:"CREATE_IN_PROGRESS"
"DELETE_IN_PROGRESS"
"READY"
"NOT_READY"
statusMessage
— (String
)The status message of the license endpoint.
subnetIds
— (Array<String>
)The subnet IDs.
vpcId
— (String
)The VCP(virtual private cloud) ID associated with the license endpoint.
-
(AWS.Response)
—
Returns:
See Also:
deadline.waitFor('queueFleetAssociationStopped', params = {}, [callback]) ⇒ AWS.Request
Waits for the queueFleetAssociationStopped
state by periodically calling the underlying
Deadline.getQueueFleetAssociation() operation every 10 seconds
(at most 60 times).
Examples:
Waiting for the queueFleetAssociationStopped state
var params = {
farmId: 'STRING_VALUE', /* required */
fleetId: 'STRING_VALUE', /* required */
queueId: 'STRING_VALUE' /* required */
};
deadline.waitFor('queueFleetAssociationStopped', params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
—
farmId
— (String
)The farm ID of the farm that contains the queue-fleet association.
fleetId
— (String
)The fleet ID for the queue-fleet association.
queueId
— (String
)The queue ID for the queue-fleet association.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:createdAt
— (Date
)The date and time the resource was created.
createdBy
— (String
)The user or system that created this resource.
fleetId
— (String
)The fleet ID for the queue-fleet association.
queueId
— (String
)The queue ID for the queue-fleet association.
status
— (String
)The status of the queue-fleet association.
Possible values include:"ACTIVE"
"STOP_SCHEDULING_AND_COMPLETE_TASKS"
"STOP_SCHEDULING_AND_CANCEL_TASKS"
"STOPPED"
updatedAt
— (Date
)The date and time the resource was updated.
updatedBy
— (String
)The user or system that updated this resource.
-
(AWS.Response)
—
Returns:
See Also:
deadline.waitFor('queueScheduling', params = {}, [callback]) ⇒ AWS.Request
Waits for the queueScheduling
state by periodically calling the underlying
Deadline.getQueue() operation every 10 seconds
(at most 70 times).
Examples:
Waiting for the queueScheduling state
var params = {
farmId: 'STRING_VALUE', /* required */
queueId: 'STRING_VALUE' /* required */
};
deadline.waitFor('queueScheduling', params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
—
farmId
— (String
)The farm ID of the farm in the queue.
queueId
— (String
)The queue ID for the queue to retrieve.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:allowedStorageProfileIds
— (Array<String>
)The storage profile IDs for the queue.
blockedReason
— (String
)The reason the queue was blocked.
Possible values include:"NO_BUDGET_CONFIGURED"
"BUDGET_THRESHOLD_REACHED"
createdAt
— (Date
)The date and time the resource was created.
createdBy
— (String
)The user or system that created this resource.
defaultBudgetAction
— (String
)The default action taken on a queue if a budget wasn't configured.
Possible values include:"NONE"
"STOP_SCHEDULING_AND_COMPLETE_TASKS"
"STOP_SCHEDULING_AND_CANCEL_TASKS"
description
— (String
)The description of the queue.
displayName
— (String
)The display name of the queue.
farmId
— (String
)The farm ID for the queue.
jobAttachmentSettings
— (map
)The job attachment settings for the queue.
rootPrefix
— required — (String
)The root prefix.
s3BucketName
— required — (String
)The Amazon S3 bucket name.
jobRunAsUser
— (map
)The jobs in the queue ran as this specified POSIX user.
posix
— (map
)The user and group that the jobs in the queue run as.
group
— required — (String
)The name of the POSIX user's group.
user
— required — (String
)The name of the POSIX user.
runAs
— required — (String
)Specifies whether the job should run using the queue's system user or if the job should run using the worker agent system user.
Possible values include:"QUEUE_CONFIGURED_USER"
"WORKER_AGENT_USER"
windows
— (map
)Identifies a Microsoft Windows user.
passwordArn
— required — (String
)The password ARN for the Windows user.
user
— required — (String
)The user.
queueId
— (String
)The queue ID.
requiredFileSystemLocationNames
— (Array<String>
)A list of the required file system location names in the queue.
roleArn
— (String
)The IAM role ARN.
status
— (String
)The status of the queue.
-
ACTIVE
–The queue is active. -
SCHEDULING
–The queue is scheduling. -
SCHEDULING_BLOCKED
–The queue scheduling is blocked. See the provided reason.
"IDLE"
"SCHEDULING"
"SCHEDULING_BLOCKED"
-
updatedAt
— (Date
)The date and time the resource was updated.
updatedBy
— (String
)The user or system that updated this resource.
-
(AWS.Response)
—
Returns:
See Also:
deadline.waitFor('queueSchedulingBlocked', params = {}, [callback]) ⇒ AWS.Request
Waits for the queueSchedulingBlocked
state by periodically calling the underlying
Deadline.getQueue() operation every 10 seconds
(at most 30 times).
Examples:
Waiting for the queueSchedulingBlocked state
var params = {
farmId: 'STRING_VALUE', /* required */
queueId: 'STRING_VALUE' /* required */
};
deadline.waitFor('queueSchedulingBlocked', params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
—
farmId
— (String
)The farm ID of the farm in the queue.
queueId
— (String
)The queue ID for the queue to retrieve.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:allowedStorageProfileIds
— (Array<String>
)The storage profile IDs for the queue.
blockedReason
— (String
)The reason the queue was blocked.
Possible values include:"NO_BUDGET_CONFIGURED"
"BUDGET_THRESHOLD_REACHED"
createdAt
— (Date
)The date and time the resource was created.
createdBy
— (String
)The user or system that created this resource.
defaultBudgetAction
— (String
)The default action taken on a queue if a budget wasn't configured.
Possible values include:"NONE"
"STOP_SCHEDULING_AND_COMPLETE_TASKS"
"STOP_SCHEDULING_AND_CANCEL_TASKS"
description
— (String
)The description of the queue.
displayName
— (String
)The display name of the queue.
farmId
— (String
)The farm ID for the queue.
jobAttachmentSettings
— (map
)The job attachment settings for the queue.
rootPrefix
— required — (String
)The root prefix.
s3BucketName
— required — (String
)The Amazon S3 bucket name.
jobRunAsUser
— (map
)The jobs in the queue ran as this specified POSIX user.
posix
— (map
)The user and group that the jobs in the queue run as.
group
— required — (String
)The name of the POSIX user's group.
user
— required — (String
)The name of the POSIX user.
runAs
— required — (String
)Specifies whether the job should run using the queue's system user or if the job should run using the worker agent system user.
Possible values include:"QUEUE_CONFIGURED_USER"
"WORKER_AGENT_USER"
windows
— (map
)Identifies a Microsoft Windows user.
passwordArn
— required — (String
)The password ARN for the Windows user.
user
— required — (String
)The user.
queueId
— (String
)The queue ID.
requiredFileSystemLocationNames
— (Array<String>
)A list of the required file system location names in the queue.
roleArn
— (String
)The IAM role ARN.
status
— (String
)The status of the queue.
-
ACTIVE
–The queue is active. -
SCHEDULING
–The queue is scheduling. -
SCHEDULING_BLOCKED
–The queue scheduling is blocked. See the provided reason.
"IDLE"
"SCHEDULING"
"SCHEDULING_BLOCKED"
-
updatedAt
— (Date
)The date and time the resource was updated.
updatedBy
— (String
)The user or system that updated this resource.
-
(AWS.Response)
—
Returns:
See Also: