2026/09/29 - AWSDeadlineCloud - 10 updated api methods
Changes AWS Deadline Cloud now supports Docker software add-ons on service-managed fleets. Adds support for Open Job Description EXPR and Feature Bundle 1 job templates with typed job parameters and job, step, and parameter names up to 512 characters.
{'jobs': {'parameters': {'bool': 'string',
'boolList': ['string'],
'floatList': ['string'],
'intList': ['string'],
'intListList': [['string']],
'pathList': ['string'],
'rangeExpr': 'string',
'stringList': ['string']}}}
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',
'bool': 'string',
'rangeExpr': 'string',
'stringList': [
'string',
],
'pathList': [
'string',
],
'intList': [
'string',
],
'floatList': [
'string',
],
'boolList': [
'string',
],
'intListList': [
[
'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.
bool (string) --
A boolean value represented as a string. Accepted values are true, false, yes, no, on, off, 1, and 0, case-insensitive.
rangeExpr (string) --
An Open Job Description range expression represented as a string, such as 1-10:2.
stringList (list) --
A list of UTF-8 strings.
(string) --
pathList (list) --
A list of file system paths, each represented as a string.
(string) --
intList (list) --
A list of signed integers, each represented as a string.
(string) --
floatList (list) --
A list of double precision IEEE-754 floating point numbers, each represented as a string.
(string) --
boolList (list) --
A list of boolean values, each represented as a string.
(string) --
intListList (list) --
A list of lists of signed integers, each represented as a string.
(list) --
(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.
{'entities': {'environmentDetails': {'extensions': ['string'],
'resolvedSymbolTable': 'string'},
'jobDetails': {'extensions': ['string'],
'parameters': {'bool': 'string',
'boolList': ['string'],
'floatList': ['string'],
'intList': ['string'],
'intListList': [['string']],
'pathList': ['string'],
'rangeExpr': 'string',
'stringList': ['string']}},
'stepDetails': {'extensions': ['string'],
'resolvedSymbolTable': 'string'}}}
Get batched job details for a worker.
See also: AWS API Documentation
Request Syntax
client.batch_get_job_entity(
farmId='string',
fleetId='string',
workerId='string',
identifiers=[
{
'jobDetails': {
'jobId': 'string'
},
'jobAttachmentDetails': {
'jobId': 'string'
},
'stepDetails': {
'jobId': 'string',
'stepId': 'string'
},
'environmentDetails': {
'jobId': 'string',
'environmentId': 'string'
}
},
]
)
string
[REQUIRED]
The farm ID of the worker that's fetching job details. The worker must have an assignment on a job to fetch job details.
string
[REQUIRED]
The fleet ID of the worker that's fetching job details. The worker must have an assignment on a job to fetch job details.
string
[REQUIRED]
The worker ID of the worker containing the job details to get.
list
[REQUIRED]
The job identifiers to include within the job entity batch details.
(dict) --
The details of a job entity identifier.
jobDetails (dict) --
The job details.
jobId (string) -- [REQUIRED]
The job ID.
jobAttachmentDetails (dict) --
The job attachment details.
jobId (string) -- [REQUIRED]
The job ID.
stepDetails (dict) --
The step details.
jobId (string) -- [REQUIRED]
The job ID.
stepId (string) -- [REQUIRED]
The step ID.
environmentDetails (dict) --
The environment details.
jobId (string) -- [REQUIRED]
The job ID.
environmentId (string) -- [REQUIRED]
The environment ID.
dict
Response Syntax
{
'entities': [
{
'jobDetails': {
'jobId': 'string',
'jobAttachmentSettings': {
's3BucketName': 'string',
'rootPrefix': 'string'
},
'jobRunAsUser': {
'posix': {
'user': 'string',
'group': 'string'
},
'windows': {
'user': 'string',
'passwordArn': 'string'
},
'runAs': 'QUEUE_CONFIGURED_USER'|'WORKER_AGENT_USER'
},
'logGroupName': 'string',
'queueRoleArn': 'string',
'parameters': {
'string': {
'int': 'string',
'float': 'string',
'string': 'string',
'path': 'string',
'bool': 'string',
'rangeExpr': 'string',
'stringList': [
'string',
],
'pathList': [
'string',
],
'intList': [
'string',
],
'floatList': [
'string',
],
'boolList': [
'string',
],
'intListList': [
[
'string',
],
]
}
},
'schemaVersion': 'string',
'extensions': [
'string',
],
'pathMappingRules': [
{
'sourcePathFormat': 'windows'|'posix',
'sourcePath': 'string',
'destinationPath': 'string'
},
]
},
'jobAttachmentDetails': {
'jobId': 'string',
'attachments': {
'manifests': [
{
'fileSystemLocationName': 'string',
'rootPath': 'string',
'rootPathFormat': 'windows'|'posix',
'outputRelativeDirectories': [
'string',
],
'inputManifestPath': 'string',
'inputManifestHash': 'string'
},
],
'fileSystem': 'COPIED'|'VIRTUAL'
}
},
'stepDetails': {
'jobId': 'string',
'stepId': 'string',
'schemaVersion': 'string',
'template': {...}|[...]|123|123.4|'string'|True|None,
'dependencies': [
'string',
],
'extensions': [
'string',
],
'resolvedSymbolTable': 'string'
},
'environmentDetails': {
'jobId': 'string',
'environmentId': 'string',
'schemaVersion': 'string',
'template': {...}|[...]|123|123.4|'string'|True|None,
'extensions': [
'string',
],
'resolvedSymbolTable': 'string'
}
},
],
'errors': [
{
'jobDetails': {
'jobId': 'string',
'code': 'AccessDeniedException'|'InternalServerException'|'ValidationException'|'ResourceNotFoundException'|'MaxPayloadSizeExceeded'|'ConflictException',
'message': 'string'
},
'jobAttachmentDetails': {
'jobId': 'string',
'code': 'AccessDeniedException'|'InternalServerException'|'ValidationException'|'ResourceNotFoundException'|'MaxPayloadSizeExceeded'|'ConflictException',
'message': 'string'
},
'stepDetails': {
'jobId': 'string',
'stepId': 'string',
'code': 'AccessDeniedException'|'InternalServerException'|'ValidationException'|'ResourceNotFoundException'|'MaxPayloadSizeExceeded'|'ConflictException',
'message': 'string'
},
'environmentDetails': {
'jobId': 'string',
'environmentId': 'string',
'code': 'AccessDeniedException'|'InternalServerException'|'ValidationException'|'ResourceNotFoundException'|'MaxPayloadSizeExceeded'|'ConflictException',
'message': 'string'
}
},
]
}
Response Structure
(dict) --
entities (list) --
A list of the job entities, or details, in the batch.
(dict) --
The details of a job entity.
jobDetails (dict) --
The job details.
jobId (string) --
The job ID.
jobAttachmentSettings (dict) --
The job attachment settings.
s3BucketName (string) --
The Amazon S3 bucket name.
rootPrefix (string) --
The root prefix.
jobRunAsUser (dict) --
The user name and group that the job uses when run.
posix (dict) --
The user and group that the jobs in the queue run as.
user (string) --
The name of the POSIX user.
group (string) --
The name of the POSIX user's group.
windows (dict) --
Identifies a Microsoft Windows user.
user (string) --
The user.
passwordArn (string) --
The password ARN for the Windows user.
runAs (string) --
Specifies whether the job should run using the queue's system user or if the job should run using the worker agent system user.
logGroupName (string) --
The log group name.
queueRoleArn (string) --
The queue role ARN.
parameters (dict) --
The 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.
bool (string) --
A boolean value represented as a string. Accepted values are true, false, yes, no, on, off, 1, and 0, case-insensitive.
rangeExpr (string) --
An Open Job Description range expression represented as a string, such as 1-10:2.
stringList (list) --
A list of UTF-8 strings.
(string) --
pathList (list) --
A list of file system paths, each represented as a string.
(string) --
intList (list) --
A list of signed integers, each represented as a string.
(string) --
floatList (list) --
A list of double precision IEEE-754 floating point numbers, each represented as a string.
(string) --
boolList (list) --
A list of boolean values, each represented as a string.
(string) --
intListList (list) --
A list of lists of signed integers, each represented as a string.
(list) --
(string) --
schemaVersion (string) --
The schema version.
extensions (list) --
The Open Job Description extensions that the job template uses. This value is used by the worker agent.
(string) --
pathMappingRules (list) --
The path mapping rules.
(dict) --
The details of a source and destination path.
sourcePathFormat (string) --
The source path format.
sourcePath (string) --
The source path.
destinationPath (string) --
The destination path.
jobAttachmentDetails (dict) --
The job attachment details.
jobId (string) --
The job ID.
attachments (dict) --
The job attachments.
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.
stepDetails (dict) --
The step details.
jobId (string) --
The job ID.
stepId (string) --
The step ID.
schemaVersion (string) --
The schema version for a step template.
template (:ref:`document<document>`) --
The template for a step.
dependencies (list) --
The dependencies for a step.
(string) --
extensions (list) --
The Open Job Description extensions that the step uses. This value is used by the worker agent.
(string) --
resolvedSymbolTable (string) --
The resolved symbol table for the step's expressions, serialized as JSON. This value is used by the worker agent.
environmentDetails (dict) --
The environment details for the job entity.
jobId (string) --
The job ID.
environmentId (string) --
The environment ID.
schemaVersion (string) --
The schema version in the environment.
template (:ref:`document<document>`) --
The template used for the environment.
extensions (list) --
The Open Job Description extensions that the environment uses. This value is used by the worker agent.
(string) --
resolvedSymbolTable (string) --
The resolved symbol table for the environment's expressions, serialized as JSON. This value is used by the worker agent.
errors (list) --
A list of errors from the job error logs for the batch.
(dict) --
The error for the job entity.
jobDetails (dict) --
The job details for the failed job entity.
jobId (string) --
The job ID.
code (string) --
The error code.
message (string) --
The error message detailing the error's cause.
jobAttachmentDetails (dict) --
The job attachment details for the failed job entity.
jobId (string) --
The job ID.
code (string) --
The error code.
message (string) --
The error message detailing the error's cause.
stepDetails (dict) --
The step details for the failed job entity.
jobId (string) --
The job ID.
stepId (string) --
The step ID.
code (string) --
The error code.
message (string) --
The error message detailing the error's cause.
environmentDetails (dict) --
The environment details for the failed job entity.
jobId (string) --
The job ID.
environmentId (string) --
The environment ID.
code (string) --
The error code.
message (string) --
The error message detailing the error's cause.
{'configuration': {'serviceManagedEc2': {'instanceCapabilities': {'softwareAddOns': [{'name': 'docker'}]}}}}
Creates a fleet. Fleets gather information relating to compute, or capacity, for renders within your farms. You can choose to manage your own capacity or opt to have fleets fully managed by Deadline Cloud.
See also: AWS API Documentation
Request Syntax
client.create_fleet(
farmId='string',
clientToken='string',
displayName='string',
description='string',
roleArn='string',
minWorkerCount=123,
maxWorkerCount=123,
configuration={
'customerManaged': {
'mode': 'NO_SCALING'|'EVENT_BASED_AUTO_SCALING',
'autoScalingConfiguration': {
'standbyWorkerCount': 123,
'workerIdleDurationSeconds': 123,
'scaleOutWorkersPerMinute': 123
},
'workerCapabilities': {
'vCpuCount': {
'min': 123,
'max': 123
},
'memoryMiB': {
'min': 123,
'max': 123
},
'acceleratorTypes': [
'gpu',
],
'acceleratorCount': {
'min': 123,
'max': 123
},
'acceleratorTotalMemoryMiB': {
'min': 123,
'max': 123
},
'osFamily': 'WINDOWS'|'LINUX'|'MACOS',
'cpuArchitectureType': 'x86_64'|'arm64',
'customAmounts': [
{
'name': 'string',
'min': ...,
'max': ...
},
],
'customAttributes': [
{
'name': 'string',
'values': [
'string',
]
},
]
},
'storageProfileId': 'string',
'tagPropagationMode': 'NO_PROPAGATION'|'PROPAGATE_TAGS_TO_WORKERS_AT_LAUNCH'
},
'serviceManagedEc2': {
'instanceCapabilities': {
'vCpuCount': {
'min': 123,
'max': 123
},
'memoryMiB': {
'min': 123,
'max': 123
},
'osFamily': 'WINDOWS'|'LINUX',
'cpuArchitectureType': 'x86_64'|'arm64',
'rootEbsVolume': {
'sizeGiB': 123,
'iops': 123,
'throughputMiB': 123
},
'acceleratorCapabilities': {
'selections': [
{
'name': 't4'|'a10g'|'l4'|'l40s'|'rtx-pro-server-6000',
'runtime': 'string'
},
],
'count': {
'min': 123,
'max': 123
}
},
'allowedInstanceTypes': [
'string',
],
'excludedInstanceTypes': [
'string',
],
'customAmounts': [
{
'name': 'string',
'min': ...,
'max': ...
},
],
'customAttributes': [
{
'name': 'string',
'values': [
'string',
]
},
],
'softwareAddOns': [
{
'name': 'docker'
},
]
},
'instanceMarketOptions': {
'type': 'on-demand'|'spot'|'wait-and-save'
},
'vpcConfiguration': {
'resourceConfigurationArns': [
'string',
]
},
'storageProfileId': 'string',
'persistentVolumeConfiguration': {
'sizeGiB': 123,
'iops': 123,
'throughputMiB': 123,
'mountPath': 'string',
'lastUsedTtlHours': 123
},
'autoScalingConfiguration': {
'standbyWorkerCount': 123,
'workerIdleDurationSeconds': 123,
'scaleOutWorkersPerMinute': 123
}
}
},
tags={
'string': 'string'
},
hostConfiguration={
'scriptBody': 'string',
'scriptTimeoutSeconds': 123
}
)
string
[REQUIRED]
The farm ID of the farm to connect to the fleet.
string
The unique token which the server uses to recognize retries of the same request.
This field is autopopulated if not provided.
string
[REQUIRED]
The display name of the fleet.
string
The description of the fleet.
string
[REQUIRED]
The IAM role ARN for the role that the fleet's workers will use.
integer
The minimum number of workers for the fleet.
integer
[REQUIRED]
The maximum number of workers for the fleet.
Deadline Cloud limits the number of workers to less than or equal to the fleet's maximum worker count. The service maintains eventual consistency for the worker count. If you make multiple rapid calls to CreateWorker before the field updates, you might exceed your fleet's maximum worker count. For example, if your maxWorkerCount is 10 and you currently have 9 workers, making two quick CreateWorker calls might successfully create 2 workers instead of 1, resulting in 11 total workers.
dict
[REQUIRED]
The configuration settings for the fleet. Customer managed fleets are self-managed. Service managed Amazon EC2 fleets are managed by Deadline Cloud.
customerManaged (dict) --
The customer managed fleets within a fleet configuration.
mode (string) -- [REQUIRED]
The Auto Scaling mode for the customer managed fleet.
autoScalingConfiguration (dict) --
The auto scaling configuration settings for the customer managed fleet.
standbyWorkerCount (integer) --
The number of idle workers maintained and ready to process incoming tasks. The default is 0.
workerIdleDurationSeconds (integer) --
The number of seconds that a worker can remain idle before it is shut down. The default is 300 seconds (5 minutes).
scaleOutWorkersPerMinute (integer) --
The number of workers that can be added per minute to the fleet. The default is 10 workers per minute.
workerCapabilities (dict) -- [REQUIRED]
The worker capabilities for the customer managed fleet.
vCpuCount (dict) -- [REQUIRED]
The vCPU count for the customer manged worker capabilities.
min (integer) -- [REQUIRED]
The minimum amount of vCPU.
max (integer) --
The maximum amount of vCPU.
memoryMiB (dict) -- [REQUIRED]
The memory (MiB).
min (integer) -- [REQUIRED]
The minimum amount of memory (in MiB).
max (integer) --
The maximum amount of memory (in MiB).
acceleratorTypes (list) --
The accelerator types for the customer managed worker capabilities.
(string) --
acceleratorCount (dict) --
The range of the accelerator.
min (integer) -- [REQUIRED]
The minimum number of GPU accelerators in the worker host.
max (integer) --
The maximum number of GPU accelerators in the worker host.
acceleratorTotalMemoryMiB (dict) --
The total memory (MiB) for the customer managed worker capabilities.
min (integer) -- [REQUIRED]
The minimum amount of memory to use for the accelerator, measured in MiB.
max (integer) --
The maximum amount of memory to use for the accelerator, measured in MiB.
osFamily (string) -- [REQUIRED]
The operating system (OS) family.
cpuArchitectureType (string) -- [REQUIRED]
The CPU architecture type for the customer managed worker capabilities.
customAmounts (list) --
Custom requirement ranges for customer managed worker capabilities.
(dict) --
The fleet amount and attribute capabilities.
name (string) -- [REQUIRED]
The name of the fleet capability.
min (float) -- [REQUIRED]
The minimum amount of fleet worker capability.
max (float) --
The maximum amount of the fleet worker capability.
customAttributes (list) --
Custom attributes for the customer manged worker capabilities.
(dict) --
Defines the fleet's capability name, minimum, and maximum.
name (string) -- [REQUIRED]
The name of the fleet attribute capability for the worker.
values (list) -- [REQUIRED]
The number of fleet attribute capabilities.
(string) --
storageProfileId (string) --
The storage profile ID for the customer managed fleet.
tagPropagationMode (string) --
The tag propagation mode for the customer managed fleet.
serviceManagedEc2 (dict) --
The service managed Amazon EC2 instances for a fleet configuration.
instanceCapabilities (dict) -- [REQUIRED]
The instance capabilities for the service managed EC2 fleet.
vCpuCount (dict) -- [REQUIRED]
The amount of vCPU to require for instances in this fleet.
min (integer) -- [REQUIRED]
The minimum amount of vCPU.
max (integer) --
The maximum amount of vCPU.
memoryMiB (dict) -- [REQUIRED]
The memory, as MiB, for the Amazon EC2 instance type.
min (integer) -- [REQUIRED]
The minimum amount of memory (in MiB).
max (integer) --
The maximum amount of memory (in MiB).
osFamily (string) -- [REQUIRED]
The operating system (OS) family.
cpuArchitectureType (string) -- [REQUIRED]
The CPU architecture type.
rootEbsVolume (dict) --
The root EBS volume.
sizeGiB (integer) --
The EBS volume size in GiB.
iops (integer) --
The IOPS per volume.
throughputMiB (integer) --
The throughput per volume in MiB.
acceleratorCapabilities (dict) --
Describes the GPU accelerator capabilities required for worker host instances in this fleet.
selections (list) -- [REQUIRED]
A list of accelerator capabilities requested for this fleet. Only Amazon Elastic Compute Cloud instances that provide these capabilities will be used. For example, if you specify both L4 and T4 chips, Amazon Web Services Deadline Cloud will use Amazon EC2 instances that have either the L4 or the T4 chip installed.
(dict) --
Describes a specific GPU accelerator required for an Amazon Elastic Compute Cloud worker host.
name (string) -- [REQUIRED]
The name of the chip used by the GPU accelerator.
The available GPU accelerators are:
t4 - NVIDIA T4 Tensor Core GPU (16 GiB memory)
a10g - NVIDIA A10G Tensor Core GPU (24 GiB memory)
l4 - NVIDIA L4 Tensor Core GPU (24 GiB memory)
l40s - NVIDIA L40S Tensor Core GPU (48 GiB memory)
rtx-pro-server-6000 - NVIDIA RTX PRO Server 6000 GPU (96 GiB memory)
runtime (string) --
Specifies the runtime driver to use for the GPU accelerator. You must use the same runtime for all GPUs in a fleet.
You can choose from the following runtimes:
latest - Use the latest runtime available for the chip. If you specify latest and a new version of the runtime is released, the new version of the runtime is used.
grid:r580 - NVIDIA vGPU software 19
grid:r570 - NVIDIA vGPU software 18
grid:r535 - NVIDIA vGPU software 16
If you don't specify a runtime, Amazon Web Services Deadline Cloud uses latest as the default. However, if you have multiple accelerators and specify latest for some and leave others blank, Amazon Web Services Deadline Cloud raises an exception.
count (dict) --
The number of GPU accelerators specified for worker hosts in this fleet.
min (integer) -- [REQUIRED]
The minimum number of GPU accelerators in the worker host.
max (integer) --
The maximum number of GPU accelerators in the worker host.
allowedInstanceTypes (list) --
The allowable Amazon EC2 instance types.
(string) --
excludedInstanceTypes (list) --
The instance types to exclude from the fleet.
(string) --
customAmounts (list) --
The custom capability amounts to require for instances in this fleet.
(dict) --
The fleet amount and attribute capabilities.
name (string) -- [REQUIRED]
The name of the fleet capability.
min (float) -- [REQUIRED]
The minimum amount of fleet worker capability.
max (float) --
The maximum amount of the fleet worker capability.
customAttributes (list) --
The custom capability attributes to require for instances in this fleet.
(dict) --
Defines the fleet's capability name, minimum, and maximum.
name (string) -- [REQUIRED]
The name of the fleet attribute capability for the worker.
values (list) -- [REQUIRED]
The number of fleet attribute capabilities.
(string) --
softwareAddOns (list) --
The software add-ons that the service installs on worker hosts when they launch.
(dict) --
Software that the service installs on worker hosts in a service-managed fleet.
name (string) -- [REQUIRED]
The name of the software add-on. The supported value is docker.
instanceMarketOptions (dict) -- [REQUIRED]
The instance market options for the service managed EC2 fleet.
type (string) -- [REQUIRED]
The Amazon EC2 instance type.
vpcConfiguration (dict) --
The VPC configuration for the service managed EC2 fleet.
resourceConfigurationArns (list) --
The ARNs of the VPC Lattice resource configurations attached to the fleet.
(string) --
storageProfileId (string) --
The storage profile ID for the service managed EC2 fleet.
persistentVolumeConfiguration (dict) --
The persistent volume configuration for the service managed EC2 fleet.
sizeGiB (integer) --
The persistent volume size in GiB. The default is 250.
iops (integer) --
The IOPS per persistent volume. The default is 3000.
throughputMiB (integer) --
The throughput per persistent volume in MiB. The default is 125.
mountPath (string) -- [REQUIRED]
The file system path where the persistent volume is mounted on the worker instance.
lastUsedTtlHours (integer) --
The number of hours a persistent volume can remain unused before it is deleted. The default is 168 (7 days).
autoScalingConfiguration (dict) --
The auto scaling configuration settings for the service managed EC2 fleet.
standbyWorkerCount (integer) --
The number of idle workers maintained and ready to process incoming tasks. The default is 0.
workerIdleDurationSeconds (integer) --
The number of seconds that a worker can remain idle before it is shut down. The default is 300 seconds (5 minutes).
scaleOutWorkersPerMinute (integer) --
The number of workers that can be added per minute to the fleet. The default is 10 workers per minute.
dict
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
Provides a script that runs as a worker is starting up that you can use to provide additional configuration for workers in your fleet.
scriptBody (string) -- [REQUIRED]
The text of the script that runs as a worker is starting up that you can use to provide additional configuration for workers in your fleet. The script runs after a worker enters the STARTING state and before the worker processes tasks.
For more information about using the script, see Run scripts as an administrator to configure workers in the Deadline Cloud Developer Guide.
scriptTimeoutSeconds (integer) --
The maximum time that the host configuration can run. If the timeout expires, the worker enters the NOT RESPONDING state and shuts down. You are charged for the time that the worker is running the host configuration script.
The default is 300 seconds (5 minutes).
dict
Response Syntax
{
'fleetId': '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.
fleetId (string) --
The fleet ID.
{'parameters': {'bool': 'string',
'boolList': ['string'],
'floatList': ['string'],
'intList': ['string'],
'intListList': [['string']],
'pathList': ['string'],
'rangeExpr': 'string',
'stringList': ['string']}}
Creates a job. A job is a set of instructions that Deadline Cloud uses to schedule and run work on available workers. For more information, see Deadline Cloud jobs.
See also: AWS API Documentation
Request Syntax
client.create_job(
farmId='string',
queueId='string',
clientToken='string',
template='string',
templateType='JSON'|'YAML',
priority=123,
parameters={
'string': {
'int': 'string',
'float': 'string',
'string': 'string',
'path': 'string',
'bool': 'string',
'rangeExpr': 'string',
'stringList': [
'string',
],
'pathList': [
'string',
],
'intList': [
'string',
],
'floatList': [
'string',
],
'boolList': [
'string',
],
'intListList': [
[
'string',
],
]
}
},
attachments={
'manifests': [
{
'fileSystemLocationName': 'string',
'rootPath': 'string',
'rootPathFormat': 'windows'|'posix',
'outputRelativeDirectories': [
'string',
],
'inputManifestPath': 'string',
'inputManifestHash': 'string'
},
],
'fileSystem': 'COPIED'|'VIRTUAL'
},
storageProfileId='string',
targetTaskRunStatus='READY'|'SUSPENDED',
maxFailedTasksCount=123,
maxRetriesPerTask=123,
maxWorkerCount=123,
sourceJobId='string',
nameOverride='string',
descriptionOverride='string',
tags={
'string': 'string'
}
)
string
[REQUIRED]
The farm ID of the farm to connect to the job.
string
[REQUIRED]
The ID of the queue that the job is submitted to.
string
The unique token which the server uses to recognize retries of the same request.
This field is autopopulated if not provided.
string
The job template to use for this job.
string
The file type for the job template.
integer
[REQUIRED]
The priority of the job. The highest priority (first scheduled) is 100. When two jobs have the same priority, the oldest job is scheduled first.
dict
The parameters for the job.
(string) --
(dict) --
The details of job parameters.
int (string) --
A signed integer represented as a string.
float (string) --
A double precision IEEE-754 floating point number represented as a string.
string (string) --
A UTF-8 string.
path (string) --
A file system path represented as a string.
bool (string) --
A boolean value represented as a string. Accepted values are true, false, yes, no, on, off, 1, and 0, case-insensitive.
rangeExpr (string) --
An Open Job Description range expression represented as a string, such as 1-10:2.
stringList (list) --
A list of UTF-8 strings.
(string) --
pathList (list) --
A list of file system paths, each represented as a string.
(string) --
intList (list) --
A list of signed integers, each represented as a string.
(string) --
floatList (list) --
A list of double precision IEEE-754 floating point numbers, each represented as a string.
(string) --
boolList (list) --
A list of boolean values, each represented as a string.
(string) --
intListList (list) --
A list of lists of signed integers, each represented as a string.
(list) --
(string) --
dict
The attachments for the job. Attach files required for the job to run to a render job.
manifests (list) -- [REQUIRED]
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) -- [REQUIRED]
The file's root path.
rootPathFormat (string) -- [REQUIRED]
The format of the root path.
outputRelativeDirectories (list) --
The file path relative to the directory.
(string) --
inputManifestPath (string) --
The file path.
inputManifestHash (string) --
The hash value of the file.
fileSystem (string) --
The file system location for the attachments.
string
The storage profile ID for the storage profile to connect to the job.
string
The initial job status when it is created. Jobs that are created with a SUSPENDED status will not run until manually requeued.
integer
The number of task failures before the job stops running and is marked as FAILED.
integer
The maximum number of retries for each task.
integer
The maximum number of worker hosts that can concurrently process a job. When the maxWorkerCount is reached, no more workers will be assigned to process the job, even if the fleets assigned to the job's queue has available workers.
You can't set the maxWorkerCount to 0. If you set it to -1, there is no maximum number of workers.
If you don't specify the maxWorkerCount, Deadline Cloud won't throttle the number of workers used to process the job.
string
The job ID for the source job.
string
A custom name to override the job name derived from the job template.
string
A custom description to override the job description derived from the job template.
dict
The tags to add to your job. 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
{
'jobId': '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.
jobId (string) --
The job ID.
{'configuration': {'serviceManagedEc2': {'instanceCapabilities': {'softwareAddOns': [{'name': 'docker'}]}}}}
Get a fleet.
See also: AWS API Documentation
Request Syntax
client.get_fleet(
farmId='string',
fleetId='string'
)
string
[REQUIRED]
The farm ID of the farm in the fleet.
string
[REQUIRED]
The fleet ID of the fleet to get.
dict
Response Syntax
{
'fleetId': 'string',
'farmId': 'string',
'displayName': 'string',
'status': 'ACTIVE'|'CREATE_IN_PROGRESS'|'UPDATE_IN_PROGRESS'|'CREATE_FAILED'|'UPDATE_FAILED'|'SUSPENDED',
'statusMessage': 'string',
'autoScalingStatus': 'GROWING'|'STEADY'|'SHRINKING',
'targetWorkerCount': 123,
'workerCount': 123,
'minWorkerCount': 123,
'maxWorkerCount': 123,
'configuration': {
'customerManaged': {
'mode': 'NO_SCALING'|'EVENT_BASED_AUTO_SCALING',
'autoScalingConfiguration': {
'standbyWorkerCount': 123,
'workerIdleDurationSeconds': 123,
'scaleOutWorkersPerMinute': 123
},
'workerCapabilities': {
'vCpuCount': {
'min': 123,
'max': 123
},
'memoryMiB': {
'min': 123,
'max': 123
},
'acceleratorTypes': [
'gpu',
],
'acceleratorCount': {
'min': 123,
'max': 123
},
'acceleratorTotalMemoryMiB': {
'min': 123,
'max': 123
},
'osFamily': 'WINDOWS'|'LINUX'|'MACOS',
'cpuArchitectureType': 'x86_64'|'arm64',
'customAmounts': [
{
'name': 'string',
'min': ...,
'max': ...
},
],
'customAttributes': [
{
'name': 'string',
'values': [
'string',
]
},
]
},
'storageProfileId': 'string',
'tagPropagationMode': 'NO_PROPAGATION'|'PROPAGATE_TAGS_TO_WORKERS_AT_LAUNCH'
},
'serviceManagedEc2': {
'instanceCapabilities': {
'vCpuCount': {
'min': 123,
'max': 123
},
'memoryMiB': {
'min': 123,
'max': 123
},
'osFamily': 'WINDOWS'|'LINUX',
'cpuArchitectureType': 'x86_64'|'arm64',
'rootEbsVolume': {
'sizeGiB': 123,
'iops': 123,
'throughputMiB': 123
},
'acceleratorCapabilities': {
'selections': [
{
'name': 't4'|'a10g'|'l4'|'l40s'|'rtx-pro-server-6000',
'runtime': 'string'
},
],
'count': {
'min': 123,
'max': 123
}
},
'allowedInstanceTypes': [
'string',
],
'excludedInstanceTypes': [
'string',
],
'customAmounts': [
{
'name': 'string',
'min': ...,
'max': ...
},
],
'customAttributes': [
{
'name': 'string',
'values': [
'string',
]
},
],
'softwareAddOns': [
{
'name': 'docker'
},
]
},
'instanceMarketOptions': {
'type': 'on-demand'|'spot'|'wait-and-save'
},
'vpcConfiguration': {
'resourceConfigurationArns': [
'string',
]
},
'storageProfileId': 'string',
'persistentVolumeConfiguration': {
'sizeGiB': 123,
'iops': 123,
'throughputMiB': 123,
'mountPath': 'string',
'lastUsedTtlHours': 123
},
'autoScalingConfiguration': {
'standbyWorkerCount': 123,
'workerIdleDurationSeconds': 123,
'scaleOutWorkersPerMinute': 123
}
}
},
'createdAt': datetime(2015, 1, 1),
'createdBy': 'string',
'updatedAt': datetime(2015, 1, 1),
'updatedBy': 'string',
'description': 'string',
'hostConfiguration': {
'scriptBody': 'string',
'scriptTimeoutSeconds': 123
},
'capabilities': {
'amounts': [
{
'name': 'string',
'min': ...,
'max': ...
},
],
'attributes': [
{
'name': 'string',
'values': [
'string',
]
},
]
},
'roleArn': '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.
fleetId (string) --
The fleet ID.
farmId (string) --
The farm ID of the farm in the fleet.
displayName (string) --
The display name of the fleet.
status (string) --
The status of the fleet.
statusMessage (string) --
A message that communicates a suspended status of the fleet.
autoScalingStatus (string) --
The Auto Scaling status of the fleet. Either GROWING, STEADY, or SHRINKING.
targetWorkerCount (integer) --
The number of target workers in the fleet.
workerCount (integer) --
The number of workers in the fleet.
minWorkerCount (integer) --
The minimum number of workers specified in the fleet.
maxWorkerCount (integer) --
The maximum number of workers specified in the fleet.
configuration (dict) --
The configuration setting for the fleet.
customerManaged (dict) --
The customer managed fleets within a fleet configuration.
mode (string) --
The Auto Scaling mode for the customer managed fleet.
autoScalingConfiguration (dict) --
The auto scaling configuration settings for the customer managed fleet.
standbyWorkerCount (integer) --
The number of idle workers maintained and ready to process incoming tasks. The default is 0.
workerIdleDurationSeconds (integer) --
The number of seconds that a worker can remain idle before it is shut down. The default is 300 seconds (5 minutes).
scaleOutWorkersPerMinute (integer) --
The number of workers that can be added per minute to the fleet. The default is 10 workers per minute.
workerCapabilities (dict) --
The worker capabilities for the customer managed fleet.
vCpuCount (dict) --
The vCPU count for the customer manged worker capabilities.
min (integer) --
The minimum amount of vCPU.
max (integer) --
The maximum amount of vCPU.
memoryMiB (dict) --
The memory (MiB).
min (integer) --
The minimum amount of memory (in MiB).
max (integer) --
The maximum amount of memory (in MiB).
acceleratorTypes (list) --
The accelerator types for the customer managed worker capabilities.
(string) --
acceleratorCount (dict) --
The range of the accelerator.
min (integer) --
The minimum number of GPU accelerators in the worker host.
max (integer) --
The maximum number of GPU accelerators in the worker host.
acceleratorTotalMemoryMiB (dict) --
The total memory (MiB) for the customer managed worker capabilities.
min (integer) --
The minimum amount of memory to use for the accelerator, measured in MiB.
max (integer) --
The maximum amount of memory to use for the accelerator, measured in MiB.
osFamily (string) --
The operating system (OS) family.
cpuArchitectureType (string) --
The CPU architecture type for the customer managed worker capabilities.
customAmounts (list) --
Custom requirement ranges for customer managed worker capabilities.
(dict) --
The fleet amount and attribute capabilities.
name (string) --
The name of the fleet capability.
min (float) --
The minimum amount of fleet worker capability.
max (float) --
The maximum amount of the fleet worker capability.
customAttributes (list) --
Custom attributes for the customer manged worker capabilities.
(dict) --
Defines the fleet's capability name, minimum, and maximum.
name (string) --
The name of the fleet attribute capability for the worker.
values (list) --
The number of fleet attribute capabilities.
(string) --
storageProfileId (string) --
The storage profile ID for the customer managed fleet.
tagPropagationMode (string) --
The tag propagation mode for the customer managed fleet.
serviceManagedEc2 (dict) --
The service managed Amazon EC2 instances for a fleet configuration.
instanceCapabilities (dict) --
The instance capabilities for the service managed EC2 fleet.
vCpuCount (dict) --
The amount of vCPU to require for instances in this fleet.
min (integer) --
The minimum amount of vCPU.
max (integer) --
The maximum amount of vCPU.
memoryMiB (dict) --
The memory, as MiB, for the Amazon EC2 instance type.
min (integer) --
The minimum amount of memory (in MiB).
max (integer) --
The maximum amount of memory (in MiB).
osFamily (string) --
The operating system (OS) family.
cpuArchitectureType (string) --
The CPU architecture type.
rootEbsVolume (dict) --
The root EBS volume.
sizeGiB (integer) --
The EBS volume size in GiB.
iops (integer) --
The IOPS per volume.
throughputMiB (integer) --
The throughput per volume in MiB.
acceleratorCapabilities (dict) --
Describes the GPU accelerator capabilities required for worker host instances in this fleet.
selections (list) --
A list of accelerator capabilities requested for this fleet. Only Amazon Elastic Compute Cloud instances that provide these capabilities will be used. For example, if you specify both L4 and T4 chips, Amazon Web Services Deadline Cloud will use Amazon EC2 instances that have either the L4 or the T4 chip installed.
(dict) --
Describes a specific GPU accelerator required for an Amazon Elastic Compute Cloud worker host.
name (string) --
The name of the chip used by the GPU accelerator.
The available GPU accelerators are:
t4 - NVIDIA T4 Tensor Core GPU (16 GiB memory)
a10g - NVIDIA A10G Tensor Core GPU (24 GiB memory)
l4 - NVIDIA L4 Tensor Core GPU (24 GiB memory)
l40s - NVIDIA L40S Tensor Core GPU (48 GiB memory)
rtx-pro-server-6000 - NVIDIA RTX PRO Server 6000 GPU (96 GiB memory)
runtime (string) --
Specifies the runtime driver to use for the GPU accelerator. You must use the same runtime for all GPUs in a fleet.
You can choose from the following runtimes:
latest - Use the latest runtime available for the chip. If you specify latest and a new version of the runtime is released, the new version of the runtime is used.
grid:r580 - NVIDIA vGPU software 19
grid:r570 - NVIDIA vGPU software 18
grid:r535 - NVIDIA vGPU software 16
If you don't specify a runtime, Amazon Web Services Deadline Cloud uses latest as the default. However, if you have multiple accelerators and specify latest for some and leave others blank, Amazon Web Services Deadline Cloud raises an exception.
count (dict) --
The number of GPU accelerators specified for worker hosts in this fleet.
min (integer) --
The minimum number of GPU accelerators in the worker host.
max (integer) --
The maximum number of GPU accelerators in the worker host.
allowedInstanceTypes (list) --
The allowable Amazon EC2 instance types.
(string) --
excludedInstanceTypes (list) --
The instance types to exclude from the fleet.
(string) --
customAmounts (list) --
The custom capability amounts to require for instances in this fleet.
(dict) --
The fleet amount and attribute capabilities.
name (string) --
The name of the fleet capability.
min (float) --
The minimum amount of fleet worker capability.
max (float) --
The maximum amount of the fleet worker capability.
customAttributes (list) --
The custom capability attributes to require for instances in this fleet.
(dict) --
Defines the fleet's capability name, minimum, and maximum.
name (string) --
The name of the fleet attribute capability for the worker.
values (list) --
The number of fleet attribute capabilities.
(string) --
softwareAddOns (list) --
The software add-ons that the service installs on worker hosts when they launch.
(dict) --
Software that the service installs on worker hosts in a service-managed fleet.
name (string) --
The name of the software add-on. The supported value is docker.
instanceMarketOptions (dict) --
The instance market options for the service managed EC2 fleet.
type (string) --
The Amazon EC2 instance type.
vpcConfiguration (dict) --
The VPC configuration for the service managed EC2 fleet.
resourceConfigurationArns (list) --
The ARNs of the VPC Lattice resource configurations attached to the fleet.
(string) --
storageProfileId (string) --
The storage profile ID for the service managed EC2 fleet.
persistentVolumeConfiguration (dict) --
The persistent volume configuration for the service managed EC2 fleet.
sizeGiB (integer) --
The persistent volume size in GiB. The default is 250.
iops (integer) --
The IOPS per persistent volume. The default is 3000.
throughputMiB (integer) --
The throughput per persistent volume in MiB. The default is 125.
mountPath (string) --
The file system path where the persistent volume is mounted on the worker instance.
lastUsedTtlHours (integer) --
The number of hours a persistent volume can remain unused before it is deleted. The default is 168 (7 days).
autoScalingConfiguration (dict) --
The auto scaling configuration settings for the service managed EC2 fleet.
standbyWorkerCount (integer) --
The number of idle workers maintained and ready to process incoming tasks. The default is 0.
workerIdleDurationSeconds (integer) --
The number of seconds that a worker can remain idle before it is shut down. The default is 300 seconds (5 minutes).
scaleOutWorkersPerMinute (integer) --
The number of workers that can be added per minute to the fleet. The default is 10 workers per minute.
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.
description (string) --
The description of the fleet.
hostConfiguration (dict) --
The script that runs as a worker is starting up that you can use to provide additional configuration for workers in your fleet.
scriptBody (string) --
The text of the script that runs as a worker is starting up that you can use to provide additional configuration for workers in your fleet. The script runs after a worker enters the STARTING state and before the worker processes tasks.
For more information about using the script, see Run scripts as an administrator to configure workers in the Deadline Cloud Developer Guide.
scriptTimeoutSeconds (integer) --
The maximum time that the host configuration can run. If the timeout expires, the worker enters the NOT RESPONDING state and shuts down. You are charged for the time that the worker is running the host configuration script.
The default is 300 seconds (5 minutes).
capabilities (dict) --
Outlines what the fleet is capable of for minimums, maximums, and naming, in addition to attribute names and values.
amounts (list) --
Amount capabilities of the fleet.
(dict) --
The fleet amount and attribute capabilities.
name (string) --
The name of the fleet capability.
min (float) --
The minimum amount of fleet worker capability.
max (float) --
The maximum amount of the fleet worker capability.
attributes (list) --
Attribute capabilities of the fleet.
(dict) --
Defines the fleet's capability name, minimum, and maximum.
name (string) --
The name of the fleet attribute capability for the worker.
values (list) --
The number of fleet attribute capabilities.
(string) --
roleArn (string) --
The IAM role ARN.
{'parameters': {'bool': 'string',
'boolList': ['string'],
'floatList': ['string'],
'intList': ['string'],
'intListList': [['string']],
'pathList': ['string'],
'rangeExpr': 'string',
'stringList': ['string']}}
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',
'bool': 'string',
'rangeExpr': 'string',
'stringList': [
'string',
],
'pathList': [
'string',
],
'intList': [
'string',
],
'floatList': [
'string',
],
'boolList': [
'string',
],
'intListList': [
[
'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) --
Mixin that adds an optional ARN field to response structures. Apply to SummaryMixins (flows into Get, Summary, and BatchGet) and Create outputs.
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.
bool (string) --
A boolean value represented as a string. Accepted values are true, false, yes, no, on, off, 1, and 0, case-insensitive.
rangeExpr (string) --
An Open Job Description range expression represented as a string, such as 1-10:2.
stringList (list) --
A list of UTF-8 strings.
(string) --
pathList (list) --
A list of file system paths, each represented as a string.
(string) --
intList (list) --
A list of signed integers, each represented as a string.
(string) --
floatList (list) --
A list of double precision IEEE-754 floating point numbers, each represented as a string.
(string) --
boolList (list) --
A list of boolean values, each represented as a string.
(string) --
intListList (list) --
A list of lists of signed integers, each represented as a string.
(list) --
(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. 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.
{'fleets': {'configuration': {'serviceManagedEc2': {'instanceCapabilities': {'softwareAddOns': [{'name': 'docker'}]}}}}}
Lists fleets.
See also: AWS API Documentation
Request Syntax
client.list_fleets(
farmId='string',
nextToken='string',
maxResults=123,
principalId='string',
displayName='string',
status='ACTIVE'|'CREATE_IN_PROGRESS'|'UPDATE_IN_PROGRESS'|'CREATE_FAILED'|'UPDATE_FAILED'|'SUSPENDED'
)
string
[REQUIRED]
The farm ID of the fleets.
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.
string
The principal ID of the members to include in the fleet.
string
The display names of a list of fleets.
string
The status of the fleet.
dict
Response Syntax
{
'fleets': [
{
'fleetId': 'string',
'farmId': 'string',
'displayName': 'string',
'status': 'ACTIVE'|'CREATE_IN_PROGRESS'|'UPDATE_IN_PROGRESS'|'CREATE_FAILED'|'UPDATE_FAILED'|'SUSPENDED',
'statusMessage': 'string',
'autoScalingStatus': 'GROWING'|'STEADY'|'SHRINKING',
'targetWorkerCount': 123,
'workerCount': 123,
'minWorkerCount': 123,
'maxWorkerCount': 123,
'configuration': {
'customerManaged': {
'mode': 'NO_SCALING'|'EVENT_BASED_AUTO_SCALING',
'autoScalingConfiguration': {
'standbyWorkerCount': 123,
'workerIdleDurationSeconds': 123,
'scaleOutWorkersPerMinute': 123
},
'workerCapabilities': {
'vCpuCount': {
'min': 123,
'max': 123
},
'memoryMiB': {
'min': 123,
'max': 123
},
'acceleratorTypes': [
'gpu',
],
'acceleratorCount': {
'min': 123,
'max': 123
},
'acceleratorTotalMemoryMiB': {
'min': 123,
'max': 123
},
'osFamily': 'WINDOWS'|'LINUX'|'MACOS',
'cpuArchitectureType': 'x86_64'|'arm64',
'customAmounts': [
{
'name': 'string',
'min': ...,
'max': ...
},
],
'customAttributes': [
{
'name': 'string',
'values': [
'string',
]
},
]
},
'storageProfileId': 'string',
'tagPropagationMode': 'NO_PROPAGATION'|'PROPAGATE_TAGS_TO_WORKERS_AT_LAUNCH'
},
'serviceManagedEc2': {
'instanceCapabilities': {
'vCpuCount': {
'min': 123,
'max': 123
},
'memoryMiB': {
'min': 123,
'max': 123
},
'osFamily': 'WINDOWS'|'LINUX',
'cpuArchitectureType': 'x86_64'|'arm64',
'rootEbsVolume': {
'sizeGiB': 123,
'iops': 123,
'throughputMiB': 123
},
'acceleratorCapabilities': {
'selections': [
{
'name': 't4'|'a10g'|'l4'|'l40s'|'rtx-pro-server-6000',
'runtime': 'string'
},
],
'count': {
'min': 123,
'max': 123
}
},
'allowedInstanceTypes': [
'string',
],
'excludedInstanceTypes': [
'string',
],
'customAmounts': [
{
'name': 'string',
'min': ...,
'max': ...
},
],
'customAttributes': [
{
'name': 'string',
'values': [
'string',
]
},
],
'softwareAddOns': [
{
'name': 'docker'
},
]
},
'instanceMarketOptions': {
'type': 'on-demand'|'spot'|'wait-and-save'
},
'vpcConfiguration': {
'resourceConfigurationArns': [
'string',
]
},
'storageProfileId': 'string',
'persistentVolumeConfiguration': {
'sizeGiB': 123,
'iops': 123,
'throughputMiB': 123,
'mountPath': 'string',
'lastUsedTtlHours': 123
},
'autoScalingConfiguration': {
'standbyWorkerCount': 123,
'workerIdleDurationSeconds': 123,
'scaleOutWorkersPerMinute': 123
}
}
},
'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).
fleets (list) --
The fleets on the list.
(dict) --
The details of a fleet.
fleetId (string) --
The fleet ID.
farmId (string) --
The farm ID.
displayName (string) --
The display name of the fleet summary to update.
status (string) --
The status of the fleet.
statusMessage (string) --
A message that communicates a suspended status of the fleet.
autoScalingStatus (string) --
The Auto Scaling status of a fleet.
targetWorkerCount (integer) --
The target number of workers in a fleet.
workerCount (integer) --
The number of workers in the fleet summary.
minWorkerCount (integer) --
The minimum number of workers in the fleet.
maxWorkerCount (integer) --
The maximum number of workers specified in the fleet.
configuration (dict) --
The configuration details for the fleet.
customerManaged (dict) --
The customer managed fleets within a fleet configuration.
mode (string) --
The Auto Scaling mode for the customer managed fleet.
autoScalingConfiguration (dict) --
The auto scaling configuration settings for the customer managed fleet.
standbyWorkerCount (integer) --
The number of idle workers maintained and ready to process incoming tasks. The default is 0.
workerIdleDurationSeconds (integer) --
The number of seconds that a worker can remain idle before it is shut down. The default is 300 seconds (5 minutes).
scaleOutWorkersPerMinute (integer) --
The number of workers that can be added per minute to the fleet. The default is 10 workers per minute.
workerCapabilities (dict) --
The worker capabilities for the customer managed fleet.
vCpuCount (dict) --
The vCPU count for the customer manged worker capabilities.
min (integer) --
The minimum amount of vCPU.
max (integer) --
The maximum amount of vCPU.
memoryMiB (dict) --
The memory (MiB).
min (integer) --
The minimum amount of memory (in MiB).
max (integer) --
The maximum amount of memory (in MiB).
acceleratorTypes (list) --
The accelerator types for the customer managed worker capabilities.
(string) --
acceleratorCount (dict) --
The range of the accelerator.
min (integer) --
The minimum number of GPU accelerators in the worker host.
max (integer) --
The maximum number of GPU accelerators in the worker host.
acceleratorTotalMemoryMiB (dict) --
The total memory (MiB) for the customer managed worker capabilities.
min (integer) --
The minimum amount of memory to use for the accelerator, measured in MiB.
max (integer) --
The maximum amount of memory to use for the accelerator, measured in MiB.
osFamily (string) --
The operating system (OS) family.
cpuArchitectureType (string) --
The CPU architecture type for the customer managed worker capabilities.
customAmounts (list) --
Custom requirement ranges for customer managed worker capabilities.
(dict) --
The fleet amount and attribute capabilities.
name (string) --
The name of the fleet capability.
min (float) --
The minimum amount of fleet worker capability.
max (float) --
The maximum amount of the fleet worker capability.
customAttributes (list) --
Custom attributes for the customer manged worker capabilities.
(dict) --
Defines the fleet's capability name, minimum, and maximum.
name (string) --
The name of the fleet attribute capability for the worker.
values (list) --
The number of fleet attribute capabilities.
(string) --
storageProfileId (string) --
The storage profile ID for the customer managed fleet.
tagPropagationMode (string) --
The tag propagation mode for the customer managed fleet.
serviceManagedEc2 (dict) --
The service managed Amazon EC2 instances for a fleet configuration.
instanceCapabilities (dict) --
The instance capabilities for the service managed EC2 fleet.
vCpuCount (dict) --
The amount of vCPU to require for instances in this fleet.
min (integer) --
The minimum amount of vCPU.
max (integer) --
The maximum amount of vCPU.
memoryMiB (dict) --
The memory, as MiB, for the Amazon EC2 instance type.
min (integer) --
The minimum amount of memory (in MiB).
max (integer) --
The maximum amount of memory (in MiB).
osFamily (string) --
The operating system (OS) family.
cpuArchitectureType (string) --
The CPU architecture type.
rootEbsVolume (dict) --
The root EBS volume.
sizeGiB (integer) --
The EBS volume size in GiB.
iops (integer) --
The IOPS per volume.
throughputMiB (integer) --
The throughput per volume in MiB.
acceleratorCapabilities (dict) --
Describes the GPU accelerator capabilities required for worker host instances in this fleet.
selections (list) --
A list of accelerator capabilities requested for this fleet. Only Amazon Elastic Compute Cloud instances that provide these capabilities will be used. For example, if you specify both L4 and T4 chips, Amazon Web Services Deadline Cloud will use Amazon EC2 instances that have either the L4 or the T4 chip installed.
(dict) --
Describes a specific GPU accelerator required for an Amazon Elastic Compute Cloud worker host.
name (string) --
The name of the chip used by the GPU accelerator.
The available GPU accelerators are:
t4 - NVIDIA T4 Tensor Core GPU (16 GiB memory)
a10g - NVIDIA A10G Tensor Core GPU (24 GiB memory)
l4 - NVIDIA L4 Tensor Core GPU (24 GiB memory)
l40s - NVIDIA L40S Tensor Core GPU (48 GiB memory)
rtx-pro-server-6000 - NVIDIA RTX PRO Server 6000 GPU (96 GiB memory)
runtime (string) --
Specifies the runtime driver to use for the GPU accelerator. You must use the same runtime for all GPUs in a fleet.
You can choose from the following runtimes:
latest - Use the latest runtime available for the chip. If you specify latest and a new version of the runtime is released, the new version of the runtime is used.
grid:r580 - NVIDIA vGPU software 19
grid:r570 - NVIDIA vGPU software 18
grid:r535 - NVIDIA vGPU software 16
If you don't specify a runtime, Amazon Web Services Deadline Cloud uses latest as the default. However, if you have multiple accelerators and specify latest for some and leave others blank, Amazon Web Services Deadline Cloud raises an exception.
count (dict) --
The number of GPU accelerators specified for worker hosts in this fleet.
min (integer) --
The minimum number of GPU accelerators in the worker host.
max (integer) --
The maximum number of GPU accelerators in the worker host.
allowedInstanceTypes (list) --
The allowable Amazon EC2 instance types.
(string) --
excludedInstanceTypes (list) --
The instance types to exclude from the fleet.
(string) --
customAmounts (list) --
The custom capability amounts to require for instances in this fleet.
(dict) --
The fleet amount and attribute capabilities.
name (string) --
The name of the fleet capability.
min (float) --
The minimum amount of fleet worker capability.
max (float) --
The maximum amount of the fleet worker capability.
customAttributes (list) --
The custom capability attributes to require for instances in this fleet.
(dict) --
Defines the fleet's capability name, minimum, and maximum.
name (string) --
The name of the fleet attribute capability for the worker.
values (list) --
The number of fleet attribute capabilities.
(string) --
softwareAddOns (list) --
The software add-ons that the service installs on worker hosts when they launch.
(dict) --
Software that the service installs on worker hosts in a service-managed fleet.
name (string) --
The name of the software add-on. The supported value is docker.
instanceMarketOptions (dict) --
The instance market options for the service managed EC2 fleet.
type (string) --
The Amazon EC2 instance type.
vpcConfiguration (dict) --
The VPC configuration for the service managed EC2 fleet.
resourceConfigurationArns (list) --
The ARNs of the VPC Lattice resource configurations attached to the fleet.
(string) --
storageProfileId (string) --
The storage profile ID for the service managed EC2 fleet.
persistentVolumeConfiguration (dict) --
The persistent volume configuration for the service managed EC2 fleet.
sizeGiB (integer) --
The persistent volume size in GiB. The default is 250.
iops (integer) --
The IOPS per persistent volume. The default is 3000.
throughputMiB (integer) --
The throughput per persistent volume in MiB. The default is 125.
mountPath (string) --
The file system path where the persistent volume is mounted on the worker instance.
lastUsedTtlHours (integer) --
The number of hours a persistent volume can remain unused before it is deleted. The default is 168 (7 days).
autoScalingConfiguration (dict) --
The auto scaling configuration settings for the service managed EC2 fleet.
standbyWorkerCount (integer) --
The number of idle workers maintained and ready to process incoming tasks. The default is 0.
workerIdleDurationSeconds (integer) --
The number of seconds that a worker can remain idle before it is shut down. The default is 300 seconds (5 minutes).
scaleOutWorkersPerMinute (integer) --
The number of workers that can be added per minute to the fleet. The default is 10 workers per minute.
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.
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': {'jobParameters': {'bool': 'string',
'boolList': ['string'],
'floatList': ['string'],
'intList': ['string'],
'intListList': [['string']],
'pathList': ['string'],
'rangeExpr': 'string',
'stringList': ['string']}}}
Searches for jobs.
See also: AWS API Documentation
Request Syntax
client.search_jobs(
farmId='string',
filterExpressions={
'filters': [
{
'dateTimeFilter': {
'name': 'string',
'operator': 'EQUAL'|'NOT_EQUAL'|'GREATER_THAN_EQUAL_TO'|'GREATER_THAN'|'LESS_THAN_EQUAL_TO'|'LESS_THAN'|'ANY_EQUALS'|'ALL_NOT_EQUALS',
'dateTime': datetime(2015, 1, 1)
},
'parameterFilter': {
'name': 'string',
'operator': 'EQUAL'|'NOT_EQUAL'|'GREATER_THAN_EQUAL_TO'|'GREATER_THAN'|'LESS_THAN_EQUAL_TO'|'LESS_THAN'|'ANY_EQUALS'|'ALL_NOT_EQUALS',
'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'|'ANY_EQUALS'|'ALL_NOT_EQUALS',
'value': 'string'
},
'stringListFilter': {
'name': 'string',
'operator': 'EQUAL'|'NOT_EQUAL'|'GREATER_THAN_EQUAL_TO'|'GREATER_THAN'|'LESS_THAN_EQUAL_TO'|'LESS_THAN'|'ANY_EQUALS'|'ALL_NOT_EQUALS',
'values': [
'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,
queueIds=[
'string',
]
)
string
[REQUIRED]
The farm ID of the job.
dict
The search terms for a resource.
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.
stringListFilter (dict) --
Filters by a list of strings.
name (string) -- [REQUIRED]
The field name to search.
operator (string) -- [REQUIRED]
The type of comparison to use for this search.
values (list) -- [REQUIRED]
The list of string values to search for.
(string) --
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]
The offset for the search results.
integer
Specifies the number of results to return.
list
[REQUIRED]
The queue ID to use in the job search.
(string) --
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),
'updatedAt': datetime(2015, 1, 1),
'updatedBy': 'string',
'jobParameters': {
'string': {
'int': 'string',
'float': 'string',
'string': 'string',
'path': 'string',
'bool': 'string',
'rangeExpr': 'string',
'stringList': [
'string',
],
'pathList': [
'string',
],
'intList': [
'string',
],
'floatList': [
'string',
],
'boolList': [
'string',
],
'intListList': [
[
'string',
],
]
}
},
'maxWorkerCount': 123,
'sourceJobId': 'string'
},
],
'nextItemOffset': 123,
'totalResults': 123
}
Response Structure
(dict) --
Shared output fields for all Search operations (nextItemOffset, totalResults).
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 update the job's tasks to.
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.
updatedAt (datetime) --
The date and time the resource was updated.
updatedBy (string) --
The user or system that updated this resource.
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.
bool (string) --
A boolean value represented as a string. Accepted values are true, false, yes, no, on, off, 1, and 0, case-insensitive.
rangeExpr (string) --
An Open Job Description range expression represented as a string, such as 1-10:2.
stringList (list) --
A list of UTF-8 strings.
(string) --
pathList (list) --
A list of file system paths, each represented as a string.
(string) --
intList (list) --
A list of signed integers, each represented as a string.
(string) --
floatList (list) --
A list of double precision IEEE-754 floating point numbers, each represented as a string.
(string) --
boolList (list) --
A list of boolean values, each represented as a string.
(string) --
intListList (list) --
A list of lists of signed integers, each represented as a string.
(list) --
(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 item offset for the search results.
totalResults (integer) --
The total number of results in the search.
{'configuration': {'serviceManagedEc2': {'instanceCapabilities': {'softwareAddOns': [{'name': 'docker'}]}}}}
Updates a fleet.
See also: AWS API Documentation
Request Syntax
client.update_fleet(
farmId='string',
fleetId='string',
clientToken='string',
displayName='string',
description='string',
roleArn='string',
minWorkerCount=123,
maxWorkerCount=123,
configuration={
'customerManaged': {
'mode': 'NO_SCALING'|'EVENT_BASED_AUTO_SCALING',
'autoScalingConfiguration': {
'standbyWorkerCount': 123,
'workerIdleDurationSeconds': 123,
'scaleOutWorkersPerMinute': 123
},
'workerCapabilities': {
'vCpuCount': {
'min': 123,
'max': 123
},
'memoryMiB': {
'min': 123,
'max': 123
},
'acceleratorTypes': [
'gpu',
],
'acceleratorCount': {
'min': 123,
'max': 123
},
'acceleratorTotalMemoryMiB': {
'min': 123,
'max': 123
},
'osFamily': 'WINDOWS'|'LINUX'|'MACOS',
'cpuArchitectureType': 'x86_64'|'arm64',
'customAmounts': [
{
'name': 'string',
'min': ...,
'max': ...
},
],
'customAttributes': [
{
'name': 'string',
'values': [
'string',
]
},
]
},
'storageProfileId': 'string',
'tagPropagationMode': 'NO_PROPAGATION'|'PROPAGATE_TAGS_TO_WORKERS_AT_LAUNCH'
},
'serviceManagedEc2': {
'instanceCapabilities': {
'vCpuCount': {
'min': 123,
'max': 123
},
'memoryMiB': {
'min': 123,
'max': 123
},
'osFamily': 'WINDOWS'|'LINUX',
'cpuArchitectureType': 'x86_64'|'arm64',
'rootEbsVolume': {
'sizeGiB': 123,
'iops': 123,
'throughputMiB': 123
},
'acceleratorCapabilities': {
'selections': [
{
'name': 't4'|'a10g'|'l4'|'l40s'|'rtx-pro-server-6000',
'runtime': 'string'
},
],
'count': {
'min': 123,
'max': 123
}
},
'allowedInstanceTypes': [
'string',
],
'excludedInstanceTypes': [
'string',
],
'customAmounts': [
{
'name': 'string',
'min': ...,
'max': ...
},
],
'customAttributes': [
{
'name': 'string',
'values': [
'string',
]
},
],
'softwareAddOns': [
{
'name': 'docker'
},
]
},
'instanceMarketOptions': {
'type': 'on-demand'|'spot'|'wait-and-save'
},
'vpcConfiguration': {
'resourceConfigurationArns': [
'string',
]
},
'storageProfileId': 'string',
'persistentVolumeConfiguration': {
'sizeGiB': 123,
'iops': 123,
'throughputMiB': 123,
'mountPath': 'string',
'lastUsedTtlHours': 123
},
'autoScalingConfiguration': {
'standbyWorkerCount': 123,
'workerIdleDurationSeconds': 123,
'scaleOutWorkersPerMinute': 123
}
}
},
hostConfiguration={
'scriptBody': 'string',
'scriptTimeoutSeconds': 123
}
)
string
[REQUIRED]
The farm ID to update.
string
[REQUIRED]
The fleet ID to update.
string
The unique token which the server uses to recognize retries of the same request.
This field is autopopulated if not provided.
string
The display name of the fleet to update.
string
The description of the fleet to update.
string
The IAM role ARN that the fleet's workers assume while running jobs.
integer
The minimum number of workers in the fleet.
integer
The maximum number of workers in the fleet.
Deadline Cloud limits the number of workers to less than or equal to the fleet's maximum worker count. The service maintains eventual consistency for the worker count. If you make multiple rapid calls to CreateWorker before the field updates, you might exceed your fleet's maximum worker count. For example, if your maxWorkerCount is 10 and you currently have 9 workers, making two quick CreateWorker calls might successfully create 2 workers instead of 1, resulting in 11 total workers.
dict
The fleet configuration to update.
customerManaged (dict) --
The customer managed fleets within a fleet configuration.
mode (string) -- [REQUIRED]
The Auto Scaling mode for the customer managed fleet.
autoScalingConfiguration (dict) --
The auto scaling configuration settings for the customer managed fleet.
standbyWorkerCount (integer) --
The number of idle workers maintained and ready to process incoming tasks. The default is 0.
workerIdleDurationSeconds (integer) --
The number of seconds that a worker can remain idle before it is shut down. The default is 300 seconds (5 minutes).
scaleOutWorkersPerMinute (integer) --
The number of workers that can be added per minute to the fleet. The default is 10 workers per minute.
workerCapabilities (dict) -- [REQUIRED]
The worker capabilities for the customer managed fleet.
vCpuCount (dict) -- [REQUIRED]
The vCPU count for the customer manged worker capabilities.
min (integer) -- [REQUIRED]
The minimum amount of vCPU.
max (integer) --
The maximum amount of vCPU.
memoryMiB (dict) -- [REQUIRED]
The memory (MiB).
min (integer) -- [REQUIRED]
The minimum amount of memory (in MiB).
max (integer) --
The maximum amount of memory (in MiB).
acceleratorTypes (list) --
The accelerator types for the customer managed worker capabilities.
(string) --
acceleratorCount (dict) --
The range of the accelerator.
min (integer) -- [REQUIRED]
The minimum number of GPU accelerators in the worker host.
max (integer) --
The maximum number of GPU accelerators in the worker host.
acceleratorTotalMemoryMiB (dict) --
The total memory (MiB) for the customer managed worker capabilities.
min (integer) -- [REQUIRED]
The minimum amount of memory to use for the accelerator, measured in MiB.
max (integer) --
The maximum amount of memory to use for the accelerator, measured in MiB.
osFamily (string) -- [REQUIRED]
The operating system (OS) family.
cpuArchitectureType (string) -- [REQUIRED]
The CPU architecture type for the customer managed worker capabilities.
customAmounts (list) --
Custom requirement ranges for customer managed worker capabilities.
(dict) --
The fleet amount and attribute capabilities.
name (string) -- [REQUIRED]
The name of the fleet capability.
min (float) -- [REQUIRED]
The minimum amount of fleet worker capability.
max (float) --
The maximum amount of the fleet worker capability.
customAttributes (list) --
Custom attributes for the customer manged worker capabilities.
(dict) --
Defines the fleet's capability name, minimum, and maximum.
name (string) -- [REQUIRED]
The name of the fleet attribute capability for the worker.
values (list) -- [REQUIRED]
The number of fleet attribute capabilities.
(string) --
storageProfileId (string) --
The storage profile ID for the customer managed fleet.
tagPropagationMode (string) --
The tag propagation mode for the customer managed fleet.
serviceManagedEc2 (dict) --
The service managed Amazon EC2 instances for a fleet configuration.
instanceCapabilities (dict) -- [REQUIRED]
The instance capabilities for the service managed EC2 fleet.
vCpuCount (dict) -- [REQUIRED]
The amount of vCPU to require for instances in this fleet.
min (integer) -- [REQUIRED]
The minimum amount of vCPU.
max (integer) --
The maximum amount of vCPU.
memoryMiB (dict) -- [REQUIRED]
The memory, as MiB, for the Amazon EC2 instance type.
min (integer) -- [REQUIRED]
The minimum amount of memory (in MiB).
max (integer) --
The maximum amount of memory (in MiB).
osFamily (string) -- [REQUIRED]
The operating system (OS) family.
cpuArchitectureType (string) -- [REQUIRED]
The CPU architecture type.
rootEbsVolume (dict) --
The root EBS volume.
sizeGiB (integer) --
The EBS volume size in GiB.
iops (integer) --
The IOPS per volume.
throughputMiB (integer) --
The throughput per volume in MiB.
acceleratorCapabilities (dict) --
Describes the GPU accelerator capabilities required for worker host instances in this fleet.
selections (list) -- [REQUIRED]
A list of accelerator capabilities requested for this fleet. Only Amazon Elastic Compute Cloud instances that provide these capabilities will be used. For example, if you specify both L4 and T4 chips, Amazon Web Services Deadline Cloud will use Amazon EC2 instances that have either the L4 or the T4 chip installed.
(dict) --
Describes a specific GPU accelerator required for an Amazon Elastic Compute Cloud worker host.
name (string) -- [REQUIRED]
The name of the chip used by the GPU accelerator.
The available GPU accelerators are:
t4 - NVIDIA T4 Tensor Core GPU (16 GiB memory)
a10g - NVIDIA A10G Tensor Core GPU (24 GiB memory)
l4 - NVIDIA L4 Tensor Core GPU (24 GiB memory)
l40s - NVIDIA L40S Tensor Core GPU (48 GiB memory)
rtx-pro-server-6000 - NVIDIA RTX PRO Server 6000 GPU (96 GiB memory)
runtime (string) --
Specifies the runtime driver to use for the GPU accelerator. You must use the same runtime for all GPUs in a fleet.
You can choose from the following runtimes:
latest - Use the latest runtime available for the chip. If you specify latest and a new version of the runtime is released, the new version of the runtime is used.
grid:r580 - NVIDIA vGPU software 19
grid:r570 - NVIDIA vGPU software 18
grid:r535 - NVIDIA vGPU software 16
If you don't specify a runtime, Amazon Web Services Deadline Cloud uses latest as the default. However, if you have multiple accelerators and specify latest for some and leave others blank, Amazon Web Services Deadline Cloud raises an exception.
count (dict) --
The number of GPU accelerators specified for worker hosts in this fleet.
min (integer) -- [REQUIRED]
The minimum number of GPU accelerators in the worker host.
max (integer) --
The maximum number of GPU accelerators in the worker host.
allowedInstanceTypes (list) --
The allowable Amazon EC2 instance types.
(string) --
excludedInstanceTypes (list) --
The instance types to exclude from the fleet.
(string) --
customAmounts (list) --
The custom capability amounts to require for instances in this fleet.
(dict) --
The fleet amount and attribute capabilities.
name (string) -- [REQUIRED]
The name of the fleet capability.
min (float) -- [REQUIRED]
The minimum amount of fleet worker capability.
max (float) --
The maximum amount of the fleet worker capability.
customAttributes (list) --
The custom capability attributes to require for instances in this fleet.
(dict) --
Defines the fleet's capability name, minimum, and maximum.
name (string) -- [REQUIRED]
The name of the fleet attribute capability for the worker.
values (list) -- [REQUIRED]
The number of fleet attribute capabilities.
(string) --
softwareAddOns (list) --
The software add-ons that the service installs on worker hosts when they launch.
(dict) --
Software that the service installs on worker hosts in a service-managed fleet.
name (string) -- [REQUIRED]
The name of the software add-on. The supported value is docker.
instanceMarketOptions (dict) -- [REQUIRED]
The instance market options for the service managed EC2 fleet.
type (string) -- [REQUIRED]
The Amazon EC2 instance type.
vpcConfiguration (dict) --
The VPC configuration for the service managed EC2 fleet.
resourceConfigurationArns (list) --
The ARNs of the VPC Lattice resource configurations attached to the fleet.
(string) --
storageProfileId (string) --
The storage profile ID for the service managed EC2 fleet.
persistentVolumeConfiguration (dict) --
The persistent volume configuration for the service managed EC2 fleet.
sizeGiB (integer) --
The persistent volume size in GiB. The default is 250.
iops (integer) --
The IOPS per persistent volume. The default is 3000.
throughputMiB (integer) --
The throughput per persistent volume in MiB. The default is 125.
mountPath (string) -- [REQUIRED]
The file system path where the persistent volume is mounted on the worker instance.
lastUsedTtlHours (integer) --
The number of hours a persistent volume can remain unused before it is deleted. The default is 168 (7 days).
autoScalingConfiguration (dict) --
The auto scaling configuration settings for the service managed EC2 fleet.
standbyWorkerCount (integer) --
The number of idle workers maintained and ready to process incoming tasks. The default is 0.
workerIdleDurationSeconds (integer) --
The number of seconds that a worker can remain idle before it is shut down. The default is 300 seconds (5 minutes).
scaleOutWorkersPerMinute (integer) --
The number of workers that can be added per minute to the fleet. The default is 10 workers per minute.
dict
Provides a script that runs as a worker is starting up that you can use to provide additional configuration for workers in your fleet.
scriptBody (string) -- [REQUIRED]
The text of the script that runs as a worker is starting up that you can use to provide additional configuration for workers in your fleet. The script runs after a worker enters the STARTING state and before the worker processes tasks.
For more information about using the script, see Run scripts as an administrator to configure workers in the Deadline Cloud Developer Guide.
scriptTimeoutSeconds (integer) --
The maximum time that the host configuration can run. If the timeout expires, the worker enters the NOT RESPONDING state and shuts down. You are charged for the time that the worker is running the host configuration script.
The default is 300 seconds (5 minutes).
dict
Response Syntax
{}
Response Structure
(dict) --
{'assignedSessions': {'metadata': {'string': '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'
},
'metadata': {
'string': '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 attachments to sync for the assigned session action.
stepId (string) --
The step ID for the assigned sync input job attachments session action.
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.
metadata (dict) --
Key-value hints that the service provides to guide how the session runs. This value is used by the worker agent.
(string) --
(string) --
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.