Jump to Content

This API Documentation is now deprecated

We are excited to announce our new API Documentation.

Interface ListNotebookExecutionsCommandInputProtected

The input for ListNotebookExecutionsCommand.

Hierarchy

Properties

EditorId? ExecutionEngineId? From? Marker? Status? To?

Properties

Optional EditorId

EditorId?: string

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

Optional ExecutionEngineId

ExecutionEngineId?: string

The unique ID of the execution engine.

Optional From

From?: Date

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

Optional Marker

Marker?: string

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

Optional Status

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.

Optional To

To?: Date

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

Settings

Member Visibility

Theme