DeadlineCloud / Client / get_job

get_job

DeadlineCloud.Client.get_job(**kwargs)

Gets a Deadline Cloud job.

See also: AWS API Documentation

Request Syntax

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

Parameters:

• farmId (string) –

  [REQUIRED]

  The farm ID of the farm in the job.

• jobId (string) –

  [REQUIRED]

  The job ID.

• queueId (string) –

  [REQUIRED]

  The queue ID associated with the job.

Return type:

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'
}

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.

Exceptions

• DeadlineCloud.Client.exceptions.AccessDeniedException

• DeadlineCloud.Client.exceptions.InternalServerErrorException

• DeadlineCloud.Client.exceptions.ResourceNotFoundException

• DeadlineCloud.Client.exceptions.ThrottlingException

• DeadlineCloud.Client.exceptions.ValidationException