DeadlineCloud / Client / list_jobs

list_jobs

DeadlineCloud.Client.list_jobs(**kwargs)

Lists jobs.

See also: AWS API Documentation

Request Syntax

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

Parameters:

• farmId (string) –

  [REQUIRED]

  The farm ID for the jobs.

• principalId (string) – The principal ID of the members on the jobs.

• queueId (string) –

  [REQUIRED]

  The queue ID for the job.

• nextToken (string) – The token for the next set of results, or null to start from the beginning.

• maxResults (integer) – The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

Return type:

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
        },
    ],
    '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.

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

Exceptions

• DeadlineCloud.Client.exceptions.AccessDeniedException

• DeadlineCloud.Client.exceptions.InternalServerErrorException

• DeadlineCloud.Client.exceptions.ResourceNotFoundException

• DeadlineCloud.Client.exceptions.ThrottlingException

• DeadlineCloud.Client.exceptions.ValidationException