Skip to content

NotebookExecution

Source code in docs_src/capo_emr/types/notebook_execution.py
class NotebookExecution(TypedDict, closed=True):
    notebook_execution_id: NotRequired[
        "capo_emr.types.xml_string_max_len256.XmlStringMaxLen256"
    ]
    """<p>The unique identifier of a notebook execution.</p>"""
    editor_id: NotRequired["capo_emr.types.xml_string_max_len256.XmlStringMaxLen256"]
    """<p>The unique identifier of the Amazon EMR Notebook that is used for the notebook execution.</p>"""
    execution_engine: NotRequired[
        "capo_emr.types.execution_engine_config.ExecutionEngineConfig"
    ]
    """<p>The execution engine, such as an Amazon EMR cluster, used to run the Amazon EMR notebook and perform the notebook execution.</p>"""
    notebook_execution_name: NotRequired[
        "capo_emr.types.xml_string_max_len256.XmlStringMaxLen256"
    ]
    """<p>A 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>"""
    status: NotRequired[
        "capo_emr.types.notebook_execution_status.NotebookExecutionStatus"
    ]
    """<p>The status of the notebook execution.</p> <ul> <li> <p> <code>START_PENDING</code> indicates that the cluster has received the execution request but execution has not begun.</p> </li> <li> <p> <code>STARTING</code> indicates that the execution is starting on the cluster.</p> </li> <li> <p> <code>RUNNING</code> indicates that the execution is being processed by the cluster.</p> </li> <li> <p> <code>FINISHING</code> indicates that execution processing is in the final stages.</p> </li> <li> <p> <code>FINISHED</code> indicates that the execution has completed without error.</p> </li> <li> <p> <code>FAILING</code> indicates that the execution is failing and will not finish successfully.</p> </li> <li> <p> <code>FAILED</code> indicates that the execution failed.</p> </li> <li> <p> <code>STOP_PENDING</code> indicates that the cluster has received a <code>StopNotebookExecution</code> request and the stop is pending.</p> </li> <li> <p> <code>STOPPING</code> indicates that the cluster is in the process of stopping the execution as a result of a <code>StopNotebookExecution</code> request.</p> </li> <li> <p> <code>STOPPED</code> indicates that the execution stopped because of a <code>StopNotebookExecution</code> request.</p> </li> </ul>"""
    start_time: NotRequired["capo_emr.types.date.Date"]
    """<p>The timestamp when notebook execution started.</p>"""
    end_time: NotRequired["capo_emr.types.date.Date"]
    """<p>The timestamp when notebook execution ended.</p>"""
    arn: NotRequired["capo_emr.types.xml_string_max_len256.XmlStringMaxLen256"]
    """<p>The Amazon Resource Name (ARN) of the notebook execution.</p>"""
    output_notebook_uri: NotRequired["capo_emr.types.xml_string.XmlString"]
    """<p>The location of the notebook execution's output file in Amazon S3.</p>"""
    last_state_change_reason: NotRequired["capo_emr.types.xml_string.XmlString"]
    """<p>The reason for the latest status change of 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 associated with the Amazon EMR Notebook instance. For more information see <a href="https://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-managed-notebooks-security-groups.html">Specifying Amazon EC2 Security Groups for Amazon EMR Notebooks</a> in the <i>Amazon EMR Management Guide</i>.</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_for_output.NotebookS3LocationForOutput"
    ]
    """<p>The Amazon S3 location that stores the notebook execution input.</p>"""
    output_notebook_s3_location: NotRequired[
        "capo_emr.types.output_notebook_s3_location_for_output.OutputNotebookS3LocationForOutput"
    ]
    """<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>"""

arn instance-attribute

arn: NotRequired[XmlStringMaxLen256]

The Amazon Resource Name (ARN) of the notebook execution.

editor_id instance-attribute

editor_id: NotRequired[XmlStringMaxLen256]

The unique identifier of the Amazon EMR Notebook that is used for the notebook execution.

end_time instance-attribute

end_time: NotRequired[Date]

The timestamp when notebook execution ended.

environment_variables instance-attribute

environment_variables: NotRequired[EnvironmentVariablesMap]

The environment variables associated with the notebook execution.

execution_engine instance-attribute

execution_engine: NotRequired[ExecutionEngineConfig]

The execution engine, such as an Amazon EMR cluster, used to run the Amazon EMR notebook and perform the notebook execution.

last_state_change_reason instance-attribute

last_state_change_reason: NotRequired[XmlString]

The reason for the latest status change of the notebook execution.

notebook_execution_id instance-attribute

notebook_execution_id: NotRequired[XmlStringMaxLen256]

The unique identifier of a notebook execution.

notebook_execution_name instance-attribute

notebook_execution_name: NotRequired[XmlStringMaxLen256]

A 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 associated with the Amazon EMR Notebook instance. For more information see Specifying Amazon EC2 Security Groups for Amazon EMR Notebooks in the Amazon EMR Management Guide.

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[NotebookS3LocationForOutput]

The Amazon S3 location that stores 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[OutputNotebookS3LocationForOutput]

The Amazon S3 location for the notebook execution output.

output_notebook_uri instance-attribute

output_notebook_uri: NotRequired[XmlString]

The location of the notebook execution's output file in Amazon S3.

start_time instance-attribute

start_time: NotRequired[Date]

The timestamp when notebook execution started.

status instance-attribute

status: NotRequired[NotebookExecutionStatus]

The status of the notebook execution.

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

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.