v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1465378349.0 KB

Starts a notebook execution.

post/#X-Amz-Target=ElasticMapReduce.StartNotebookExecution

Headers

X-Amz-Target'ElasticMapReduce.StartNotebookExecution' required

Request body

EditorIdstring

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

RelativePathstring

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 <code>s3://MyBucket/MyNotebooks</code> when you create an Amazon EMR Notebook for a notebook with an ID of <code>e-ABCDEFGHIJK1234567890ABCD</code> (the <code>EditorID</code> of this request), and you specify a <code>RelativePath</code> of <code>my_notebook_executions/notebook_execution.ipynb</code>, the location of the file for the notebook execution is <code>s3://MyBucket/MyNotebooks/e-ABCDEFGHIJK1234567890ABCD/my_notebook_executions/notebook_execution.ipynb</code>.

NotebookExecutionNamestring

An optional name for the notebook execution.

NotebookParamsstring

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

ServiceRolestring 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.

NotebookInstanceSecurityGroupIdstring

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

OutputNotebookFormat'HTML'

The output format for the notebook execution.

EnvironmentVariablesobject

The environment variables associated with the notebook execution.

Response

Success

NotebookExecutionIdstring

The unique identifier of the notebook execution.