DeadlineCloud / Client / create_job

create_job#

DeadlineCloud.Client.create_job(**kwargs)#

Creates a job. A job is a render submission submitted by a user. It contains specific job properties outlined as steps and tasks.

See also: AWS API Documentation

Request Syntax

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

  • attachments (dict) –

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

    • fileSystem (string) –

      The file system.

    • 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.

        • inputManifestHash (string) –

          The has value of the file.

        • inputManifestPath (string) –

          The file path.

        • outputRelativeDirectories (list) –

          The file path relative to the directory.

          • (string) –

        • rootPath (string) – [REQUIRED]

          The file’s root path.

        • rootPathFormat (string) – [REQUIRED]

          The format of the root path.

  • clientToken (string) –

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

    This field is autopopulated if not provided.

  • farmId (string) –

    [REQUIRED]

    The farm ID of the farm to connect to 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 for a job.

  • 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 can be set: float, int, path, string.

        • float (string) –

          A double precision IEEE-754 floating point number represented as a string.

        • int (string) –

          A signed integer represented as a string.

        • path (string) –

          A file system path represented as a string.

        • string (string) –

          A UTF-8 string.

  • priority (integer) –

    [REQUIRED]

    The priority of the job on a scale of 1 to 100. The highest priority is 1.

  • queueId (string) –

    [REQUIRED]

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

  • storageProfileId (string) – The storage profile ID for the storage profile to connect to the job.

  • targetTaskRunStatus (string) – The initial status of the job’s tasks when they are created. Tasks that are created with a SUSPENDED status will not run until you update their status.

  • template (string) –

    [REQUIRED]

    The job template to use for this job.

  • templateType (string) –

    [REQUIRED]

    The file type for the job template.

Return type:

dict

Returns:

Response Syntax

{
    'jobId': 'string'
}

Response Structure

  • (dict) –

    • jobId (string) –

      The job ID.

Exceptions