Skip to content

Starts a notebook execution

Description

Starts a notebook execution.

Usage

emr_start_notebook_execution(EditorId, RelativePath,
  NotebookExecutionName, NotebookParams, ExecutionEngine, ServiceRole,
  NotebookInstanceSecurityGroupId, Tags, NotebookS3Location,
  OutputNotebookS3Location, OutputNotebookFormat, EnvironmentVariables)

Arguments

  • EditorId

The unique identifier of the Amazon EMR Notebook to use for notebook execution.

  • RelativePath

The path and file name of the notebook file for this execution, relative to the path specified for the Amazon EMR Notebook. For example, if you specify a path of s3://MyBucket/MyNotebooks when you create an Amazon EMR Notebook for a notebook with an ID of e-ABCDEFGHIJK1234567890ABCD (the EditorID of this request), and you specify a RelativePath of my_notebook_executions/notebook_execution.ipynb, the location of the file for the notebook execution is s3://MyBucket/MyNotebooks/e-ABCDEFGHIJK1234567890ABCD/my_notebook_executions/notebook_execution.ipynb.

  • NotebookExecutionName

An optional name for the notebook execution.

  • NotebookParams

Input parameters in JSON format passed to the Amazon EMR Notebook at runtime for execution.

  • ExecutionEngine

[required] Specifies the execution engine (cluster) that runs the notebook execution.

  • ServiceRole

[required] The name or ARN of the IAM role that is used as the service role for Amazon EMR (the Amazon EMR role) for the notebook execution.

  • NotebookInstanceSecurityGroupId

The unique identifier of the Amazon EC2 security group to associate with the Amazon EMR Notebook for this notebook execution.

  • Tags

A list of tags associated with a notebook execution. Tags are user-defined key-value pairs that consist of a required key string with a maximum of 128 characters and an optional value string with a maximum of 256 characters.

  • NotebookS3Location

The Amazon S3 location for the notebook execution input.

  • OutputNotebookS3Location

The Amazon S3 location for the notebook execution output.

  • OutputNotebookFormat

The output format for the notebook execution.

  • EnvironmentVariables

The environment variables associated with the notebook execution.

Value

A list with the following syntax:

list(
  NotebookExecutionId = "string"
)

Request syntax

svc$start_notebook_execution(
  EditorId = "string",
  RelativePath = "string",
  NotebookExecutionName = "string",
  NotebookParams = "string",
  ExecutionEngine = list(
    Id = "string",
    Type = "EMR",
    MasterInstanceSecurityGroupId = "string",
    ExecutionRoleArn = "string"
  ),
  ServiceRole = "string",
  NotebookInstanceSecurityGroupId = "string",
  Tags = list(
    list(
      Key = "string",
      Value = "string"
    )
  ),
  NotebookS3Location = list(
    Bucket = "string",
    Key = "string"
  ),
  OutputNotebookS3Location = list(
    Bucket = "string",
    Key = "string"
  ),
  OutputNotebookFormat = "HTML",
  EnvironmentVariables = list(
    "string"
  )
)