Batch / Paginator / ListJobs

ListJobs¶

class Batch.Paginator.ListJobs¶

paginator = client.get_paginator('list_jobs')

paginate(**kwargs)¶

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

Request Syntax

response_iterator = paginator.paginate(
    jobQueue='string',
    arrayJobId='string',
    multiNodeJobId='string',
    jobStatus='SUBMITTED'|'PENDING'|'RUNNABLE'|'STARTING'|'RUNNING'|'SUCCEEDED'|'FAILED',
    filters=[
        {
            'name': 'string',
            'values': [
                'string',
            ]
        },
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

jobQueue (string) – The name or full Amazon Resource Name (ARN) of the job queue used to list jobs.
arrayJobId (string) – The job ID for an array job. Specifying an array job ID with this parameter lists all child jobs from within the specified array.
multiNodeJobId (string) – The job ID for a multi-node parallel job. Specifying a multi-node parallel job ID with this parameter lists all nodes that are associated with the specified job.
jobStatus (string) –
The job status used to filter jobs in the specified queue. If the filters parameter is specified, the jobStatus parameter is ignored and jobs with any status are returned. The exception is the SHARE_IDENTIFIER filter and jobStatus can be used together. If you don’t specify a status, only RUNNING jobs are returned.

Note
Array job parents are updated to PENDING when any child job is updated to RUNNABLE and remain in PENDING status while child jobs are running. To view these jobs, filter by PENDING status until all child jobs reach a terminal state.
filters (list) –
The filter to apply to the query. Only one filter can be used at a time. When the filter is used, jobStatus is ignored with the exception that SHARE_IDENTIFIER and jobStatus can be used together. The filter doesn’t apply to child jobs in an array or multi-node parallel (MNP) jobs. The results are sorted by the createdAt field, with the most recent jobs being first.

Note
The SHARE_IDENTIFIER filter and the jobStatus field can be used together to filter results.

JOB_NAME

The value of the filter is a case-insensitive match for the job name. If the value ends with an asterisk (*), the filter matches any job name that begins with the string before the ‘*’. This corresponds to the jobName value. For example, test1 matches both Test1 and test1, and test1* matches both test1 and Test10. When the JOB_NAME filter is used, the results are grouped by the job name and version.

JOB_DEFINITION

The value for the filter is the name or Amazon Resource Name (ARN) of the job definition. This corresponds to the jobDefinition value. The value is case sensitive. When the value for the filter is the job definition name, the results include all the jobs that used any revision of that job definition name. If the value ends with an asterisk (*), the filter matches any job definition name that begins with the string before the ‘*’. For example, jd1 matches only jd1, and jd1* matches both jd1 and jd1A. The version of the job definition that’s used doesn’t affect the sort order. When the JOB_DEFINITION filter is used and the ARN is used (which is in the form arn:${Partition}:batch:${Region}:${Account}:job-definition/${JobDefinitionName}:${Revision}), the results include jobs that used the specified revision of the job definition. Asterisk (*) isn’t supported when the ARN is used.

BEFORE_CREATED_AT

The value for the filter is the time that’s before the job was created. This corresponds to the createdAt value. The value is a string representation of the number of milliseconds since 00:00:00 UTC (midnight) on January 1, 1970.

AFTER_CREATED_AT

The value for the filter is the time that’s after the job was created. This corresponds to the createdAt value. The value is a string representation of the number of milliseconds since 00:00:00 UTC (midnight) on January 1, 1970.

SHARE_IDENTIFIER

The value for the filter is the fairshare scheduling share identifier.
- (dict) –
  
  A filter name and value pair that’s used to return a more specific list of results from a ListJobs or ListJobsByConsumableResource API operation.
  - name (string) –
    
    The name of the filter. Filter names are case sensitive.
  - values (list) –
    
    The filter values.
    - (string) –
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

{
    'jobSummaryList': [
        {
            'jobArn': 'string',
            'jobId': 'string',
            'jobName': 'string',
            'capacityUsage': [
                {
                    'capacityUnit': 'string',
                    'quantity': 123.0
                },
            ],
            'createdAt': 123,
            'scheduledAt': 123,
            'shareIdentifier': 'string',
            'status': 'SUBMITTED'|'PENDING'|'RUNNABLE'|'STARTING'|'RUNNING'|'SUCCEEDED'|'FAILED',
            'statusReason': 'string',
            'startedAt': 123,
            'stoppedAt': 123,
            'container': {
                'exitCode': 123,
                'reason': 'string'
            },
            'arrayProperties': {
                'size': 123,
                'index': 123,
                'statusSummary': {
                    'string': 123
                },
                'statusSummaryLastUpdatedAt': 123
            },
            'nodeProperties': {
                'isMainNode': True|False,
                'numNodes': 123,
                'nodeIndex': 123
            },
            'jobDefinition': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- jobSummaryList (list) –
  
  A list of job summaries that match the request.
  - (dict) –
    
    An object that represents summary details of a job.
    - jobArn (string) –
      
      The Amazon Resource Name (ARN) of the job.
    - jobId (string) –
      
      The job ID.
    - jobName (string) –
      
      The job name.
    - capacityUsage (list) –
      
      The configured capacity usage information for this job, including the unit of measure and quantity of resources.
      - (dict) –
        
        The capacity usage for a job, including the unit of measure and quantity of resources being used.
        
        capacityUnit (string) –
        
        The unit of measure for the capacity usage. This is VCPU for Amazon EC2 and cpu for Amazon EKS.
        
        quantity (float) –
        
        The quantity of capacity being used by the job, measured in the units specified by capacityUnit.
    - createdAt (integer) –
      
      The Unix timestamp (in milliseconds) for when the job was created. For non-array jobs and parent array jobs, this is when the job entered the SUBMITTED state (at the time SubmitJob was called). For array child jobs, this is when the child job was spawned by its parent and entered the PENDING state.
    - scheduledAt (integer) –
      
      The Unix timestamp (in milliseconds) for when the job was scheduled for execution. For more information on job statues, see Service job status in the Batch User Guide.
    - shareIdentifier (string) –
      
      The share identifier for the fairshare scheduling queue that this job is associated with.
    - status (string) –
      
      The current status for the job.
    - statusReason (string) –
      
      A short, human-readable string to provide more details for the current status of the job.
    - startedAt (integer) –
      
      The Unix timestamp for when the job was started. More specifically, it’s when the job transitioned from the STARTING state to the RUNNING state.
    - stoppedAt (integer) –
      
      The Unix timestamp for when the job was stopped. More specifically, it’s when the job transitioned from the RUNNING state to a terminal state, such as SUCCEEDED or FAILED.
    - container (dict) –
      
      An object that represents the details of the container that’s associated with the job.
      - exitCode (integer) –
        
        The exit code to return upon completion.
      - reason (string) –
        
        A short (255 max characters) human-readable string to provide additional details for a running or stopped container.
    - arrayProperties (dict) –
      
      The array properties of the job, if it’s an array job.
      - size (integer) –
        
        The size of the array job. This parameter is returned for parent array jobs.
      - index (integer) –
        
        The job index within the array that’s associated with this job. This parameter is returned for children of array jobs.
      - statusSummary (dict) –
        
        A summary of the number of array job children in each available job status. This parameter is returned for parent array jobs.
        
        (string) –
        
        (integer) –
      - statusSummaryLastUpdatedAt (integer) –
        
        The Unix timestamp (in milliseconds) for when the statusSummary was last updated.
    - nodeProperties (dict) –
      
      The node properties for a single node in a job summary list.
      
      Note
      This isn’t applicable to jobs that are running on Fargate resources.
      - isMainNode (boolean) –
        
        Specifies whether the current node is the main node for a multi-node parallel job.
      - numNodes (integer) –
        
        The number of nodes that are associated with a multi-node parallel job.
      - nodeIndex (integer) –
        
        The node index for the node. Node index numbering begins at zero. This index is also available on the node with the AWS_BATCH_JOB_NODE_INDEX environment variable.
    - jobDefinition (string) –
      
      The Amazon Resource Name (ARN) of the job definition.
- NextToken (string) –
  
  A token to resume pagination.