Skip to content

List Notebook Executions

emr_list_notebook_executions R Documentation

Provides summaries of all notebook executions

Description

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

Usage

emr_list_notebook_executions(EditorId, Status, From, To, Marker,
  ExecutionEngineId)

Arguments

EditorId

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

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 stop_notebook_execution request and the stop is pending.

  • STOPPING indicates that the cluster is in the process of stopping the execution as a result of a stop_notebook_execution request.

  • STOPPED indicates that the execution stopped because of a stop_notebook_execution request.

From

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

To

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

Marker

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

ExecutionEngineId

The unique ID of the execution engine.

Value

A list with the following syntax: 

list(
  NotebookExecutions = list(
    list(
      NotebookExecutionId = "string",
      EditorId = "string",
      NotebookExecutionName = "string",
      Status = "START_PENDING"|"STARTING"|"RUNNING"|"FINISHING"|"FINISHED"|"FAILING"|"FAILED"|"STOP_PENDING"|"STOPPING"|"STOPPED",
      StartTime = as.POSIXct(
        "2015-01-01"
      ),
      EndTime = as.POSIXct(
        "2015-01-01"
      ),
      NotebookS3Location = list(
        Bucket = "string",
        Key = "string"
      ),
      ExecutionEngineId = "string"
    )
  ),
  Marker = "string"
)

Request syntax

svc$list_notebook_executions(
  EditorId = "string",
  Status = "START_PENDING"|"STARTING"|"RUNNING"|"FINISHING"|"FINISHED"|"FAILING"|"FAILED"|"STOP_PENDING"|"STOPPING"|"STOPPED",
  From = as.POSIXct(
    "2015-01-01"
  ),
  To = as.POSIXct(
    "2015-01-01"
  ),
  Marker = "string",
  ExecutionEngineId = "string"
)