2025/01/28 - AWSDeadlineCloud - 10 new6 updated api methods
Changes feature: Deadline: Add support for limiting the concurrent usage of external resources, like floating licenses, using limits and the ability to constrain the maximum number of workers that work on a job
Creates a limit that manages the distribution of shared resources, such as floating licenses. A limit can throttle work assignments, help manage workloads, and track current usage. Before you use a limit, you must associate the limit with one or more queues.
You must add the amountRequirementName to a step in a job template to declare the limit requirement.
See also: AWS API Documentation
Request Syntax
client.create_limit(
clientToken='string',
displayName='string',
amountRequirementName='string',
maxCount=123,
farmId='string',
description='string'
)
string
The unique token which the server uses to recognize retries of the same request.
This field is autopopulated if not provided.
string
[REQUIRED]
The display name of the limit.
string
[REQUIRED]
The value that you specify as the name in the amounts field of the hostRequirements in a step of a job template to declare the limit requirement.
integer
[REQUIRED]
The maximum number of resources constrained by this limit. When all of the resources are in use, steps that require the limit won't be scheduled until the resource is available.
The maxCount must not be 0. If the value is -1, there is no restriction on the number of resources that can be acquired for this limit.
string
[REQUIRED]
The farm ID of the farm that contains the limit.
string
A description of the limit. A description helps you identify the purpose of the limit.
dict
Response Syntax
{
'limitId': 'string'
}
Response Structure
(dict) --
limitId (string) --
A unique identifier for the limit. Use this identifier in other operations, such as CreateQueueLimitAssociation and DeleteLimit.
Gets a list of limits defined in the specified farm.
See also: AWS API Documentation
Request Syntax
client.list_limits(
farmId='string',
nextToken='string',
maxResults=123
)
string
[REQUIRED]
The unique identifier of the farm that contains the limits.
string
The token for the next set of results, or null to start from the beginning.
integer
The maximum number of limits to return in each page of results.
dict
Response Syntax
{
'limits': [
{
'displayName': 'string',
'amountRequirementName': 'string',
'maxCount': 123,
'createdAt': datetime(2015, 1, 1),
'createdBy': 'string',
'updatedAt': datetime(2015, 1, 1),
'updatedBy': 'string',
'farmId': 'string',
'limitId': 'string',
'currentCount': 123
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
limits (list) --
A list of limits that the farm contains.
(dict) --
Provides information about a specific limit.
displayName (string) --
The name of the limit used in lists to identify the limit.
amountRequirementName (string) --
The value that you specify as the name in the amounts field of the hostRequirements in a step of a job template to declare the limit requirement.
maxCount (integer) --
The maximum number of resources constrained by this limit. When all of the resources are in use, steps that require the limit won't be scheduled until the resource is available.
The maxValue must not be 0. If the value is -1, there is no restriction on the number of resources that can be acquired for this limit.
createdAt (datetime) --
The Unix timestamp of the date and time that the limit was created.
createdBy (string) --
The user identifier of the person that created the limit.
updatedAt (datetime) --
The Unix timestamp of the date and time that the limit was last updated.
updatedBy (string) --
The user identifier of the person that last updated the limit.
farmId (string) --
The unique identifier of the farm that contains the limit.
limitId (string) --
The unique identifier of the limit.
currentCount (integer) --
The number of resources from the limit that are being used by jobs. The result is delayed and may not be the count at the time that you called the operation.
nextToken (string) --
If Deadline Cloud returns nextToken, then there are more results available. The value of nextToken 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, then nextToken is set to null. Each pagination token expires after 24 hours. If you provide a token that isn't valid, then you receive an HTTP 400 ValidationException error.
Gets information about a specific association between a queue and a limit.
See also: AWS API Documentation
Request Syntax
client.get_queue_limit_association(
farmId='string',
queueId='string',
limitId='string'
)
string
[REQUIRED]
The unique identifier of the farm that contains the associated queue and limit.
string
[REQUIRED]
The unique identifier of the queue associated with the limit.
string
[REQUIRED]
The unique identifier of the limit associated with the queue.
dict
Response Syntax
{
'createdAt': datetime(2015, 1, 1),
'createdBy': 'string',
'updatedAt': datetime(2015, 1, 1),
'updatedBy': 'string',
'queueId': 'string',
'limitId': 'string',
'status': 'ACTIVE'|'STOP_LIMIT_USAGE_AND_COMPLETE_TASKS'|'STOP_LIMIT_USAGE_AND_CANCEL_TASKS'|'STOPPED'
}
Response Structure
(dict) --
createdAt (datetime) --
The Unix timestamp of the date and time that the association was created.
createdBy (string) --
The user identifier of the person that created the association.
updatedAt (datetime) --
The Unix timestamp of the date and time that the association was last updated.
updatedBy (string) --
The user identifier of the person that last updated the association.
queueId (string) --
The unique identifier of the queue associated with the limit.
limitId (string) --
The unique identifier of the limit associated with the queue.
status (string) --
The current status of the limit.
Removes the association between a queue and a limit. You must use the UpdateQueueLimitAssociation operation to set the status to STOP_LIMIT_USAGE_AND_COMPLETE_TASKS or STOP_LIMIT_USAGE_AND_CANCEL_TASKS. The status does not change immediately. Use the GetQueueLimitAssociation operation to see if the status changed to STOPPED before deleting the association.
See also: AWS API Documentation
Request Syntax
client.delete_queue_limit_association(
farmId='string',
queueId='string',
limitId='string'
)
string
[REQUIRED]
The unique identifier of the farm that contains the queue and limit to disassociate.
string
[REQUIRED]
The unique identifier of the queue to disassociate.
string
[REQUIRED]
The unique identifier of the limit to disassociate.
dict
Response Syntax
{}
Response Structure
(dict) --
Updates the properties of the specified limit.
See also: AWS API Documentation
Request Syntax
client.update_limit(
farmId='string',
limitId='string',
displayName='string',
description='string',
maxCount=123
)
string
[REQUIRED]
The unique identifier of the farm that contains the limit.
string
[REQUIRED]
The unique identifier of the limit to update.
string
The new display name of the limit.
string
The new description of the limit.
integer
The maximum number of resources constrained by this limit. When all of the resources are in use, steps that require the limit won't be scheduled until the resource is available.
If more than the new maximum number is currently in use, running jobs finish but no new jobs are started until the number of resources in use is below the new maximum number.
The maxCount must not be 0. If the value is -1, there is no restriction on the number of resources that can be acquired for this limit.
dict
Response Syntax
{}
Response Structure
(dict) --
Gets a list of the associations between queues and limits defined in a farm.
See also: AWS API Documentation
Request Syntax
client.list_queue_limit_associations(
farmId='string',
queueId='string',
limitId='string',
nextToken='string',
maxResults=123
)
string
[REQUIRED]
The unique identifier of the farm that contains the limits and associations.
string
Specifies that the operation should return only the queue limit associations for the specified queue. If you specify both the queueId and the limitId, only the specified limit is returned if it exists.
string
Specifies that the operation should return only the queue limit associations for the specified limit. If you specify both the queueId and the limitId, only the specified limit is returned if it exists.
string
The token for the next set of results, or null to start from the beginning.
integer
The maximum number of associations to return in each page of results.
dict
Response Syntax
{
'queueLimitAssociations': [
{
'createdAt': datetime(2015, 1, 1),
'createdBy': 'string',
'updatedAt': datetime(2015, 1, 1),
'updatedBy': 'string',
'queueId': 'string',
'limitId': 'string',
'status': 'ACTIVE'|'STOP_LIMIT_USAGE_AND_COMPLETE_TASKS'|'STOP_LIMIT_USAGE_AND_CANCEL_TASKS'|'STOPPED'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
queueLimitAssociations (list) --
A list of associations between limits and queues in the farm specified in the request.
(dict) --
Provides information about the association between a queue and a limit.
createdAt (datetime) --
The Unix timestamp of the date and time that the association was created.
createdBy (string) --
The user identifier of the person that created the association.
updatedAt (datetime) --
The Unix timestamp of the date and time that the association was last updated.
updatedBy (string) --
The user identifier of the person that updated the association.
queueId (string) --
The unique identifier of the queue in the association.
limitId (string) --
The unique identifier of the limit in the association.
status (string) --
The status of task scheduling in the queue-limit association.
ACTIVE - Association is active.
STOP_LIMIT_USAGE_AND_COMPLETE_TASKS - Association has stopped scheduling new tasks and is completing current tasks.
STOP_LIMIT_USAGE_AND_CANCEL_TASKS - Association has stopped scheduling new tasks and is canceling current tasks.
STOPPED - Association has been stopped.
nextToken (string) --
If Deadline Cloud returns nextToken, then there are more results available. The value of nextToken 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, then nextToken is set to null. Each pagination token expires after 24 hours. If you provide a token that isn't valid, then you receive an HTTP 400 ValidationException error.
Associates a limit with a particular queue. After the limit is associated, all workers for jobs that specify the limit associated with the queue are subject to the limit. You can't associate two limits with the same amountRequirementName to the same queue.
See also: AWS API Documentation
Request Syntax
client.create_queue_limit_association(
farmId='string',
queueId='string',
limitId='string'
)
string
[REQUIRED]
The unique identifier of the farm that contains the queue and limit to associate.
string
[REQUIRED]
The unique identifier of the queue to associate with the limit.
string
[REQUIRED]
The unique identifier of the limit to associate with the queue.
dict
Response Syntax
{}
Response Structure
(dict) --
Updates the status of the queue. If you set the status to one of the STOP_LIMIT_USAGE* values, there will be a delay before the status transitions to the STOPPED state.
See also: AWS API Documentation
Request Syntax
client.update_queue_limit_association(
farmId='string',
queueId='string',
limitId='string',
status='ACTIVE'|'STOP_LIMIT_USAGE_AND_COMPLETE_TASKS'|'STOP_LIMIT_USAGE_AND_CANCEL_TASKS'
)
string
[REQUIRED]
The unique identifier of the farm that contains the associated queues and limits.
string
[REQUIRED]
The unique identifier of the queue associated to the limit.
string
[REQUIRED]
The unique identifier of the limit associated to the queue.
string
[REQUIRED]
Sets the status of the limit. You can mark the limit active, or you can stop usage of the limit and either complete existing tasks or cancel any existing tasks immediately.
dict
Response Syntax
{}
Response Structure
(dict) --
Gets information about a specific limit.
See also: AWS API Documentation
Request Syntax
client.get_limit(
farmId='string',
limitId='string'
)
string
[REQUIRED]
The unique identifier of the farm that contains the limit.
string
[REQUIRED]
The unique identifier of the limit to return.
dict
Response Syntax
{
'displayName': 'string',
'amountRequirementName': 'string',
'maxCount': 123,
'createdAt': datetime(2015, 1, 1),
'createdBy': 'string',
'updatedAt': datetime(2015, 1, 1),
'updatedBy': 'string',
'farmId': 'string',
'limitId': 'string',
'currentCount': 123,
'description': 'string'
}
Response Structure
(dict) --
displayName (string) --
The display name of the limit.
amountRequirementName (string) --
The value that you specify as the name in the amounts field of the hostRequirements in a step of a job template to declare the limit requirement.
maxCount (integer) --
The maximum number of resources constrained by this limit. When all of the resources are in use, steps that require the limit won't be scheduled until the resource is available.
The maxValue must not be 0. If the value is -1, there is no restriction on the number of resources that can be acquired for this limit.
createdAt (datetime) --
The Unix timestamp of the date and time that the limit was created.
createdBy (string) --
The user identifier of the person that created the limit.
updatedAt (datetime) --
The Unix timestamp of the date and time that the limit was last updated.
updatedBy (string) --
The user identifier of the person that last updated the limit.
farmId (string) --
The unique identifier of the farm that contains the limit.
limitId (string) --
The unique identifier of the limit.
currentCount (integer) --
The number of resources from the limit that are being used by jobs. The result is delayed and may not be the count at the time that you called the operation.
description (string) --
The description of the limit that helps identify what the limit is used for.
Removes a limit from the specified farm. Before you delete a limit you must use the DeleteQueueLimitAssociation operation to remove the association with any queues.
See also: AWS API Documentation
Request Syntax
client.delete_limit(
farmId='string',
limitId='string'
)
string
[REQUIRED]
The unique identifier of the farm that contains the limit to delete.
string
[REQUIRED]
The unique identifier of the limit to delete.
dict
Response Syntax
{}
Response Structure
(dict) --
{'maxWorkerCount': 'integer'}
Creates a job. A job is a set of instructions that Deadline Cloud uses to schedule and run work on available workers. For more information, see Deadline Cloud jobs.
See also: AWS API Documentation
Request Syntax
client.create_job(
farmId='string',
queueId='string',
clientToken='string',
template='string',
templateType='JSON'|'YAML',
priority=123,
parameters={
'string': {
'int': 'string',
'float': 'string',
'string': 'string',
'path': 'string'
}
},
attachments={
'manifests': [
{
'fileSystemLocationName': 'string',
'rootPath': 'string',
'rootPathFormat': 'windows'|'posix',
'outputRelativeDirectories': [
'string',
],
'inputManifestPath': 'string',
'inputManifestHash': 'string'
},
],
'fileSystem': 'COPIED'|'VIRTUAL'
},
storageProfileId='string',
targetTaskRunStatus='READY'|'SUSPENDED',
maxFailedTasksCount=123,
maxRetriesPerTask=123,
maxWorkerCount=123,
sourceJobId='string'
)
string
[REQUIRED]
The farm ID of the farm to connect to the job.
string
[REQUIRED]
The ID of the queue that the job is submitted to.
string
The unique token which the server uses to recognize retries of the same request.
This field is autopopulated if not provided.
string
The job template to use for this job.
string
The file type for the job template.
integer
[REQUIRED]
The priority of the job on a scale of 0 to 100. The highest priority (first scheduled) is 100. When two jobs have the same priority, the oldest job is scheduled first.
dict
The parameters for the job.
(string) --
(dict) --
The details of job parameters.
int (string) --
A signed integer represented as a string.
float (string) --
A double precision IEEE-754 floating point number represented as a string.
string (string) --
A UTF-8 string.
path (string) --
A file system path represented as a string.
dict
The attachments for the job. Attach files required for the job to run to a render job.
manifests (list) -- [REQUIRED]
A list of manifests which describe job attachment configurations.
(dict) --
The details of the manifest that links a job's source information.
fileSystemLocationName (string) --
The file system location name.
rootPath (string) -- [REQUIRED]
The file's root path.
rootPathFormat (string) -- [REQUIRED]
The format of the root path.
outputRelativeDirectories (list) --
The file path relative to the directory.
(string) --
inputManifestPath (string) --
The file path.
inputManifestHash (string) --
The hash value of the file.
fileSystem (string) --
The file system.
string
The storage profile ID for the storage profile to connect to the job.
string
The initial job status when it is created. Jobs that are created with a SUSPENDED status will not run until manually requeued.
integer
The number of task failures before the job stops running and is marked as FAILED.
integer
The maximum number of retries for each task.
integer
The maximum number of worker hosts that can concurrently process a job. When the maxWorkerCount is reached, no more workers will be assigned to process the job, even if the fleets assigned to the job's queue has available workers.
You can't set the maxWorkerCount to 0. If you set it to -1, there is no maximum number of workers.
If you don't specify the maxWorkerCount, Deadline Cloud won't throttle the number of workers used to process the job.
string
The job ID for the source job.
dict
Response Syntax
{
'jobId': 'string'
}
Response Structure
(dict) --
jobId (string) --
The job ID.
{'maxWorkerCount': 'integer'}
Gets a Deadline Cloud job.
See also: AWS API Documentation
Request Syntax
client.get_job(
farmId='string',
queueId='string',
jobId='string'
)
string
[REQUIRED]
The farm ID of the farm in the job.
string
[REQUIRED]
The queue ID associated with the job.
string
[REQUIRED]
The job ID.
dict
Response Syntax
{
'jobId': 'string',
'name': 'string',
'lifecycleStatus': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'CREATE_COMPLETE'|'UPLOAD_IN_PROGRESS'|'UPLOAD_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_FAILED'|'UPDATE_SUCCEEDED'|'ARCHIVED',
'lifecycleStatusMessage': 'string',
'priority': 123,
'createdAt': datetime(2015, 1, 1),
'createdBy': 'string',
'updatedAt': datetime(2015, 1, 1),
'updatedBy': 'string',
'startedAt': datetime(2015, 1, 1),
'endedAt': datetime(2015, 1, 1),
'taskRunStatus': 'PENDING'|'READY'|'ASSIGNED'|'STARTING'|'SCHEDULED'|'INTERRUPTING'|'RUNNING'|'SUSPENDED'|'CANCELED'|'FAILED'|'SUCCEEDED'|'NOT_COMPATIBLE',
'targetTaskRunStatus': 'READY'|'FAILED'|'SUCCEEDED'|'CANCELED'|'SUSPENDED'|'PENDING',
'taskRunStatusCounts': {
'string': 123
},
'storageProfileId': 'string',
'maxFailedTasksCount': 123,
'maxRetriesPerTask': 123,
'parameters': {
'string': {
'int': 'string',
'float': 'string',
'string': 'string',
'path': 'string'
}
},
'attachments': {
'manifests': [
{
'fileSystemLocationName': 'string',
'rootPath': 'string',
'rootPathFormat': 'windows'|'posix',
'outputRelativeDirectories': [
'string',
],
'inputManifestPath': 'string',
'inputManifestHash': 'string'
},
],
'fileSystem': 'COPIED'|'VIRTUAL'
},
'description': 'string',
'maxWorkerCount': 123,
'sourceJobId': 'string'
}
Response Structure
(dict) --
jobId (string) --
The job ID.
name (string) --
The name of the job.
lifecycleStatus (string) --
The life cycle status for the job.
lifecycleStatusMessage (string) --
A message that communicates the status of the life cycle for the job.
priority (integer) --
The job priority.
createdAt (datetime) --
The date and time the resource was created.
createdBy (string) --
The user or system that created this resource.
updatedAt (datetime) --
The date and time the resource was updated.
updatedBy (string) --
The user or system that updated this resource.
startedAt (datetime) --
The date and time the resource started running.
endedAt (datetime) --
The date and time the resource ended running.
taskRunStatus (string) --
The task run status for the job.
targetTaskRunStatus (string) --
The task status with which the job started.
taskRunStatusCounts (dict) --
The number of tasks running on the job.
(string) --
(integer) --
storageProfileId (string) --
The storage profile ID associated with 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.
parameters (dict) --
The parameters for the job.
(string) --
(dict) --
The details of job parameters.
int (string) --
A signed integer represented as a string.
float (string) --
A double precision IEEE-754 floating point number represented as a string.
string (string) --
A UTF-8 string.
path (string) --
A file system path represented as a string.
attachments (dict) --
The attachments for the job.
manifests (list) --
A list of manifests which describe job attachment configurations.
(dict) --
The details of the manifest that links a job's source information.
fileSystemLocationName (string) --
The file system location name.
rootPath (string) --
The file's root path.
rootPathFormat (string) --
The format of the root path.
outputRelativeDirectories (list) --
The file path relative to the directory.
(string) --
inputManifestPath (string) --
The file path.
inputManifestHash (string) --
The hash value of the file.
fileSystem (string) --
The file system.
description (string) --
The description of the job.
maxWorkerCount (integer) --
The maximum number of worker hosts that can concurrently process a job. When the maxWorkerCount is reached, no more workers will be assigned to process the job, even if the fleets assigned to the job's queue has available workers.
If you don't set the maxWorkerCount when you create a job, this value is not returned in the response.
sourceJobId (string) --
The job ID for the source job.
{'acquiredLimits': [{'count': 'integer', 'limitId': 'string'}]}
Gets a session action for the job.
See also: AWS API Documentation
Request Syntax
client.get_session_action(
farmId='string',
queueId='string',
jobId='string',
sessionActionId='string'
)
string
[REQUIRED]
The farm ID for the session action.
string
[REQUIRED]
The queue ID for the session action.
string
[REQUIRED]
The job ID for the session.
string
[REQUIRED]
The session action ID for the session.
dict
Response Syntax
{
'sessionActionId': 'string',
'status': 'ASSIGNED'|'RUNNING'|'CANCELING'|'SUCCEEDED'|'FAILED'|'INTERRUPTED'|'CANCELED'|'NEVER_ATTEMPTED'|'SCHEDULED'|'RECLAIMING'|'RECLAIMED',
'startedAt': datetime(2015, 1, 1),
'endedAt': datetime(2015, 1, 1),
'workerUpdatedAt': datetime(2015, 1, 1),
'progressPercent': ...,
'sessionId': 'string',
'processExitCode': 123,
'progressMessage': 'string',
'definition': {
'envEnter': {
'environmentId': 'string'
},
'envExit': {
'environmentId': 'string'
},
'taskRun': {
'taskId': 'string',
'stepId': 'string',
'parameters': {
'string': {
'int': 'string',
'float': 'string',
'string': 'string',
'path': 'string'
}
}
},
'syncInputJobAttachments': {
'stepId': 'string'
}
},
'acquiredLimits': [
{
'limitId': 'string',
'count': 123
},
]
}
Response Structure
(dict) --
sessionActionId (string) --
The session action ID.
status (string) --
The status of the session action.
startedAt (datetime) --
The date and time the resource started running.
endedAt (datetime) --
The date and time the resource ended running.
workerUpdatedAt (datetime) --
The Linux timestamp of the date and time the session action was last updated.
progressPercent (float) --
The percentage completed for a session action.
sessionId (string) --
The session ID for the session action.
processExitCode (integer) --
The exit code to exit the session.
progressMessage (string) --
The message that communicates the progress of the session action.
definition (dict) --
The session action definition.
envEnter (dict) --
The environment to enter into.
environmentId (string) --
The environment ID.
envExit (dict) --
The environment to exit from.
environmentId (string) --
The environment ID.
taskRun (dict) --
The task run in the session.
taskId (string) --
The task ID.
stepId (string) --
The step ID.
parameters (dict) --
The task parameters.
(string) --
(dict) --
The data types for the task parameters.
int (string) --
A signed integer represented as a string.
float (string) --
A double precision IEEE-754 floating point number represented as a string.
string (string) --
A UTF-8 string.
path (string) --
A file system path represented as a string.
syncInputJobAttachments (dict) --
The job attachments to sync with a session action.
stepId (string) --
The step ID for the step in the job attachment.
acquiredLimits (list) --
The limits and their amounts acquired during a session action. If no limits were acquired during the session, this field isn't returned.
(dict) --
Provides information about the number of resources used.
limitId (string) --
The unique identifier of the limit.
count (integer) --
The number of limit resources used.
{'jobs': {'maxWorkerCount': 'integer'}}
Lists jobs.
See also: AWS API Documentation
Request Syntax
client.list_jobs(
farmId='string',
principalId='string',
queueId='string',
nextToken='string',
maxResults=123
)
string
[REQUIRED]
The farm ID for the jobs.
string
The principal ID of the members on the jobs.
string
[REQUIRED]
The queue ID for the job.
string
The token for the next set of results, or null to start from the beginning.
integer
The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
dict
Response Syntax
{
'jobs': [
{
'jobId': 'string',
'name': 'string',
'lifecycleStatus': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'CREATE_COMPLETE'|'UPLOAD_IN_PROGRESS'|'UPLOAD_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_FAILED'|'UPDATE_SUCCEEDED'|'ARCHIVED',
'lifecycleStatusMessage': 'string',
'priority': 123,
'createdAt': datetime(2015, 1, 1),
'createdBy': 'string',
'updatedAt': datetime(2015, 1, 1),
'updatedBy': 'string',
'startedAt': datetime(2015, 1, 1),
'endedAt': datetime(2015, 1, 1),
'taskRunStatus': 'PENDING'|'READY'|'ASSIGNED'|'STARTING'|'SCHEDULED'|'INTERRUPTING'|'RUNNING'|'SUSPENDED'|'CANCELED'|'FAILED'|'SUCCEEDED'|'NOT_COMPATIBLE',
'targetTaskRunStatus': 'READY'|'FAILED'|'SUCCEEDED'|'CANCELED'|'SUSPENDED'|'PENDING',
'taskRunStatusCounts': {
'string': 123
},
'maxFailedTasksCount': 123,
'maxRetriesPerTask': 123,
'maxWorkerCount': 123,
'sourceJobId': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
jobs (list) --
The jobs on the list.
(dict) --
A summary of job details.
jobId (string) --
The job ID.
name (string) --
The job name.
lifecycleStatus (string) --
The life cycle status.
lifecycleStatusMessage (string) --
The life cycle status message.
priority (integer) --
The job priority.
createdAt (datetime) --
The date and time the resource was created.
createdBy (string) --
The user or system that created this resource.
updatedAt (datetime) --
The date and time the resource was updated.
updatedBy (string) --
The user or system that updated this resource.
startedAt (datetime) --
The date and time the resource started running.
endedAt (datetime) --
The date and time the resource ended running.
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.
targetTaskRunStatus (string) --
The task status to start with on the job.
taskRunStatusCounts (dict) --
The number of tasks running on the job.
(string) --
(integer) --
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.
maxWorkerCount (integer) --
The maximum number of worker hosts that can concurrently process a job. When the maxWorkerCount is reached, no more workers will be assigned to process the job, even if the fleets assigned to the job's queue has available workers.
You can't set the maxWorkerCount to 0. If you set it to -1, there is no maximum number of workers.
If you don't specify the maxWorkerCount, the default is -1.
sourceJobId (string) --
The job ID for the source job.
nextToken (string) --
If Deadline Cloud returns nextToken, then there are more results available. The value of nextToken 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, then nextToken is set to null. Each pagination token expires after 24 hours. If you provide a token that isn't valid, then you receive an HTTP 400 ValidationException error.
{'jobs': {'maxWorkerCount': 'integer'}}
Searches for jobs.
See also: AWS API Documentation
Request Syntax
client.search_jobs(
farmId='string',
queueIds=[
'string',
],
filterExpressions={
'filters': [
{
'dateTimeFilter': {
'name': 'string',
'operator': 'EQUAL'|'NOT_EQUAL'|'GREATER_THAN_EQUAL_TO'|'GREATER_THAN'|'LESS_THAN_EQUAL_TO'|'LESS_THAN',
'dateTime': datetime(2015, 1, 1)
},
'parameterFilter': {
'name': 'string',
'operator': 'EQUAL'|'NOT_EQUAL'|'GREATER_THAN_EQUAL_TO'|'GREATER_THAN'|'LESS_THAN_EQUAL_TO'|'LESS_THAN',
'value': 'string'
},
'searchTermFilter': {
'searchTerm': 'string'
},
'stringFilter': {
'name': 'string',
'operator': 'EQUAL'|'NOT_EQUAL'|'GREATER_THAN_EQUAL_TO'|'GREATER_THAN'|'LESS_THAN_EQUAL_TO'|'LESS_THAN',
'value': 'string'
},
'groupFilter': {'... recursive ...'}
},
],
'operator': 'AND'|'OR'
},
sortExpressions=[
{
'userJobsFirst': {
'userIdentityId': 'string'
},
'fieldSort': {
'sortOrder': 'ASCENDING'|'DESCENDING',
'name': 'string'
},
'parameterSort': {
'sortOrder': 'ASCENDING'|'DESCENDING',
'name': 'string'
}
},
],
itemOffset=123,
pageSize=123
)
string
[REQUIRED]
The farm ID of the job.
list
[REQUIRED]
The queue ID to use in the job search.
(string) --
dict
The filter expression, AND or OR, to use when searching among a group of search strings in a resource.
You can use two groupings per search each within parenthesis ().
filters (list) -- [REQUIRED]
The filters to use for the search.
(dict) --
The type of search filter to apply.
dateTimeFilter (dict) --
Filters based on date and time.
name (string) -- [REQUIRED]
The name of the date-time field to filter on.
operator (string) -- [REQUIRED]
The type of comparison to use to filter the results.
dateTime (datetime) -- [REQUIRED]
The date and time.
parameterFilter (dict) --
Filters by parameter.
name (string) -- [REQUIRED]
The name of the parameter to filter on.
operator (string) -- [REQUIRED]
The type of comparison to use to filter results.
value (string) -- [REQUIRED]
The parameter's value.
searchTermFilter (dict) --
Filters by a specified search term.
searchTerm (string) -- [REQUIRED]
The term to search for.
stringFilter (dict) --
Filters by a string.
name (string) -- [REQUIRED]
The field name to search.
operator (string) -- [REQUIRED]
The type of comparison to use for this search.
value (string) -- [REQUIRED]
The string to search for.
groupFilter (dict) --
Filters by group.
operator (string) -- [REQUIRED]
The operators to include in the search.
list
The search terms for a resource.
(dict) --
The resources to search.
userJobsFirst (dict) --
Options for sorting a particular user's jobs first.
userIdentityId (string) -- [REQUIRED]
The user's ID.
fieldSort (dict) --
Options for sorting by a field.
sortOrder (string) -- [REQUIRED]
The sort order for the field.
name (string) -- [REQUIRED]
The name of the field.
parameterSort (dict) --
Options for sorting by a parameter.
sortOrder (string) -- [REQUIRED]
The sort order for the parameter.
name (string) -- [REQUIRED]
The parameter name to sort by.
integer
[REQUIRED]
Defines how far into the scrollable list to start the return of results.
integer
Specifies the number of items per page for the resource.
dict
Response Syntax
{
'jobs': [
{
'jobId': 'string',
'queueId': 'string',
'name': 'string',
'lifecycleStatus': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'CREATE_COMPLETE'|'UPLOAD_IN_PROGRESS'|'UPLOAD_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_FAILED'|'UPDATE_SUCCEEDED'|'ARCHIVED',
'lifecycleStatusMessage': 'string',
'taskRunStatus': 'PENDING'|'READY'|'ASSIGNED'|'STARTING'|'SCHEDULED'|'INTERRUPTING'|'RUNNING'|'SUSPENDED'|'CANCELED'|'FAILED'|'SUCCEEDED'|'NOT_COMPATIBLE',
'targetTaskRunStatus': 'READY'|'FAILED'|'SUCCEEDED'|'CANCELED'|'SUSPENDED'|'PENDING',
'taskRunStatusCounts': {
'string': 123
},
'priority': 123,
'maxFailedTasksCount': 123,
'maxRetriesPerTask': 123,
'createdBy': 'string',
'createdAt': datetime(2015, 1, 1),
'endedAt': datetime(2015, 1, 1),
'startedAt': datetime(2015, 1, 1),
'jobParameters': {
'string': {
'int': 'string',
'float': 'string',
'string': 'string',
'path': 'string'
}
},
'maxWorkerCount': 123,
'sourceJobId': 'string'
},
],
'nextItemOffset': 123,
'totalResults': 123
}
Response Structure
(dict) --
jobs (list) --
The jobs in the search.
(dict) --
The details of a job search.
jobId (string) --
The job ID.
queueId (string) --
The queue ID.
name (string) --
The job name.
lifecycleStatus (string) --
The life cycle status.
lifecycleStatusMessage (string) --
The life cycle status message.
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.
targetTaskRunStatus (string) --
The task status to start with on the job.
taskRunStatusCounts (dict) --
The number of tasks running on the job.
(string) --
(integer) --
priority (integer) --
The job priority.
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.
createdBy (string) --
The user or system that created this resource.
createdAt (datetime) --
The date and time the resource was created.
endedAt (datetime) --
The date and time the resource ended running.
startedAt (datetime) --
The date and time the resource started running.
jobParameters (dict) --
The job parameters.
(string) --
(dict) --
The details of job parameters.
int (string) --
A signed integer represented as a string.
float (string) --
A double precision IEEE-754 floating point number represented as a string.
string (string) --
A UTF-8 string.
path (string) --
A file system path represented as a string.
maxWorkerCount (integer) --
The maximum number of worker hosts that can concurrently process a job. When the maxWorkerCount is reached, no more workers will be assigned to process the job, even if the fleets assigned to the job's queue has available workers.
You can't set the maxWorkerCount to 0. If you set it to -1, there is no maximum number of workers.
If you don't specify the maxWorkerCount, the default is -1.
sourceJobId (string) --
The job ID for the source job.
nextItemOffset (integer) --
The next incremental starting point after the defined itemOffset.
totalResults (integer) --
The total number of results in the search.
{'maxWorkerCount': 'integer'}
Updates a job.
When you change the status of the job to ARCHIVED, the job can't be scheduled or archived.
See also: AWS API Documentation
Request Syntax
client.update_job(
clientToken='string',
targetTaskRunStatus='READY'|'FAILED'|'SUCCEEDED'|'CANCELED'|'SUSPENDED'|'PENDING',
priority=123,
maxFailedTasksCount=123,
maxRetriesPerTask=123,
lifecycleStatus='ARCHIVED',
maxWorkerCount=123,
farmId='string',
queueId='string',
jobId='string'
)
string
The unique token which the server uses to recognize retries of the same request.
This field is autopopulated if not provided.
string
The task status to update the job's tasks to.
integer
The job priority to update.
integer
The number of task failures before the job stops running and is marked as FAILED.
integer
The maximum number of retries for a job.
string
The status of a job in its lifecycle. When you change the status of the job to ARCHIVED, the job can't be scheduled or archived.
integer
The maximum number of worker hosts that can concurrently process a job. When the maxWorkerCount is reached, no more workers will be assigned to process the job, even if the fleets assigned to the job's queue has available workers.
You can't set the maxWorkerCount to 0. If you set it to -1, there is no maximum number of workers.
If you don't specify the maxWorkerCount, the default is -1.
The maximum number of workers that can process tasks in the job.
string
[REQUIRED]
The farm ID of the job to update.
string
[REQUIRED]
The queue ID of the job to update.
string
[REQUIRED]
The job ID to update.
dict
Response Syntax
{}
Response Structure
(dict) --