list_notebook_executions

EMR.Client.list_notebook_executions(**kwargs)

Provides summaries of all notebook executions. You can filter the list based on multiple criteria such as status, time range, and editor id. Returns a maximum of 50 notebook executions and a marker to track the paging of a longer notebook execution list across multiple ListNotebookExecution calls.

See also: AWS API Documentation

Request Syntax

response = client.list_notebook_executions(
    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),
    Marker='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.
• Marker (string) -- The pagination token, returned by a previous ListNotebookExecutions call, that indicates the start of the list for this ListNotebookExecutions call.

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)
        },
    ],
    'Marker': '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.

  • Marker (string) --

    A pagination token that a subsequent ListNotebookExecutions can use to determine the next set of results to retrieve.

Exceptions

• EMR.Client.exceptions.InternalServerError
• EMR.Client.exceptions.InvalidRequestException