AWS API Changes

2024/10/07 - AWSDeadlineCloud - 1 new4 updated api methods

Changes Add support for using the template from a previous job during job creation and listing parameter definitions for a job.

ListJobParameterDefinitions (new)

Link ¶

Lists parameter definitions of a job.

See also: AWS API Documentation

Request Syntax

client.list_job_parameter_definitions(
    farmId='string',
    jobId='string',
    queueId='string',
    nextToken='string',
    maxResults=123
)

type farmId:

string

param farmId:

[REQUIRED]

The farm ID of the job to list.

type jobId:

string

param jobId:

[REQUIRED]

The job ID to include on the list.

type queueId:

string

param queueId:

[REQUIRED]

The queue ID to include on the list.

type nextToken:

string

param nextToken:

The token for the next set of results, or null to start from the beginning.

type maxResults:

integer

param maxResults:

The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

rtype:

dict

returns:

Response Syntax

{
    'jobParameterDefinitions': [
        {...}|[...]|123|123.4|'string'|True|None,
    ],
    'nextToken': 'string'
}

Response Structure

(dict) --
- jobParameterDefinitions (list) --
  
  Lists parameter definitions of a job.
  - (:ref:`document<document>`) --
- 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.

CreateJob (updated)

Link ¶
Changes (request)

{'sourceJobId': 'string'}

Creates a job. A job is a set of instructions that AWS Deadline Cloud uses to schedule and run work on available workers. For more information, see Deadline Cloud jobs.

See also: AWS API Documentation

Request Syntax

client.create_job(
    farmId='string',
    queueId='string',
    clientToken='string',
    template='string',
    templateType='JSON'|'YAML',
    priority=123,
    parameters={
        'string': {
            'int': 'string',
            'float': 'string',
            'string': 'string',
            'path': 'string'
        }
    },
    attachments={
        'manifests': [
            {
                'fileSystemLocationName': 'string',
                'rootPath': 'string',
                'rootPathFormat': 'windows'|'posix',
                'outputRelativeDirectories': [
                    'string',
                ],
                'inputManifestPath': 'string',
                'inputManifestHash': 'string'
            },
        ],
        'fileSystem': 'COPIED'|'VIRTUAL'
    },
    storageProfileId='string',
    targetTaskRunStatus='READY'|'SUSPENDED',
    maxFailedTasksCount=123,
    maxRetriesPerTask=123,
    sourceJobId='string'
)

type farmId:

string

param farmId:

[REQUIRED]

The farm ID of the farm to connect to the job.

type queueId:

string

param queueId:

[REQUIRED]

The ID of the queue that the job is submitted to.

type clientToken:

string

param clientToken:

The unique token which the server uses to recognize retries of the same request.

This field is autopopulated if not provided.

type template:

string

param template:

The job template to use for this job.

type templateType:

string

param templateType:

The file type for the job template.

type priority:

integer

param priority:

[REQUIRED]

The priority of the job on a scale of 0 to 100. The highest priority (first scheduled) is 100. When two jobs have the same priority, the oldest job is scheduled first.

type parameters:

dict

param parameters:

The parameters for the job.

(string) --
- (dict) --
  
  The details of job parameters.
  
  Note
  
  This is a Tagged Union structure. Only one of the following top level keys can be set: int, float, string, path.
  - 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.

type attachments:

dict

param attachments:

The attachments for the job. Attach files required for the job to run to a render job.

manifests (list) -- [REQUIRED]

A list of manifests which describe job attachment configurations.
- (dict) --
  
  The details of the manifest that links a job's source information.
  - fileSystemLocationName (string) --
    
    The file system location name.
  - rootPath (string) -- [REQUIRED]
    
    The file's root path.
  - rootPathFormat (string) -- [REQUIRED]
    
    The format of the root path.
  - outputRelativeDirectories (list) --
    
    The file path relative to the directory.
    - (string) --
  - inputManifestPath (string) --
    
    The file path.
  - inputManifestHash (string) --
    
    The has value of the file.
fileSystem (string) --

The file system.

type storageProfileId:

string

param storageProfileId:

The storage profile ID for the storage profile to connect to the job.

type targetTaskRunStatus:

string

param targetTaskRunStatus:

The initial job status when it is created. Jobs that are created with a SUSPENDED status will not run until manually requeued.

type maxFailedTasksCount:

integer

param maxFailedTasksCount:

The number of task failures before the job stops running and is marked as FAILED.

type maxRetriesPerTask:

integer

param maxRetriesPerTask:

The maximum number of retries for each task.

type sourceJobId:

string

param sourceJobId:

The job ID for the source job.

rtype:

dict

returns:

Response Syntax

{
    'jobId': 'string'
}

Response Structure

(dict) --
- jobId (string) --
  
  The job ID.

GetJob (updated)

Link ¶
Changes (response)

{'sourceJobId': 'string'}

Gets a Deadline Cloud job.

See also: AWS API Documentation

Request Syntax

client.get_job(
    farmId='string',
    jobId='string',
    queueId='string'
)

type farmId:

string

param farmId:

[REQUIRED]

The farm ID of the farm in the job.

type jobId:

string

param jobId:

[REQUIRED]

The job ID.

type queueId:

string

param queueId:

[REQUIRED]

The queue ID associated with the job.

rtype:

dict

returns:

Response Syntax

{
    'jobId': 'string',
    'name': 'string',
    'lifecycleStatus': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'CREATE_COMPLETE'|'UPLOAD_IN_PROGRESS'|'UPLOAD_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_FAILED'|'UPDATE_SUCCEEDED'|'ARCHIVED',
    'lifecycleStatusMessage': 'string',
    'priority': 123,
    'createdAt': datetime(2015, 1, 1),
    'createdBy': 'string',
    'updatedAt': datetime(2015, 1, 1),
    'updatedBy': 'string',
    'startedAt': datetime(2015, 1, 1),
    'endedAt': datetime(2015, 1, 1),
    'taskRunStatus': 'PENDING'|'READY'|'ASSIGNED'|'STARTING'|'SCHEDULED'|'INTERRUPTING'|'RUNNING'|'SUSPENDED'|'CANCELED'|'FAILED'|'SUCCEEDED'|'NOT_COMPATIBLE',
    'targetTaskRunStatus': 'READY'|'FAILED'|'SUCCEEDED'|'CANCELED'|'SUSPENDED'|'PENDING',
    'taskRunStatusCounts': {
        'string': 123
    },
    'storageProfileId': 'string',
    'maxFailedTasksCount': 123,
    'maxRetriesPerTask': 123,
    'parameters': {
        'string': {
            'int': 'string',
            'float': 'string',
            'string': 'string',
            'path': 'string'
        }
    },
    'attachments': {
        'manifests': [
            {
                'fileSystemLocationName': 'string',
                'rootPath': 'string',
                'rootPathFormat': 'windows'|'posix',
                'outputRelativeDirectories': [
                    'string',
                ],
                'inputManifestPath': 'string',
                'inputManifestHash': 'string'
            },
        ],
        'fileSystem': 'COPIED'|'VIRTUAL'
    },
    'description': 'string',
    'sourceJobId': 'string'
}

Response Structure

(dict) --
- jobId (string) --
  
  The job ID.
- name (string) --
  
  The name of the job.
- lifecycleStatus (string) --
  
  The life cycle status for the job.
- lifecycleStatusMessage (string) --
  
  A message that communicates the status of the life cycle for the job.
- priority (integer) --
  
  The job priority.
- createdAt (datetime) --
  
  The date and time the resource was created.
- createdBy (string) --
  
  The user or system that created this resource.
- updatedAt (datetime) --
  
  The date and time the resource was updated.
- updatedBy (string) --
  
  The user or system that updated this resource.
- startedAt (datetime) --
  
  The date and time the resource started running.
- endedAt (datetime) --
  
  The date and time the resource ended running.
- taskRunStatus (string) --
  
  The task run status for the job.
- targetTaskRunStatus (string) --
  
  The task status with which the job started.
- taskRunStatusCounts (dict) --
  
  The number of tasks running on the job.
  - (string) --
    - (integer) --
- storageProfileId (string) --
  
  The storage profile ID associated with the job.
- maxFailedTasksCount (integer) --
  
  The number of task failures before the job stops running and is marked as FAILED.
- maxRetriesPerTask (integer) --
  
  The maximum number of retries per failed tasks.
- parameters (dict) --
  
  The parameters for the job.
  - (string) --
    - (dict) --
      
      The details of job parameters.
      Note
      
      This is a Tagged Union structure. Only one of the following top level keys will be set: int, float, string, path. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
      
      'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
      - int (string) --
        
        A signed integer represented as a string.
      - float (string) --
        
        A double precision IEEE-754 floating point number represented as a string.
      - string (string) --
        
        A UTF-8 string.
      - path (string) --
        
        A file system path represented as a string.
- attachments (dict) --
  
  The attachments for the job.
  - manifests (list) --
    
    A list of manifests which describe job attachment configurations.
    - (dict) --
      
      The details of the manifest that links a job's source information.
      - fileSystemLocationName (string) --
        
        The file system location name.
      - rootPath (string) --
        
        The file's root path.
      - rootPathFormat (string) --
        
        The format of the root path.
      - outputRelativeDirectories (list) --
        
        The file path relative to the directory.
        
        (string) --
      - inputManifestPath (string) --
        
        The file path.
      - inputManifestHash (string) --
        
        The has value of the file.
  - fileSystem (string) --
    
    The file system.
- description (string) --
  
  The description of the job.
  
  Warning
  
  This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
- sourceJobId (string) --
  
  The job ID for the source job.

ListJobs (updated)

Link ¶
Changes (response)

{'jobs': {'sourceJobId': 'string'}}

Lists jobs.

See also: AWS API Documentation

Request Syntax

client.list_jobs(
    farmId='string',
    principalId='string',
    queueId='string',
    nextToken='string',
    maxResults=123
)

type farmId:

string

param farmId:

[REQUIRED]

The farm ID for the jobs.

type principalId:

string

param principalId:

The principal ID of the members on the jobs.

type queueId:

string

param queueId:

[REQUIRED]

The queue ID for the job.

type nextToken:

string

param nextToken:

The token for the next set of results, or null to start from the beginning.

type maxResults:

integer

param maxResults:

The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

rtype:

dict

returns:

Response Syntax

{
    'jobs': [
        {
            'jobId': 'string',
            'name': 'string',
            'lifecycleStatus': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'CREATE_COMPLETE'|'UPLOAD_IN_PROGRESS'|'UPLOAD_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_FAILED'|'UPDATE_SUCCEEDED'|'ARCHIVED',
            'lifecycleStatusMessage': 'string',
            'priority': 123,
            'createdAt': datetime(2015, 1, 1),
            'createdBy': 'string',
            'updatedAt': datetime(2015, 1, 1),
            'updatedBy': 'string',
            'startedAt': datetime(2015, 1, 1),
            'endedAt': datetime(2015, 1, 1),
            'taskRunStatus': 'PENDING'|'READY'|'ASSIGNED'|'STARTING'|'SCHEDULED'|'INTERRUPTING'|'RUNNING'|'SUSPENDED'|'CANCELED'|'FAILED'|'SUCCEEDED'|'NOT_COMPATIBLE',
            'targetTaskRunStatus': 'READY'|'FAILED'|'SUCCEEDED'|'CANCELED'|'SUSPENDED'|'PENDING',
            'taskRunStatusCounts': {
                'string': 123
            },
            'maxFailedTasksCount': 123,
            'maxRetriesPerTask': 123,
            'sourceJobId': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) --
- jobs (list) --
  
  The jobs on the list.
  - (dict) --
    
    A summary of job details.
    - jobId (string) --
      
      The job ID.
    - name (string) --
      
      The job name.
    - lifecycleStatus (string) --
      
      The life cycle status.
    - lifecycleStatusMessage (string) --
      
      The life cycle status message.
    - priority (integer) --
      
      The job priority.
    - createdAt (datetime) --
      
      The date and time the resource was created.
    - createdBy (string) --
      
      The user or system that created this resource.
    - updatedAt (datetime) --
      
      The date and time the resource was updated.
    - updatedBy (string) --
      
      The user or system that updated this resource.
    - startedAt (datetime) --
      
      The date and time the resource started running.
    - endedAt (datetime) --
      
      The date and time the resource ended running.
    - taskRunStatus (string) --
      
      The task run status for the job.
      - PENDING–pending and waiting for resources.
      - READY–ready to be processed.
      - ASSIGNED–assigned and will run next on a worker.
      - SCHEDULED–scheduled to be run on a worker.
      - INTERRUPTING–being interrupted.
      - RUNNING–running on a worker.
      - SUSPENDED–the task is suspended.
      - CANCELED–the task has been canceled.
      - FAILED–the task has failed.
      - SUCCEEDED–the task has succeeded.
    - targetTaskRunStatus (string) --
      
      The task status to start with on the job.
    - taskRunStatusCounts (dict) --
      
      The number of tasks running on the job.
      - (string) --
        
        (integer) --
    - maxFailedTasksCount (integer) --
      
      The number of task failures before the job stops running and is marked as FAILED.
    - maxRetriesPerTask (integer) --
      
      The maximum number of retries for a job.
    - sourceJobId (string) --
      
      The job ID for the source job.
- nextToken (string) --
  
  If Deadline Cloud returns nextToken, then there are more results available. The value of nextToken is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, then nextToken is set to null. Each pagination token expires after 24 hours. If you provide a token that isn't valid, then you receive an HTTP 400 ValidationException error.

SearchJobs (updated)

Link ¶
Changes (response)

{'jobs': {'sourceJobId': 'string'}}

Searches for jobs.

See also: AWS API Documentation

Request Syntax

client.search_jobs(
    farmId='string',
    queueIds=[
        'string',
    ],
    filterExpressions={
        'filters': [
            {
                'dateTimeFilter': {
                    'name': 'string',
                    'operator': 'EQUAL'|'NOT_EQUAL'|'GREATER_THAN_EQUAL_TO'|'GREATER_THAN'|'LESS_THAN_EQUAL_TO'|'LESS_THAN',
                    'dateTime': datetime(2015, 1, 1)
                },
                'parameterFilter': {
                    'name': 'string',
                    'operator': 'EQUAL'|'NOT_EQUAL'|'GREATER_THAN_EQUAL_TO'|'GREATER_THAN'|'LESS_THAN_EQUAL_TO'|'LESS_THAN',
                    'value': 'string'
                },
                'searchTermFilter': {
                    'searchTerm': 'string'
                },
                'stringFilter': {
                    'name': 'string',
                    'operator': 'EQUAL'|'NOT_EQUAL'|'GREATER_THAN_EQUAL_TO'|'GREATER_THAN'|'LESS_THAN_EQUAL_TO'|'LESS_THAN',
                    'value': 'string'
                },
                'groupFilter': {'... recursive ...'}
            },
        ],
        'operator': 'AND'|'OR'
    },
    sortExpressions=[
        {
            'userJobsFirst': {
                'userIdentityId': 'string'
            },
            'fieldSort': {
                'sortOrder': 'ASCENDING'|'DESCENDING',
                'name': 'string'
            },
            'parameterSort': {
                'sortOrder': 'ASCENDING'|'DESCENDING',
                'name': 'string'
            }
        },
    ],
    itemOffset=123,
    pageSize=123
)

type farmId:

string

param farmId:

[REQUIRED]

The farm ID of the job.

type queueIds:

list

param queueIds:

[REQUIRED]

The queue ID to use in the job search.

(string) --

type filterExpressions:

dict

param filterExpressions:

The filter expression, AND or OR, to use when searching among a group of search strings in a resource.

You can use two groupings per search each within parenthesis ().

filters (list) -- [REQUIRED]

The filters to use for the search.
- (dict) --
  
  The type of search filter to apply.
  
  Note
  
  This is a Tagged Union structure. Only one of the following top level keys can be set: dateTimeFilter, parameterFilter, searchTermFilter, stringFilter, groupFilter.
  - dateTimeFilter (dict) --
    
    Filters based on date and time.
    - name (string) -- [REQUIRED]
      
      The name of the date-time field to filter on.
    - operator (string) -- [REQUIRED]
      
      The type of comparison to use to filter the results.
    - dateTime (datetime) -- [REQUIRED]
      
      The date and time.
  - parameterFilter (dict) --
    
    Filters by parameter.
    - name (string) -- [REQUIRED]
      
      The name of the parameter to filter on.
    - operator (string) -- [REQUIRED]
      
      The type of comparison to use to filter results.
    - value (string) -- [REQUIRED]
      
      The parameter's value.
  - searchTermFilter (dict) --
    
    Filters by a specified search term.
    - searchTerm (string) -- [REQUIRED]
      
      The term to search for.
  - stringFilter (dict) --
    
    Filters by a string.
    - name (string) -- [REQUIRED]
      
      The field name to search.
    - operator (string) -- [REQUIRED]
      
      The type of comparison to use for this search.
    - value (string) -- [REQUIRED]
      
      The string to search for.
  - groupFilter (dict) --
    
    Filters by group.
operator (string) -- [REQUIRED]

The operators to include in the search.

type sortExpressions:

list

param sortExpressions:

The search terms for a resource.

(dict) --

The resources to search.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: userJobsFirst, fieldSort, parameterSort.
- 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.

type itemOffset:

integer

param itemOffset:

[REQUIRED]

Defines how far into the scrollable list to start the return of results.

type pageSize:

integer

param pageSize:

Specifies the number of items per page for the resource.

rtype:

dict

returns:

Response Syntax

{
    'jobs': [
        {
            'jobId': 'string',
            'queueId': 'string',
            'name': 'string',
            'lifecycleStatus': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'CREATE_COMPLETE'|'UPLOAD_IN_PROGRESS'|'UPLOAD_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_FAILED'|'UPDATE_SUCCEEDED'|'ARCHIVED',
            'lifecycleStatusMessage': 'string',
            'taskRunStatus': 'PENDING'|'READY'|'ASSIGNED'|'STARTING'|'SCHEDULED'|'INTERRUPTING'|'RUNNING'|'SUSPENDED'|'CANCELED'|'FAILED'|'SUCCEEDED'|'NOT_COMPATIBLE',
            'targetTaskRunStatus': 'READY'|'FAILED'|'SUCCEEDED'|'CANCELED'|'SUSPENDED'|'PENDING',
            'taskRunStatusCounts': {
                'string': 123
            },
            'priority': 123,
            'maxFailedTasksCount': 123,
            'maxRetriesPerTask': 123,
            'createdBy': 'string',
            'createdAt': datetime(2015, 1, 1),
            'endedAt': datetime(2015, 1, 1),
            'startedAt': datetime(2015, 1, 1),
            'jobParameters': {
                'string': {
                    'int': 'string',
                    'float': 'string',
                    'string': 'string',
                    'path': 'string'
                }
            },
            'sourceJobId': 'string'
        },
    ],
    'nextItemOffset': 123,
    'totalResults': 123
}

Response Structure

(dict) --
- jobs (list) --
  
  The jobs in the search.
  - (dict) --
    
    The details of a job search.
    - jobId (string) --
      
      The job ID.
    - queueId (string) --
      
      The queue ID.
    - name (string) --
      
      The job name.
    - lifecycleStatus (string) --
      
      The life cycle status.
    - lifecycleStatusMessage (string) --
      
      The life cycle status message.
    - taskRunStatus (string) --
      
      The task run status for the job.
      - PENDING–pending and waiting for resources.
      - READY–ready to be processed.
      - ASSIGNED–assigned and will run next on a worker.
      - SCHEDULED–scheduled to be run on a worker.
      - INTERRUPTING–being interrupted.
      - RUNNING–running on a worker.
      - SUSPENDED–the task is suspended.
      - CANCELED–the task has been canceled.
      - FAILED–the task has failed.
      - SUCCEEDED–the task has succeeded.
    - targetTaskRunStatus (string) --
      
      The task status to start with on the job.
    - taskRunStatusCounts (dict) --
      
      The number of tasks running on the job.
      - (string) --
        
        (integer) --
    - priority (integer) --
      
      The job priority.
    - maxFailedTasksCount (integer) --
      
      The number of task failures before the job stops running and is marked as FAILED.
    - maxRetriesPerTask (integer) --
      
      The maximum number of retries for a job.
    - createdBy (string) --
      
      The user or system that created this resource.
    - createdAt (datetime) --
      
      The date and time the resource was created.
    - endedAt (datetime) --
      
      The date and time the resource ended running.
    - startedAt (datetime) --
      
      The date and time the resource started running.
    - jobParameters (dict) --
      
      The job parameters.
      - (string) --
        
        (dict) --
        
        The details of job parameters.
        
        Note
        
        This is a Tagged Union structure. Only one of the following top level keys will be set: int, float, string, path. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
        
        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        
        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.
    - sourceJobId (string) --
      
      The job ID for the source job.
- nextItemOffset (integer) --
  
  The next incremental starting point after the defined itemOffset.
- totalResults (integer) --
  
  The total number of results in the search.