EMRServerless / Paginator / ListJobRuns

ListJobRuns#

class EMRServerless.Paginator.ListJobRuns#

paginator = client.get_paginator('list_job_runs')

paginate(**kwargs)#

Creates an iterator that will paginate through responses from EMRServerless.Client.list_job_runs().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    applicationId='string',
    createdAtAfter=datetime(2015, 1, 1),
    createdAtBefore=datetime(2015, 1, 1),
    states=[
        'SUBMITTED'|'PENDING'|'SCHEDULED'|'RUNNING'|'SUCCESS'|'FAILED'|'CANCELLING'|'CANCELLED',
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

applicationId (string) –
[REQUIRED]

The ID of the application for which to list the job run.
createdAtAfter (datetime) – The lower bound of the option to filter by creation date and time.
createdAtBefore (datetime) – The upper bound of the option to filter by creation date and time.
states (list) –
An optional filter for job run states. Note that if this filter contains multiple states, the resulting list will be grouped by the state.
- (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

{
    'jobRuns': [
        {
            'applicationId': 'string',
            'id': 'string',
            'name': 'string',
            'arn': 'string',
            'createdBy': 'string',
            'createdAt': datetime(2015, 1, 1),
            'updatedAt': datetime(2015, 1, 1),
            'executionRole': 'string',
            'state': 'SUBMITTED'|'PENDING'|'SCHEDULED'|'RUNNING'|'SUCCESS'|'FAILED'|'CANCELLING'|'CANCELLED',
            'stateDetails': 'string',
            'releaseLabel': 'string',
            'type': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- jobRuns (list) –
  
  The output lists information about the specified job runs.
  - (dict) –
    
    The summary of attributes associated with a job run.
    - applicationId (string) –
      
      The ID of the application the job is running on.
    - id (string) –
      
      The ID of the job run.
    - name (string) –
      
      The optional job run name. This doesn’t have to be unique.
    - arn (string) –
      
      The ARN of the job run.
    - createdBy (string) –
      
      The user who created the job run.
    - createdAt (datetime) –
      
      The date and time when the job run was created.
    - updatedAt (datetime) –
      
      The date and time when the job run was last updated.
    - executionRole (string) –
      
      The execution role ARN of the job run.
    - state (string) –
      
      The state of the job run.
    - stateDetails (string) –
      
      The state details of the job run.
    - releaseLabel (string) –
      
      The EMR release associated with the application your job is running on.
    - type (string) –
      
      The type of job run, such as Spark or Hive.
- NextToken (string) –
  
  A token to resume pagination.