2025/06/26 - AWSDeadlineCloud - 6 updated api methods
Changes Added fields to track cumulative task retry attempts for steps and jobs
{'taskFailureRetryCount': '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
},
'taskFailureRetryCount': 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) --
taskFailureRetryCount (integer) --
The total number of times tasks from the job failed and were retried.
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.
{'taskFailureRetryCount': 'integer'}
Gets a step.
See also: AWS API Documentation
Request Syntax
client.get_step(
farmId='string',
queueId='string',
jobId='string',
stepId='string'
)
string
[REQUIRED]
The farm ID for the step.
string
[REQUIRED]
The queue ID for the step.
string
[REQUIRED]
The job ID for the step.
string
[REQUIRED]
The step ID.
dict
Response Syntax
{
'stepId': 'string',
'name': 'string',
'lifecycleStatus': 'CREATE_COMPLETE'|'UPDATE_IN_PROGRESS'|'UPDATE_FAILED'|'UPDATE_SUCCEEDED',
'lifecycleStatusMessage': 'string',
'taskRunStatus': 'PENDING'|'READY'|'ASSIGNED'|'STARTING'|'SCHEDULED'|'INTERRUPTING'|'RUNNING'|'SUSPENDED'|'CANCELED'|'FAILED'|'SUCCEEDED'|'NOT_COMPATIBLE',
'taskRunStatusCounts': {
'string': 123
},
'taskFailureRetryCount': 123,
'targetTaskRunStatus': 'READY'|'FAILED'|'SUCCEEDED'|'CANCELED'|'SUSPENDED'|'PENDING',
'createdAt': datetime(2015, 1, 1),
'createdBy': 'string',
'updatedAt': datetime(2015, 1, 1),
'updatedBy': 'string',
'startedAt': datetime(2015, 1, 1),
'endedAt': datetime(2015, 1, 1),
'dependencyCounts': {
'dependenciesResolved': 123,
'dependenciesUnresolved': 123,
'consumersResolved': 123,
'consumersUnresolved': 123
},
'requiredCapabilities': {
'attributes': [
{
'name': 'string',
'anyOf': [
'string',
],
'allOf': [
'string',
]
},
],
'amounts': [
{
'name': 'string',
'min': 123.0,
'max': 123.0,
'value': 123.0
},
]
},
'parameterSpace': {
'parameters': [
{
'name': 'string',
'type': 'INT'|'FLOAT'|'STRING'|'PATH'
},
],
'combination': 'string'
},
'description': 'string'
}
Response Structure
(dict) --
stepId (string) --
The step ID.
name (string) --
The name of the step.
lifecycleStatus (string) --
The life cycle status of the step.
lifecycleStatusMessage (string) --
A message that describes the lifecycle status of the step.
taskRunStatus (string) --
The task run status for the job.
taskRunStatusCounts (dict) --
The number of tasks running on the job.
(string) --
(integer) --
taskFailureRetryCount (integer) --
The total number of times tasks from the step failed and were retried.
targetTaskRunStatus (string) --
The task status with which the job started.
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.
dependencyCounts (dict) --
The number of dependencies in the step.
dependenciesResolved (integer) --
The number of resolved dependencies.
dependenciesUnresolved (integer) --
The number of unresolved dependencies.
consumersResolved (integer) --
The number of consumers resolved.
consumersUnresolved (integer) --
The number of unresolved consumers.
requiredCapabilities (dict) --
The required capabilities of the step.
attributes (list) --
The capability attributes that the step requires.
(dict) --
The list of step attributes.
name (string) --
The name of the step attribute.
anyOf (list) --
Requires any of the step attributes in a given list.
(string) --
allOf (list) --
Requires all of the step attribute values.
(string) --
amounts (list) --
The capability amounts that the step requires.
(dict) --
The details outlining the minimum and maximum capability of a step.
name (string) --
The name of the step.
min (float) --
The minimum amount.
max (float) --
The maximum amount.
value (float) --
The amount value.
parameterSpace (dict) --
A list of step parameters and the combination expression for the step.
parameters (list) --
The parameters to search for.
(dict) --
The details of a step parameter.
name (string) --
The name of the parameter.
type (string) --
The data type of the parameter.
combination (string) --
The combination expression to use in the search.
description (string) --
The description of the step.
{'jobs': {'taskFailureRetryCount': '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
},
'taskFailureRetryCount': 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) --
taskFailureRetryCount (integer) --
The total number of times tasks from the job failed and were retried.
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.
{'steps': {'taskFailureRetryCount': 'integer'}}
Lists steps for a job.
See also: AWS API Documentation
Request Syntax
client.list_steps(
farmId='string',
queueId='string',
jobId='string',
nextToken='string',
maxResults=123
)
string
[REQUIRED]
The farm ID to include on the list of steps.
string
[REQUIRED]
The queue ID to include on the list of steps.
string
[REQUIRED]
The job ID to include on the list of steps.
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
{
'steps': [
{
'stepId': 'string',
'name': 'string',
'lifecycleStatus': 'CREATE_COMPLETE'|'UPDATE_IN_PROGRESS'|'UPDATE_FAILED'|'UPDATE_SUCCEEDED',
'lifecycleStatusMessage': 'string',
'taskRunStatus': 'PENDING'|'READY'|'ASSIGNED'|'STARTING'|'SCHEDULED'|'INTERRUPTING'|'RUNNING'|'SUSPENDED'|'CANCELED'|'FAILED'|'SUCCEEDED'|'NOT_COMPATIBLE',
'taskRunStatusCounts': {
'string': 123
},
'taskFailureRetryCount': 123,
'targetTaskRunStatus': 'READY'|'FAILED'|'SUCCEEDED'|'CANCELED'|'SUSPENDED'|'PENDING',
'createdAt': datetime(2015, 1, 1),
'createdBy': 'string',
'updatedAt': datetime(2015, 1, 1),
'updatedBy': 'string',
'startedAt': datetime(2015, 1, 1),
'endedAt': datetime(2015, 1, 1),
'dependencyCounts': {
'dependenciesResolved': 123,
'dependenciesUnresolved': 123,
'consumersResolved': 123,
'consumersUnresolved': 123
}
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
steps (list) --
The steps on the list.
(dict) --
The details for a step.
stepId (string) --
The step ID.
name (string) --
The name of the step.
lifecycleStatus (string) --
The life cycle status.
lifecycleStatusMessage (string) --
A message that describes the lifecycle of the step.
taskRunStatus (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.
taskRunStatusCounts (dict) --
The number of tasks running on the job.
(string) --
(integer) --
taskFailureRetryCount (integer) --
The total number of times tasks from the step failed and were retried.
targetTaskRunStatus (string) --
The task status to start with on the job.
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.
dependencyCounts (dict) --
The number of dependencies for the step.
dependenciesResolved (integer) --
The number of resolved dependencies.
dependenciesUnresolved (integer) --
The number of unresolved dependencies.
consumersResolved (integer) --
The number of consumers resolved.
consumersUnresolved (integer) --
The number of unresolved consumers.
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': {'taskFailureRetryCount': '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',
'matchType': 'FUZZY_MATCH'|'CONTAINS'
},
'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.
matchType (string) --
Specifies how Deadline Cloud matches your search term in the results. If you don't specify a matchType the default is FUZZY_MATCH.
FUZZY_MATCH - Matches if a portion of the search term is found in the result.
CONTAINS - Matches if the exact search term is contained in the result.
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
},
'taskFailureRetryCount': 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) --
taskFailureRetryCount (integer) --
The total number of times tasks from the job failed and were retried.
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.
{'steps': {'taskFailureRetryCount': 'integer'}}
Searches for steps.
See also: AWS API Documentation
Request Syntax
client.search_steps(
farmId='string',
queueIds=[
'string',
],
jobId='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',
'matchType': 'FUZZY_MATCH'|'CONTAINS'
},
'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 to use for the step search.
list
[REQUIRED]
The queue IDs in the step search.
(string) --
string
The job ID to use in the step search.
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.
matchType (string) --
Specifies how Deadline Cloud matches your search term in the results. If you don't specify a matchType the default is FUZZY_MATCH.
FUZZY_MATCH - Matches if a portion of the search term is found in the result.
CONTAINS - Matches if the exact search term is contained in the result.
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
{
'steps': [
{
'stepId': 'string',
'jobId': 'string',
'queueId': 'string',
'name': 'string',
'lifecycleStatus': 'CREATE_COMPLETE'|'UPDATE_IN_PROGRESS'|'UPDATE_FAILED'|'UPDATE_SUCCEEDED',
'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
},
'taskFailureRetryCount': 123,
'createdAt': datetime(2015, 1, 1),
'startedAt': datetime(2015, 1, 1),
'endedAt': datetime(2015, 1, 1),
'parameterSpace': {
'parameters': [
{
'name': 'string',
'type': 'INT'|'FLOAT'|'STRING'|'PATH'
},
],
'combination': 'string'
}
},
],
'nextItemOffset': 123,
'totalResults': 123
}
Response Structure
(dict) --
steps (list) --
The steps in the search.
(dict) --
The details of a step search.
stepId (string) --
The step ID.
jobId (string) --
The job ID.
queueId (string) --
The queue ID.
name (string) --
The step 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) --
taskFailureRetryCount (integer) --
The total number of times tasks from the step failed and were retried.
createdAt (datetime) --
The date and time the resource was created.
startedAt (datetime) --
The date and time the resource started running.
endedAt (datetime) --
The date and time the resource ended running.
parameterSpace (dict) --
The parameters and combination expressions for the search.
parameters (list) --
The parameters to search for.
(dict) --
The details of a step parameter.
name (string) --
The name of the parameter.
type (string) --
The data type of the parameter.
combination (string) --
The combination expression to use in the search.
nextItemOffset (integer) --
The next incremental starting point after the defined itemOffset.
totalResults (integer) --
The total number of results in the search.