2025/07/03 - AWSDeadlineCloud - 8 updated api methods
Changes Added fields for output manifest reporting and task chunking parameters
{'definition': {'taskRun': {'parameters': {'chunkInt': 'string'}}},
'manifests': [{'outputManifestHash': 'string',
'outputManifestPath': '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',
'chunkInt': 'string'
}
}
},
'syncInputJobAttachments': {
'stepId': 'string'
}
},
'acquiredLimits': [
{
'limitId': 'string',
'count': 123
},
],
'manifests': [
{
'outputManifestPath': 'string',
'outputManifestHash': 'string'
},
]
}
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 process exit code. The default Deadline Cloud worker agent converts unsigned 32-bit exit codes to signed 32-bit exit codes.
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.
chunkInt (string) --
A range (for example 1-10) or selection of specific (for example 1,3,7,8,10) integers 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.
manifests (list) --
The list of manifest properties that describe file attachments for the task run.
(dict) --
The manifest properties for a task run, corresponding to the manifest properties in the job.
outputManifestPath (string) --
The manifest file path.
outputManifestHash (string) --
The hash value of the file.
{'parameterSpace': {'parameters': {'type': {'CHUNK_INT'}}}}
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'|'CHUNK_INT'
},
],
'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.
{'parameters': {'chunkInt': 'string'}}
Gets a task.
See also: AWS API Documentation
Request Syntax
client.get_task(
farmId='string',
queueId='string',
jobId='string',
stepId='string',
taskId='string'
)
string
[REQUIRED]
The farm ID of the farm connected to the task.
string
[REQUIRED]
The queue ID for the queue connected to the task.
string
[REQUIRED]
The job ID of the job connected to the task.
string
[REQUIRED]
The step ID for the step connected to the task.
string
[REQUIRED]
The task ID.
dict
Response Syntax
{
'taskId': 'string',
'createdAt': datetime(2015, 1, 1),
'createdBy': 'string',
'runStatus': 'PENDING'|'READY'|'ASSIGNED'|'STARTING'|'SCHEDULED'|'INTERRUPTING'|'RUNNING'|'SUSPENDED'|'CANCELED'|'FAILED'|'SUCCEEDED'|'NOT_COMPATIBLE',
'targetRunStatus': 'READY'|'FAILED'|'SUCCEEDED'|'CANCELED'|'SUSPENDED'|'PENDING',
'failureRetryCount': 123,
'parameters': {
'string': {
'int': 'string',
'float': 'string',
'string': 'string',
'path': 'string',
'chunkInt': 'string'
}
},
'startedAt': datetime(2015, 1, 1),
'endedAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1),
'updatedBy': 'string',
'latestSessionActionId': 'string'
}
Response Structure
(dict) --
taskId (string) --
The task ID.
createdAt (datetime) --
The date and time the resource was created.
createdBy (string) --
The user or system that created this resource.
runStatus (string) --
The run status for the task.
targetRunStatus (string) --
The run status with which to start the task.
failureRetryCount (integer) --
The number of times that the task failed and was retried.
parameters (dict) --
The parameters for the task.
(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.
chunkInt (string) --
A range (for example 1-10) or selection of specific (for example 1,3,7,8,10) integers represented as a string.
startedAt (datetime) --
The date and time the resource started running.
endedAt (datetime) --
The date and time the resource ended running.
updatedAt (datetime) --
The date and time the resource was updated.
updatedBy (string) --
The user or system that updated this resource.
latestSessionActionId (string) --
The latest session ID for the task.
{'sessionActions': {'definition': {'taskRun': {'parameters': {'string': {'chunkInt': 'string',
'float': 'string',
'int': 'string',
'path': 'string',
'string': 'string'}}}},
'manifests': [{'outputManifestHash': 'string',
'outputManifestPath': 'string'}]}}
Lists session actions.
See also: AWS API Documentation
Request Syntax
client.list_session_actions(
farmId='string',
queueId='string',
jobId='string',
sessionId='string',
taskId='string',
nextToken='string',
maxResults=123
)
string
[REQUIRED]
The farm ID for the session actions list.
string
[REQUIRED]
The queue ID for the session actions list.
string
[REQUIRED]
The job ID for the session actions list.
string
The session ID to include on the sessions action list.
string
The task ID for the session actions list.
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
{
'sessionActions': [
{
'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': ...,
'definition': {
'envEnter': {
'environmentId': 'string'
},
'envExit': {
'environmentId': 'string'
},
'taskRun': {
'taskId': 'string',
'stepId': 'string',
'parameters': {
'string': {
'int': 'string',
'float': 'string',
'string': 'string',
'path': 'string',
'chunkInt': 'string'
}
}
},
'syncInputJobAttachments': {
'stepId': 'string'
}
},
'manifests': [
{
'outputManifestPath': 'string',
'outputManifestHash': 'string'
},
]
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
sessionActions (list) --
The session actions.
(dict) --
The details of a session action.
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 last date and time that the session action was updated.
progressPercent (float) --
The completion percentage for 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.
taskId (string) --
The task ID.
stepId (string) --
The step ID.
parameters (dict) --
The parameters of a task run in a session action.
(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.
chunkInt (string) --
A range (for example 1-10) or selection of specific (for example 1,3,7,8,10) integers represented as a string.
syncInputJobAttachments (dict) --
The job attachments to sync with the session action definition.
stepId (string) --
The step ID of the step in the job attachment.
manifests (list) --
The list of manifest properties that describe file attachments for the task run.
(dict) --
The manifest properties for a task run, corresponding to the manifest properties in the job.
outputManifestPath (string) --
The manifest file path.
outputManifestHash (string) --
The hash value of the file.
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.
{'tasks': {'parameters': {'chunkInt': 'string'}}}
Lists tasks for a job.
See also: AWS API Documentation
Request Syntax
client.list_tasks(
farmId='string',
queueId='string',
jobId='string',
stepId='string',
nextToken='string',
maxResults=123
)
string
[REQUIRED]
The farm ID connected to the tasks.
string
[REQUIRED]
The queue ID connected to the tasks.
string
[REQUIRED]
The job ID for the tasks.
string
[REQUIRED]
The step ID for the tasks.
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
{
'tasks': [
{
'taskId': 'string',
'createdAt': datetime(2015, 1, 1),
'createdBy': 'string',
'runStatus': 'PENDING'|'READY'|'ASSIGNED'|'STARTING'|'SCHEDULED'|'INTERRUPTING'|'RUNNING'|'SUSPENDED'|'CANCELED'|'FAILED'|'SUCCEEDED'|'NOT_COMPATIBLE',
'targetRunStatus': 'READY'|'FAILED'|'SUCCEEDED'|'CANCELED'|'SUSPENDED'|'PENDING',
'failureRetryCount': 123,
'parameters': {
'string': {
'int': 'string',
'float': 'string',
'string': 'string',
'path': 'string',
'chunkInt': 'string'
}
},
'startedAt': datetime(2015, 1, 1),
'endedAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1),
'updatedBy': 'string',
'latestSessionActionId': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
tasks (list) --
Tasks for the job.
(dict) --
The details of a task.
taskId (string) --
The task ID.
createdAt (datetime) --
The date and time the resource was created.
createdBy (string) --
The user or system that created this resource.
runStatus (string) --
The run status of the task.
targetRunStatus (string) --
The run status on which the started.
failureRetryCount (integer) --
The number of times that the task failed and was retried.
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.
chunkInt (string) --
A range (for example 1-10) or selection of specific (for example 1,3,7,8,10) integers represented as a string.
startedAt (datetime) --
The date and time the resource started running.
endedAt (datetime) --
The date and time the resource ended running.
updatedAt (datetime) --
The date and time the resource was updated.
updatedBy (string) --
The user or system that updated this resource.
latestSessionActionId (string) --
The latest session action for the task.
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': {'parameterSpace': {'parameters': {'type': {'CHUNK_INT'}}}}}
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'|'CHUNK_INT'
},
],
'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.
{'tasks': {'parameters': {'chunkInt': 'string'}}}
Searches for tasks.
See also: AWS API Documentation
Request Syntax
client.search_tasks(
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 of the task.
list
[REQUIRED]
The queue IDs to include in the search.
(string) --
string
The job ID for the task 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
{
'tasks': [
{
'taskId': 'string',
'stepId': 'string',
'jobId': 'string',
'queueId': 'string',
'runStatus': 'PENDING'|'READY'|'ASSIGNED'|'STARTING'|'SCHEDULED'|'INTERRUPTING'|'RUNNING'|'SUSPENDED'|'CANCELED'|'FAILED'|'SUCCEEDED'|'NOT_COMPATIBLE',
'targetRunStatus': 'READY'|'FAILED'|'SUCCEEDED'|'CANCELED'|'SUSPENDED'|'PENDING',
'parameters': {
'string': {
'int': 'string',
'float': 'string',
'string': 'string',
'path': 'string',
'chunkInt': 'string'
}
},
'failureRetryCount': 123,
'startedAt': datetime(2015, 1, 1),
'endedAt': datetime(2015, 1, 1)
},
],
'nextItemOffset': 123,
'totalResults': 123
}
Response Structure
(dict) --
tasks (list) --
Tasks in the search.
(dict) --
The details of a task search.
taskId (string) --
The task ID.
stepId (string) --
The step ID.
jobId (string) --
The job ID.
queueId (string) --
The queue ID.
runStatus (string) --
The run status of the task.
targetRunStatus (string) --
The run status that the task is being updated to.
parameters (dict) --
The parameters to search for.
(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.
chunkInt (string) --
A range (for example 1-10) or selection of specific (for example 1,3,7,8,10) integers represented as a string.
failureRetryCount (integer) --
The number of times that the task failed and was retried.
startedAt (datetime) --
The date and time the resource started running.
endedAt (datetime) --
The date and time the resource ended running.
nextItemOffset (integer) --
The next incremental starting point after the defined itemOffset.
totalResults (integer) --
The total number of results in the search.
{'updatedSessionActions': {'manifests': [{'outputManifestHash': 'string',
'outputManifestPath': 'string'}]}}
Response {'assignedSessions': {'sessionActions': {'definition': {'taskRun': {'parameters': {'chunkInt': 'string'}}}}}}
Updates the schedule for a worker.
See also: AWS API Documentation
Request Syntax
client.update_worker_schedule(
farmId='string',
fleetId='string',
workerId='string',
updatedSessionActions={
'string': {
'completedStatus': 'SUCCEEDED'|'FAILED'|'INTERRUPTED'|'CANCELED'|'NEVER_ATTEMPTED',
'processExitCode': 123,
'progressMessage': 'string',
'startedAt': datetime(2015, 1, 1),
'endedAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1),
'progressPercent': ...,
'manifests': [
{
'outputManifestPath': 'string',
'outputManifestHash': 'string'
},
]
}
}
)
string
[REQUIRED]
The farm ID to update.
string
[REQUIRED]
The fleet ID to update.
string
[REQUIRED]
The worker ID to update.
dict
The session actions associated with the worker schedule to update.
(string) --
(dict) --
The updated session action information as it relates to completion and progress of the session.
completedStatus (string) --
The status of the session upon completion.
processExitCode (integer) --
The process exit code. The default Deadline Cloud worker agent converts unsigned 32-bit exit codes to signed 32-bit exit codes.
progressMessage (string) --
A message to indicate the progress of the updated session action.
startedAt (datetime) --
The date and time the resource started running.
endedAt (datetime) --
The date and time the resource ended running.
updatedAt (datetime) --
The updated time.
progressPercent (float) --
The percentage completed.
manifests (list) --
A list of output manifest properties reported by the worker agent, with each entry corresponding to a manifest property in the job.
(dict) --
The output manifest properties reported by the worker agent for a completed task run.
outputManifestPath (string) --
The manifest file path.
outputManifestHash (string) --
The hash value of the file.
dict
Response Syntax
{
'assignedSessions': {
'string': {
'queueId': 'string',
'jobId': 'string',
'sessionActions': [
{
'sessionActionId': 'string',
'definition': {
'envEnter': {
'environmentId': 'string'
},
'envExit': {
'environmentId': 'string'
},
'taskRun': {
'taskId': 'string',
'stepId': 'string',
'parameters': {
'string': {
'int': 'string',
'float': 'string',
'string': 'string',
'path': 'string',
'chunkInt': 'string'
}
}
},
'syncInputJobAttachments': {
'stepId': 'string'
}
}
},
],
'logConfiguration': {
'logDriver': 'string',
'options': {
'string': 'string'
},
'parameters': {
'string': 'string'
},
'error': 'string'
}
}
},
'cancelSessionActions': {
'string': [
'string',
]
},
'desiredWorkerStatus': 'STOPPED',
'updateIntervalSeconds': 123
}
Response Structure
(dict) --
assignedSessions (dict) --
The assigned sessions to update.
(string) --
(dict) --
The assigned session for the worker.
queueId (string) --
The queue ID of the assigned session.
jobId (string) --
The job ID for the assigned session.
sessionActions (list) --
The session actions to apply to the assigned session.
(dict) --
The action for a session defined by the session action ID.
sessionActionId (string) --
The session action ID for the assigned session.
definition (dict) --
The definition of the assigned session action.
envEnter (dict) --
The environment a session starts on.
environmentId (string) --
The environment ID of the assigned environment at the start of a session.
envExit (dict) --
The environment a session exits from.
environmentId (string) --
The environment ID of the assigned environment when exiting a session.
taskRun (dict) --
The task run.
taskId (string) --
The task ID.
stepId (string) --
The step ID.
parameters (dict) --
The parameters to include.
(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.
chunkInt (string) --
A range (for example 1-10) or selection of specific (for example 1,3,7,8,10) integers represented as a string.
syncInputJobAttachments (dict) --
The job attachment to sync with an assigned session action.
stepId (string) --
The step ID.
logConfiguration (dict) --
The log configuration for the worker's assigned session.
logDriver (string) --
The log drivers for worker related logs.
options (dict) --
The options for a log driver.
(string) --
(string) --
parameters (dict) --
The parameters for the log configuration.
(string) --
(string) --
error (string) --
The log configuration error details.
cancelSessionActions (dict) --
The session actions associated with the worker schedule to cancel.
(string) --
(list) --
(string) --
desiredWorkerStatus (string) --
The status to update the worker to.
updateIntervalSeconds (integer) --
Updates the time interval (in seconds) for the schedule.