EMR / Paginator / ListNotebookExecutions

ListNotebookExecutions#

class EMR.Paginator.ListNotebookExecutions#

paginator = client.get_paginator('list_notebook_executions')

paginate(**kwargs)#

Creates an iterator that will paginate through responses from EMR.Client.list_notebook_executions().

Request Syntax

response_iterator = paginator.paginate(
    EditorId='string',
    Status='START_PENDING'|'STARTING'|'RUNNING'|'FINISHING'|'FINISHED'|'FAILING'|'FAILED'|'STOP_PENDING'|'STOPPING'|'STOPPED',
    From=datetime(2015, 1, 1),
    To=datetime(2015, 1, 1),
    ExecutionEngineId='string',
    PaginationConfig={
        'MaxItems': 123,
        'StartingToken': 'string'
    }
)

Parameters:

EditorId (string) – The unique ID of the editor associated with the notebook execution.
Status (string) –
The status filter for listing notebook executions.
- START_PENDING indicates that the cluster has received the execution request but execution has not begun.
- STARTING indicates that the execution is starting on the cluster.
- RUNNING indicates that the execution is being processed by the cluster.
- FINISHING indicates that execution processing is in the final stages.
- FINISHED indicates that the execution has completed without error.
- FAILING indicates that the execution is failing and will not finish successfully.
- FAILED indicates that the execution failed.
- STOP_PENDING indicates that the cluster has received a StopNotebookExecution request and the stop is pending.
- STOPPING indicates that the cluster is in the process of stopping the execution as a result of a StopNotebookExecution request.
- STOPPED indicates that the execution stopped because of a StopNotebookExecution request.
From (datetime) – The beginning of time range filter for listing notebook executions. The default is the timestamp of 30 days ago.
To (datetime) – The end of time range filter for listing notebook executions. The default is the current timestamp.
ExecutionEngineId (string) – The unique ID of the execution engine.
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.
- StartingToken (string) –
  
  A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'NotebookExecutions': [
        {
            'NotebookExecutionId': 'string',
            'EditorId': 'string',
            'NotebookExecutionName': 'string',
            'Status': 'START_PENDING'|'STARTING'|'RUNNING'|'FINISHING'|'FINISHED'|'FAILING'|'FAILED'|'STOP_PENDING'|'STOPPING'|'STOPPED',
            'StartTime': datetime(2015, 1, 1),
            'EndTime': datetime(2015, 1, 1),
            'NotebookS3Location': {
                'Bucket': 'string',
                'Key': 'string'
            },
            'ExecutionEngineId': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- NotebookExecutions (list) –
  
  A list of notebook executions.
  - (dict) –
    
    Details for a notebook execution. The details include information such as the unique ID and status of the notebook execution.
    - NotebookExecutionId (string) –
      
      The unique identifier of the notebook execution.
    - EditorId (string) –
      
      The unique identifier of the editor associated with the notebook execution.
    - NotebookExecutionName (string) –
      
      The name of the notebook execution.
    - Status (string) –
      
      The status of the notebook execution.
      - START_PENDING indicates that the cluster has received the execution request but execution has not begun.
      - STARTING indicates that the execution is starting on the cluster.
      - RUNNING indicates that the execution is being processed by the cluster.
      - FINISHING indicates that execution processing is in the final stages.
      - FINISHED indicates that the execution has completed without error.
      - FAILING indicates that the execution is failing and will not finish successfully.
      - FAILED indicates that the execution failed.
      - STOP_PENDING indicates that the cluster has received a StopNotebookExecution request and the stop is pending.
      - STOPPING indicates that the cluster is in the process of stopping the execution as a result of a StopNotebookExecution request.
      - STOPPED indicates that the execution stopped because of a StopNotebookExecution request.
    - StartTime (datetime) –
      
      The timestamp when notebook execution started.
    - EndTime (datetime) –
      
      The timestamp when notebook execution started.
    - NotebookS3Location (dict) –
      
      The Amazon S3 location that stores the notebook execution input.
      - Bucket (string) –
        
        The Amazon S3 bucket that stores the notebook execution input.
      - Key (string) –
        
        The key to the Amazon S3 location that stores the notebook execution input.
    - ExecutionEngineId (string) –
      
      The unique ID of the execution engine for the notebook execution.
- NextToken (string) –
  
  A token to resume pagination.