DeadlineCloud / Paginator / ListJobs

ListJobs#

class DeadlineCloud.Paginator.ListJobs#
paginator = client.get_paginator('list_jobs')
paginate(**kwargs)#

Creates an iterator that will paginate through responses from DeadlineCloud.Client.list_jobs().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    farmId='string',
    principalId='string',
    queueId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
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.

  • PaginationConfig (dict) –

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) –

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) –

      The size of each page.

    • StartingToken (string) –

      A token to specify where to start paginating. This is the NextToken from a previous response.

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,
            '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) –

      A token to resume pagination.