Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

ListNotebookExecutions

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 ListNotebookExecutions calls.

Request Syntax


{
   "EditorId": "string",
   "ExecutionEngineId": "string",
   "From": number,
   "Marker": "string",
   "Status": "string",
   "To": number
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

EditorId

The unique ID of the editor associated with the notebook execution.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 256.

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: No

ExecutionEngineId

The unique ID of the execution engine.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 10280.

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: No

From

The beginning of time range filter for listing notebook executions. The default is the timestamp of 30 days ago.

Type: Timestamp

Required: No

Marker

The pagination token, returned by a previous ListNotebookExecutions call, that indicates the start of the list for this ListNotebookExecutions call.

Type: String

Required: No

Status

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.

Type: String

Required: No

To

The end of time range filter for listing notebook executions. The default is the current timestamp.

Type: Timestamp

Required: No

Response Syntax


{
   "Marker": "string",
   "NotebookExecutions": [ 
      { 
         "EditorId": "string",
         "EndTime": number,
         "ExecutionEngineId": "string",
         "NotebookExecutionId": "string",
         "NotebookExecutionName": "string",
         "NotebookS3Location": { 
            "Bucket": "string",
            "Key": "string"
         },
         "StartTime": number,
         "Status": "string"
      }
   ]
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Marker

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

Type: String

NotebookExecutions

A list of notebook executions.

Type: Array of NotebookExecutionSummary objects

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalServerError

Indicates that an error occurred while processing the request and that the request was not completed.

HTTP Status Code: 400

InvalidRequestException

This exception occurs when there is something wrong with user input.

HTTP Status Code: 400