2026/04/06 - AWSDeadlineCloud - 8 new 3 updated api methods
Changes Added 8 batch APIs (BatchGetJob, BatchGetStep, BatchGetTask, BatchGetSession, BatchGetSessionAction, BatchGetWorker, BatchUpdateJob, BatchUpdateTask) for bulk operations. Monitors can now use an Identity Center instance in a different region via the identityCenterRegion parameter.
Retrieves multiple jobs in a single request. This is a batch version of the GetJob API.
The result of getting each job is reported individually in the response. Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of 200.
See also: AWS API Documentation
Request Syntax
client.batch_get_job(
identifiers=[
{
'farmId': 'string',
'queueId': 'string',
'jobId': 'string'
},
]
)
list
[REQUIRED]
The list of job identifiers to retrieve. You can specify up to 100 identifiers per request.
(dict) --
The identifiers for a job.
farmId (string) -- [REQUIRED]
The farm ID of the job.
queueId (string) -- [REQUIRED]
The queue ID of the job.
jobId (string) -- [REQUIRED]
The job ID.
dict
Response Syntax
{
'jobs': [
{
'farmId': 'string',
'queueId': 'string',
'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'
},
],
'errors': [
{
'farmId': 'string',
'queueId': 'string',
'jobId': 'string',
'code': 'InternalServerErrorException'|'ResourceNotFoundException'|'ValidationException'|'AccessDeniedException'|'ThrottlingException',
'message': 'string'
},
]
}
Response Structure
(dict) --
jobs (list) --
A list of jobs that were successfully retrieved.
(dict) --
The details of a job returned in a batch get operation.
farmId (string) --
The farm ID of the job.
queueId (string) --
The queue ID of the job.
jobId (string) --
The job ID.
name (string) --
The name of the job.
lifecycleStatus (string) --
The life cycle status of the job.
lifecycleStatusMessage (string) --
A message that communicates the status of the life cycle.
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 to start with on the job.
taskRunStatusCounts (dict) --
The number of tasks for each run status for the job.
(string) --
(integer) --
taskFailureRetryCount (integer) --
The number of times that tasks 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) --
The manifest properties for the attachments.
(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 location for the attachments.
description (string) --
The description of the job.
maxWorkerCount (integer) --
The maximum number of worker hosts that can concurrently process a job.
sourceJobId (string) --
The job ID for the source job.
errors (list) --
A list of errors for jobs that could not be retrieved.
(dict) --
The error details for a job that could not be retrieved in a batch get operation.
farmId (string) --
The farm ID of the job that could not be retrieved.
queueId (string) --
The queue ID of the job that could not be retrieved.
jobId (string) --
The job ID of the job that could not be retrieved.
code (string) --
The error code.
message (string) --
The error message.
Retrieves multiple session actions in a single request. This is a batch version of the GetSessionAction API.
The result of getting each session action is reported individually in the response. Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of 200.
See also: AWS API Documentation
Request Syntax
client.batch_get_session_action(
identifiers=[
{
'farmId': 'string',
'queueId': 'string',
'jobId': 'string',
'sessionActionId': 'string'
},
]
)
list
[REQUIRED]
The list of session action identifiers to retrieve. You can specify up to 100 identifiers per request.
(dict) --
The identifiers for a session action.
farmId (string) -- [REQUIRED]
The farm ID of the session action.
queueId (string) -- [REQUIRED]
The queue ID of the session action.
jobId (string) -- [REQUIRED]
The job ID of the session action.
sessionActionId (string) -- [REQUIRED]
The session action ID.
dict
Response Syntax
{
'sessionActions': [
{
'farmId': 'string',
'queueId': 'string',
'jobId': 'string',
'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': ...,
'manifests': [
{
'outputManifestPath': 'string',
'outputManifestHash': 'string'
},
],
'sessionId': 'string',
'processExitCode': 123,
'progressMessage': 'string',
'acquiredLimits': [
{
'limitId': 'string',
'count': 123
},
],
'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'
}
}
},
],
'errors': [
{
'farmId': 'string',
'queueId': 'string',
'jobId': 'string',
'sessionActionId': 'string',
'code': 'InternalServerErrorException'|'ResourceNotFoundException'|'ValidationException',
'message': 'string'
},
]
}
Response Structure
(dict) --
sessionActions (list) --
A list of session actions that were successfully retrieved.
(dict) --
The details of a session action returned in a batch get operation.
farmId (string) --
The farm ID of the session action.
queueId (string) --
The queue ID of the session action.
jobId (string) --
The job ID of the 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 date and time the resource was updated by a worker.
progressPercent (float) --
The completion percentage for the session action.
manifests (list) --
The manifests for the session action.
(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.
sessionId (string) --
The session ID for the session action.
processExitCode (integer) --
The exit code to apply to the session action.
progressMessage (string) --
The message that communicates the progress of the session action.
acquiredLimits (list) --
The limits that were acquired for the session action.
(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.
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 session action definition for syncing input job attachments.
stepId (string) --
The step ID for the sync input job attachments session action.
errors (list) --
A list of errors for session actions that could not be retrieved.
(dict) --
The error details for a session action that could not be retrieved in a batch get operation.
farmId (string) --
The farm ID of the session action that could not be retrieved.
queueId (string) --
The queue ID of the session action that could not be retrieved.
jobId (string) --
The job ID of the session action that could not be retrieved.
sessionActionId (string) --
The session action ID of the session action that could not be retrieved.
code (string) --
The error code.
message (string) --
The error message.
Retrieves multiple steps in a single request. This is a batch version of the GetStep API.
The result of getting each step is reported individually in the response. Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of 200.
See also: AWS API Documentation
Request Syntax
client.batch_get_step(
identifiers=[
{
'farmId': 'string',
'queueId': 'string',
'jobId': 'string',
'stepId': 'string'
},
]
)
list
[REQUIRED]
The list of step identifiers to retrieve. You can specify up to 100 identifiers per request.
(dict) --
The identifiers for a step.
farmId (string) -- [REQUIRED]
The farm ID of the step.
queueId (string) -- [REQUIRED]
The queue ID of the step.
jobId (string) -- [REQUIRED]
The job ID of the step.
stepId (string) -- [REQUIRED]
The step ID.
dict
Response Syntax
{
'steps': [
{
'farmId': 'string',
'queueId': 'string',
'jobId': 'string',
'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',
'chunks': {
'defaultTaskCount': 123,
'targetRuntimeSeconds': 123,
'rangeConstraint': 'CONTIGUOUS'|'NONCONTIGUOUS'
}
},
],
'combination': 'string'
},
'description': 'string'
},
],
'errors': [
{
'farmId': 'string',
'queueId': 'string',
'jobId': 'string',
'stepId': 'string',
'code': 'InternalServerErrorException'|'ResourceNotFoundException'|'ValidationException'|'AccessDeniedException'|'ThrottlingException',
'message': 'string'
},
]
}
Response Structure
(dict) --
steps (list) --
A list of steps that were successfully retrieved.
(dict) --
The details of a step returned in a batch get operation.
farmId (string) --
The farm ID of the step.
queueId (string) --
The queue ID of the step.
jobId (string) --
The job ID of the step.
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 communicates the status of the life cycle.
taskRunStatus (string) --
The task run status for the step.
taskRunStatusCounts (dict) --
The number of tasks for each run status for the step.
(string) --
(integer) --
taskFailureRetryCount (integer) --
The number of times that tasks failed and were retried.
targetTaskRunStatus (string) --
The task status to start with on the step.
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.
requiredCapabilities (dict) --
The required capabilities for 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) --
The parameter space 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.
chunks (dict) --
The configuration for task chunking.
defaultTaskCount (integer) --
The number of tasks to combine into a single chunk by default.
targetRuntimeSeconds (integer) --
The number of seconds to aim for when forming chunks.
rangeConstraint (string) --
Specifies whether the chunked ranges must be contiguous or can have gaps between them.
combination (string) --
The combination expression to use in the search.
description (string) --
The description of the step.
errors (list) --
A list of errors for steps that could not be retrieved.
(dict) --
The error details for a step that could not be retrieved in a batch get operation.
farmId (string) --
The farm ID of the step that could not be retrieved.
queueId (string) --
The queue ID of the step that could not be retrieved.
jobId (string) --
The job ID of the step that could not be retrieved.
stepId (string) --
The step ID of the step that could not be retrieved.
code (string) --
The error code.
message (string) --
The error message.
Updates multiple jobs in a single request. This is a batch version of the UpdateJob API.
The result of updating each job is reported individually in the response. Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of 200.
When you change the status of a job to ARCHIVED, the job can't be scheduled or archived.
See also: AWS API Documentation
Request Syntax
client.batch_update_job(
clientToken='string',
jobs=[
{
'farmId': 'string',
'queueId': 'string',
'jobId': 'string',
'targetTaskRunStatus': 'READY'|'FAILED'|'SUCCEEDED'|'CANCELED'|'SUSPENDED'|'PENDING',
'priority': 123,
'maxFailedTasksCount': 123,
'maxRetriesPerTask': 123,
'lifecycleStatus': 'ARCHIVED',
'maxWorkerCount': 123,
'name': '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.
list
[REQUIRED]
The list of jobs to update. You can specify up to 100 jobs per request.
(dict) --
The details of a job to update in a batch update operation.
farmId (string) -- [REQUIRED]
The farm ID of the job to update.
queueId (string) -- [REQUIRED]
The queue ID of the job to update.
jobId (string) -- [REQUIRED]
The job ID of the job to update.
targetTaskRunStatus (string) --
The task status to update the job's tasks to.
priority (integer) --
The job priority to update.
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.
lifecycleStatus (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.
maxWorkerCount (integer) --
The maximum number of worker hosts that can concurrently process a job.
name (string) --
The name of the job to update.
description (string) --
The description of the job to update.
dict
Response Syntax
{
'errors': [
{
'farmId': 'string',
'queueId': 'string',
'jobId': 'string',
'code': 'ConflictException'|'InternalServerErrorException'|'ResourceNotFoundException'|'ValidationException'|'AccessDeniedException'|'ThrottlingException',
'message': 'string'
},
]
}
Response Structure
(dict) --
errors (list) --
A list of errors for jobs that could not be updated.
(dict) --
The error details for a job that could not be updated in a batch update operation.
farmId (string) --
The farm ID of the job that could not be updated.
queueId (string) --
The queue ID of the job that could not be updated.
jobId (string) --
The job ID of the job that could not be updated.
code (string) --
The error code.
message (string) --
The error message.
Retrieves multiple tasks in a single request. This is a batch version of the GetTask API.
The result of getting each task is reported individually in the response. Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of 200.
See also: AWS API Documentation
Request Syntax
client.batch_get_task(
identifiers=[
{
'farmId': 'string',
'queueId': 'string',
'jobId': 'string',
'stepId': 'string',
'taskId': 'string'
},
]
)
list
[REQUIRED]
The list of task identifiers to retrieve. You can specify up to 100 identifiers per request.
(dict) --
The identifiers for a task.
farmId (string) -- [REQUIRED]
The farm ID of the task.
queueId (string) -- [REQUIRED]
The queue ID of the task.
jobId (string) -- [REQUIRED]
The job ID of the task.
stepId (string) -- [REQUIRED]
The step ID of the task.
taskId (string) -- [REQUIRED]
The task ID.
dict
Response Syntax
{
'tasks': [
{
'farmId': 'string',
'queueId': 'string',
'jobId': 'string',
'stepId': 'string',
'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,
'startedAt': datetime(2015, 1, 1),
'endedAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1),
'updatedBy': 'string',
'latestSessionActionId': 'string',
'parameters': {
'string': {
'int': 'string',
'float': 'string',
'string': 'string',
'path': 'string',
'chunkInt': 'string'
}
}
},
],
'errors': [
{
'farmId': 'string',
'queueId': 'string',
'jobId': 'string',
'stepId': 'string',
'taskId': 'string',
'code': 'InternalServerErrorException'|'ResourceNotFoundException'|'ValidationException'|'AccessDeniedException'|'ThrottlingException',
'message': 'string'
},
]
}
Response Structure
(dict) --
tasks (list) --
A list of tasks that were successfully retrieved.
(dict) --
The details of a task returned in a batch get operation.
farmId (string) --
The farm ID of the task.
queueId (string) --
The queue ID of the task.
jobId (string) --
The job ID of the task.
stepId (string) --
The step ID of the 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 with which to start the task.
failureRetryCount (integer) --
The number of times 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.
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.
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.
errors (list) --
A list of errors for tasks that could not be retrieved.
(dict) --
The error details for a task that could not be retrieved in a batch get operation.
farmId (string) --
The farm ID of the task that could not be retrieved.
queueId (string) --
The queue ID of the task that could not be retrieved.
jobId (string) --
The job ID of the task that could not be retrieved.
stepId (string) --
The step ID of the task that could not be retrieved.
taskId (string) --
The task ID of the task that could not be retrieved.
code (string) --
The error code.
message (string) --
The error message.
Retrieves multiple sessions in a single request. This is a batch version of the GetSession API.
The result of getting each session is reported individually in the response. Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of 200.
See also: AWS API Documentation
Request Syntax
client.batch_get_session(
identifiers=[
{
'farmId': 'string',
'queueId': 'string',
'jobId': 'string',
'sessionId': 'string'
},
]
)
list
[REQUIRED]
The list of session identifiers to retrieve. You can specify up to 100 identifiers per request.
(dict) --
The identifiers for a session.
farmId (string) -- [REQUIRED]
The farm ID of the session.
queueId (string) -- [REQUIRED]
The queue ID of the session.
jobId (string) -- [REQUIRED]
The job ID of the session.
sessionId (string) -- [REQUIRED]
The session ID.
dict
Response Syntax
{
'sessions': [
{
'farmId': 'string',
'queueId': 'string',
'jobId': 'string',
'sessionId': 'string',
'fleetId': 'string',
'workerId': 'string',
'startedAt': datetime(2015, 1, 1),
'lifecycleStatus': 'STARTED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCEEDED'|'UPDATE_FAILED'|'ENDED',
'endedAt': datetime(2015, 1, 1),
'targetLifecycleStatus': 'ENDED',
'updatedAt': datetime(2015, 1, 1),
'updatedBy': 'string',
'log': {
'logDriver': 'string',
'options': {
'string': 'string'
},
'parameters': {
'string': 'string'
},
'error': 'string'
},
'hostProperties': {
'ipAddresses': {
'ipV4Addresses': [
'string',
],
'ipV6Addresses': [
'string',
]
},
'hostName': 'string',
'ec2InstanceArn': 'string',
'ec2InstanceType': 'string'
},
'workerLog': {
'logDriver': 'string',
'options': {
'string': 'string'
},
'parameters': {
'string': 'string'
},
'error': 'string'
}
},
],
'errors': [
{
'farmId': 'string',
'queueId': 'string',
'jobId': 'string',
'sessionId': 'string',
'code': 'InternalServerErrorException'|'ResourceNotFoundException'|'ValidationException',
'message': 'string'
},
]
}
Response Structure
(dict) --
sessions (list) --
A list of sessions that were successfully retrieved.
(dict) --
The details of a session returned in a batch get operation.
farmId (string) --
The farm ID of the session.
queueId (string) --
The queue ID of the session.
jobId (string) --
The job ID of the session.
sessionId (string) --
The session ID.
fleetId (string) --
The fleet ID of the session.
workerId (string) --
The worker ID of the session.
startedAt (datetime) --
The date and time the resource started running.
lifecycleStatus (string) --
The life cycle status of the session.
endedAt (datetime) --
The date and time the resource ended running.
targetLifecycleStatus (string) --
The target life cycle status for the session.
updatedAt (datetime) --
The date and time the resource was updated.
updatedBy (string) --
The user or system that updated this resource.
log (dict) --
The session log.
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.
hostProperties (dict) --
The host properties for the session.
ipAddresses (dict) --
The IP address of the host.
ipV4Addresses (list) --
The IpV4 address of the network.
(string) --
ipV6Addresses (list) --
The IpV6 address for the network and node component.
(string) --
hostName (string) --
The host name.
ec2InstanceArn (string) --
The ARN of the host EC2 instance.
ec2InstanceType (string) --
The instance type of the host EC2 instance.
workerLog (dict) --
The worker log for the 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.
errors (list) --
A list of errors for sessions that could not be retrieved.
(dict) --
The error details for a session that could not be retrieved in a batch get operation.
farmId (string) --
The farm ID of the session that could not be retrieved.
queueId (string) --
The queue ID of the session that could not be retrieved.
jobId (string) --
The job ID of the session that could not be retrieved.
sessionId (string) --
The session ID of the session that could not be retrieved.
code (string) --
The error code.
message (string) --
The error message.
Updates multiple tasks in a single request. This is a batch version of the UpdateTask API.
The result of updating each task is reported individually in the response. Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of 200.
See also: AWS API Documentation
Request Syntax
client.batch_update_task(
clientToken='string',
tasks=[
{
'farmId': 'string',
'queueId': 'string',
'jobId': 'string',
'stepId': 'string',
'taskId': 'string',
'targetRunStatus': 'READY'|'FAILED'|'SUCCEEDED'|'CANCELED'|'SUSPENDED'|'PENDING'
},
]
)
string
The unique token which the server uses to recognize retries of the same request.
This field is autopopulated if not provided.
list
[REQUIRED]
The list of tasks to update. You can specify up to 100 tasks per request.
(dict) --
The details of a task to update in a batch update operation.
farmId (string) -- [REQUIRED]
The farm ID of the task to update.
queueId (string) -- [REQUIRED]
The queue ID of the task to update.
jobId (string) -- [REQUIRED]
The job ID of the task to update.
stepId (string) -- [REQUIRED]
The step ID of the task to update.
taskId (string) -- [REQUIRED]
The task ID of the task to update.
targetRunStatus (string) -- [REQUIRED]
The run status with which to start the task.
dict
Response Syntax
{
'errors': [
{
'farmId': 'string',
'queueId': 'string',
'jobId': 'string',
'stepId': 'string',
'taskId': 'string',
'code': 'ConflictException'|'InternalServerErrorException'|'ResourceNotFoundException'|'ValidationException'|'AccessDeniedException'|'ThrottlingException',
'message': 'string'
},
]
}
Response Structure
(dict) --
errors (list) --
A list of errors for tasks that could not be updated.
(dict) --
The error details for a task that could not be updated in a batch update operation.
farmId (string) --
The farm ID of the task that could not be updated.
queueId (string) --
The queue ID of the task that could not be updated.
jobId (string) --
The job ID of the task that could not be updated.
stepId (string) --
The step ID of the task that could not be updated.
taskId (string) --
The task ID of the task that could not be updated.
code (string) --
The error code.
message (string) --
The error message.
Retrieves multiple workers in a single request. This is a batch version of the GetWorker API.
The result of getting each worker is reported individually in the response. Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of 200.
See also: AWS API Documentation
Request Syntax
client.batch_get_worker(
identifiers=[
{
'farmId': 'string',
'fleetId': 'string',
'workerId': 'string'
},
]
)
list
[REQUIRED]
The list of worker identifiers to retrieve. You can specify up to 100 identifiers per request.
(dict) --
The identifiers for a worker.
farmId (string) -- [REQUIRED]
The farm ID of the worker.
fleetId (string) -- [REQUIRED]
The fleet ID of the worker.
workerId (string) -- [REQUIRED]
The worker ID.
dict
Response Syntax
{
'workers': [
{
'farmId': 'string',
'fleetId': 'string',
'workerId': 'string',
'hostProperties': {
'ipAddresses': {
'ipV4Addresses': [
'string',
],
'ipV6Addresses': [
'string',
]
},
'hostName': 'string',
'ec2InstanceArn': 'string',
'ec2InstanceType': 'string'
},
'status': 'CREATED'|'STARTED'|'STOPPING'|'STOPPED'|'NOT_RESPONDING'|'NOT_COMPATIBLE'|'RUNNING'|'IDLE',
'log': {
'logDriver': 'string',
'options': {
'string': 'string'
},
'parameters': {
'string': 'string'
},
'error': 'string'
},
'createdAt': datetime(2015, 1, 1),
'createdBy': 'string',
'updatedAt': datetime(2015, 1, 1),
'updatedBy': 'string'
},
],
'errors': [
{
'farmId': 'string',
'fleetId': 'string',
'workerId': 'string',
'code': 'InternalServerErrorException'|'ResourceNotFoundException'|'ValidationException',
'message': 'string'
},
]
}
Response Structure
(dict) --
workers (list) --
A list of workers that were successfully retrieved.
(dict) --
The details of a worker returned in a batch get operation.
farmId (string) --
The farm ID of the worker.
fleetId (string) --
The fleet ID of the worker.
workerId (string) --
The worker ID.
hostProperties (dict) --
The host properties for the worker.
ipAddresses (dict) --
The IP address of the host.
ipV4Addresses (list) --
The IpV4 address of the network.
(string) --
ipV6Addresses (list) --
The IpV6 address for the network and node component.
(string) --
hostName (string) --
The host name.
ec2InstanceArn (string) --
The ARN of the host EC2 instance.
ec2InstanceType (string) --
The instance type of the host EC2 instance.
status (string) --
The status of the worker.
log (dict) --
The log configuration for the worker.
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.
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.
errors (list) --
A list of errors for workers that could not be retrieved.
(dict) --
The error details for a worker that could not be retrieved in a batch get operation.
farmId (string) --
The farm ID of the worker that could not be retrieved.
fleetId (string) --
The fleet ID of the worker that could not be retrieved.
workerId (string) --
The worker ID of the worker that could not be retrieved.
code (string) --
The error code.
message (string) --
The error message.
{'identityCenterRegion': 'string'}
Creates an Amazon Web Services Deadline Cloud monitor that you can use to view your farms, queues, and fleets. After you submit a job, you can track the progress of the tasks and steps that make up the job, and then download the job's results.
See also: AWS API Documentation
Request Syntax
client.create_monitor(
clientToken='string',
displayName='string',
identityCenterInstanceArn='string',
identityCenterRegion='string',
subdomain='string',
roleArn='string',
tags={
'string': '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 name that you give the monitor that is displayed in the Deadline Cloud console.
string
[REQUIRED]
The Amazon Resource Name of the IAM Identity Center instance that authenticates monitor users.
string
The AWS region where IAM Identity Center is enabled. Required when Identity Center is in a different region than the monitor.
string
[REQUIRED]
The subdomain to use when creating the monitor URL. The full URL of the monitor is subdomain.Region.deadlinecloud.amazonaws.com.
string
[REQUIRED]
The Amazon Resource Name of the IAM role that the monitor uses to connect to Deadline Cloud. Every user that signs in to the monitor using IAM Identity Center uses this role to access Deadline Cloud resources.
dict
The tags to add to your monitor. Each tag consists of a tag key and a tag value. Tag keys and values are both required, but tag values can be empty strings.
(string) --
(string) --
dict
Response Syntax
{
'monitorId': 'string',
'identityCenterApplicationArn': 'string'
}
Response Structure
(dict) --
Mixin that adds an optional ARN field to response structures. Apply to SummaryMixins (flows into Get, Summary, and BatchGet) and Create outputs.
monitorId (string) --
The unique identifier of the monitor.
identityCenterApplicationArn (string) --
The Amazon Resource Name that IAM Identity Center assigns to the monitor.
{'identityCenterRegion': 'string'}
Gets information about the specified monitor.
See also: AWS API Documentation
Request Syntax
client.get_monitor(
monitorId='string'
)
string
[REQUIRED]
The unique identifier for the monitor. This ID is returned by the CreateMonitor operation.
dict
Response Syntax
{
'monitorId': 'string',
'displayName': 'string',
'subdomain': 'string',
'url': 'string',
'roleArn': 'string',
'identityCenterInstanceArn': 'string',
'identityCenterRegion': 'string',
'identityCenterApplicationArn': 'string',
'createdAt': datetime(2015, 1, 1),
'createdBy': 'string',
'updatedAt': datetime(2015, 1, 1),
'updatedBy': 'string'
}
Response Structure
(dict) --
Mixin that adds an optional ARN field to response structures. Apply to SummaryMixins (flows into Get, Summary, and BatchGet) and Create outputs.
monitorId (string) --
The unique identifier for the monitor.
displayName (string) --
The name used to identify the monitor on the Deadline Cloud console.
subdomain (string) --
The subdomain used for the monitor URL. The full URL of the monitor is subdomain.Region.deadlinecloud.amazonaws.com.
url (string) --
The complete URL of the monitor. The full URL of the monitor is subdomain.Region.deadlinecloud.amazonaws.com.
roleArn (string) --
The Amazon Resource Name of the IAM role for the monitor. Users of the monitor use this role to access Deadline Cloud resources.
identityCenterInstanceArn (string) --
The Amazon Resource Name of the IAM Identity Center instance responsible for authenticating monitor users.
identityCenterRegion (string) --
The AWS region where IAM Identity Center is enabled.
identityCenterApplicationArn (string) --
The Amazon Resource Name that the IAM Identity Center assigned to the monitor when it was created.
createdAt (datetime) --
The UNIX timestamp of the date and time that the monitor was created.
createdBy (string) --
The user name of the person that created the monitor.
updatedAt (datetime) --
The UNIX timestamp of the last date and time that the monitor was updated.
updatedBy (string) --
The user name of the person that last updated the monitor.
{'monitors': {'identityCenterRegion': 'string'}}
Gets a list of your monitors in Deadline Cloud.
See also: AWS API Documentation
Request Syntax
client.list_monitors(
nextToken='string',
maxResults=123
)
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
{
'monitors': [
{
'monitorId': 'string',
'displayName': 'string',
'subdomain': 'string',
'url': 'string',
'roleArn': 'string',
'identityCenterInstanceArn': 'string',
'identityCenterRegion': 'string',
'identityCenterApplicationArn': 'string',
'createdAt': datetime(2015, 1, 1),
'createdBy': 'string',
'updatedAt': datetime(2015, 1, 1),
'updatedBy': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
Shared pagination field for List operation outputs (nextToken).
monitors (list) --
A list of MonitorSummary objects that describe your monitors in the Deadline Cloud.
(dict) --
Provides information about a monitor in Deadline Cloud.
monitorId (string) --
The unique identifier for the monitor.
displayName (string) --
The name of the monitor that displays on the Deadline Cloud console.
subdomain (string) --
The subdomain used for the monitor URL. The full URL of the monitor is subdomain.Region.deadlinecloud.amazonaws.com.
url (string) --
The complete URL of the monitor. The full URL of the monitor is subdomain.Region.deadlinecloud.amazonaws.com.
roleArn (string) --
The Amazon Resource Name of the IAM role for the monitor. Users of the monitor use this role to access Deadline Cloud resources.
identityCenterInstanceArn (string) --
The Amazon Resource Name of the IAM Identity Center instance responsible for authenticating monitor users.
identityCenterRegion (string) --
The AWS region where IAM Identity Center is enabled.
identityCenterApplicationArn (string) --
The Amazon Resource Name that the IAM Identity Center assigned to the monitor when it was created.
createdAt (datetime) --
The UNIX timestamp of the date and time that the monitor was created.
createdBy (string) --
The user name of the person that created the monitor.
updatedAt (datetime) --
The UNIX timestamp of the date and time that the monitor was last updated.
updatedBy (string) --
The user name of the person that last updated the monitor.
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.