Skip to content

StartNotebookExecutionInput

Source code in docs_src/capo_emr/types/start_notebook_execution_input.py
class StartNotebookExecutionInput(TypedDict, closed=True):
    editor_id: NotRequired["capo_emr.types.xml_string_max_len256.XmlStringMaxLen256"]
    """<p>The unique identifier of the Amazon EMR Notebook to use for notebook execution.</p>"""
    relative_path: NotRequired["capo_emr.types.xml_string.XmlString"]
    """<p>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>.</p>"""
    notebook_execution_name: NotRequired[
        "capo_emr.types.xml_string_max_len256.XmlStringMaxLen256"
    ]
    """<p>An optional name for the notebook execution.</p>"""
    notebook_params: NotRequired["capo_emr.types.xml_string.XmlString"]
    """<p>Input parameters in JSON format passed to the Amazon EMR Notebook at runtime for execution.</p>"""
    execution_engine: NotRequired[
        "capo_emr.types.execution_engine_config.ExecutionEngineConfig"
    ]
    """<p>Specifies the execution engine (cluster) that runs the notebook execution.</p>"""
    service_role: NotRequired["capo_emr.types.xml_string.XmlString"]
    """<p>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.</p>"""
    notebook_instance_security_group_id: NotRequired[
        "capo_emr.types.xml_string_max_len256.XmlStringMaxLen256"
    ]
    """<p>The unique identifier of the Amazon EC2 security group to associate with the Amazon EMR Notebook for this notebook execution.</p>"""
    tags: NotRequired["capo_emr.types.tag_list.TagList"]
    """<p>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.</p>"""
    notebook_s3_location: NotRequired[
        "capo_emr.types.notebook_s3_location_from_input.NotebookS3LocationFromInput"
    ]
    """<p>The Amazon S3 location for the notebook execution input.</p>"""
    output_notebook_s3_location: NotRequired[
        "capo_emr.types.output_notebook_s3_location_from_input.OutputNotebookS3LocationFromInput"
    ]
    """<p>The Amazon S3 location for the notebook execution output.</p>"""
    output_notebook_format: NotRequired[
        "capo_emr.types.output_notebook_format.OutputNotebookFormat"
    ]
    """<p>The output format for the notebook execution.</p>"""
    environment_variables: NotRequired[
        "capo_emr.types.environment_variables_map.EnvironmentVariablesMap"
    ]
    """<p>The environment variables associated with the notebook execution.</p>"""

editor_id instance-attribute

editor_id: NotRequired[XmlStringMaxLen256]

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

environment_variables instance-attribute

environment_variables: NotRequired[EnvironmentVariablesMap]

The environment variables associated with the notebook execution.

execution_engine instance-attribute

execution_engine: NotRequired[ExecutionEngineConfig]

Specifies the execution engine (cluster) that runs the notebook execution.

notebook_execution_name instance-attribute

notebook_execution_name: NotRequired[XmlStringMaxLen256]

An optional name for the notebook execution.

notebook_instance_security_group_id instance-attribute

notebook_instance_security_group_id: NotRequired[XmlStringMaxLen256]

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

notebook_params instance-attribute

notebook_params: NotRequired[XmlString]

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

notebook_s3_location instance-attribute

notebook_s3_location: NotRequired[NotebookS3LocationFromInput]

The Amazon S3 location for the notebook execution input.

output_notebook_format instance-attribute

output_notebook_format: NotRequired[OutputNotebookFormat]

The output format for the notebook execution.

output_notebook_s3_location instance-attribute

output_notebook_s3_location: NotRequired[OutputNotebookS3LocationFromInput]

The Amazon S3 location for the notebook execution output.

relative_path instance-attribute

relative_path: NotRequired[XmlString]

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.

service_role instance-attribute

service_role: NotRequired[XmlString]

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.

tags instance-attribute

tags: NotRequired[TagList]

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.