Batch / Client / get_job_queue_snapshot

get_job_queue_snapshot#

Batch.Client.get_job_queue_snapshot(**kwargs)#

Provides a list of the first 100 RUNNABLE jobs associated to a single job queue.

Request Syntax

response = client.get_job_queue_snapshot(
    jobQueue='string'
)

Parameters:

jobQueue (string) –

[REQUIRED]

The job queue’s name or full queue Amazon Resource Name (ARN).

Return type:

dict

Returns:

Response Syntax

{
    'frontOfQueue': {
        'jobs': [
            {
                'jobArn': 'string',
                'earliestTimeAtPosition': 123
            },
        ],
        'lastUpdatedAt': 123
    }
}

Response Structure

(dict) –
- frontOfQueue (dict) –
  
  The list of the first 100 RUNNABLE jobs in each job queue. For first-in-first-out (FIFO) job queues, jobs are ordered based on their submission time. For fair share scheduling (FSS) job queues, jobs are ordered based on their job priority and share usage.
  - jobs (list) –
    
    The Amazon Resource Names (ARNs) of the first 100 RUNNABLE jobs in a named job queue. For first-in-first-out (FIFO) job queues, jobs are ordered based on their submission time. For fair share scheduling (FSS) job queues, jobs are ordered based on their job priority and share usage.
    - (dict) –
      
      An object that represents summary details for the first 100 RUNNABLE jobs in a job queue.
      - jobArn (string) –
        
        The ARN for a job in a named job queue.
      - earliestTimeAtPosition (integer) –
        
        The Unix timestamp (in milliseconds) for when the job transitioned to its current position in the job queue.
  - lastUpdatedAt (integer) –
    
    The Unix timestamp (in milliseconds) for when each of the first 100 RUNNABLE jobs were last updated.

Exceptions

Batch.Client.exceptions.ClientException
Batch.Client.exceptions.ServerException