Struct aws_sdk_emr::types::NotebookExecution

#[non_exhaustive]
pub struct NotebookExecution {

    pub notebook_execution_id: Option<String>,
    pub editor_id: Option<String>,
    pub execution_engine: Option<ExecutionEngineConfig>,
    pub notebook_execution_name: Option<String>,
    pub notebook_params: Option<String>,
    pub status: Option<NotebookExecutionStatus>,
    pub start_time: Option<DateTime>,
    pub end_time: Option<DateTime>,
    pub arn: Option<String>,
    pub output_notebook_uri: Option<String>,
    pub last_state_change_reason: Option<String>,
    pub notebook_instance_security_group_id: Option<String>,
    pub tags: Option<Vec<Tag>>,
    pub notebook_s3_location: Option<NotebookS3LocationForOutput>,
    pub output_notebook_s3_location: Option<OutputNotebookS3LocationForOutput>,
    pub output_notebook_format: Option<OutputNotebookFormat>,
    pub environment_variables: Option<HashMap<String, String>>,
}

A notebook execution. An execution is a specific instance that an Amazon EMR Notebook is run using the StartNotebookExecution action.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

notebook_execution_id: Option<String>

The unique identifier of a notebook execution.

editor_id: Option<String>

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

execution_engine: Option<ExecutionEngineConfig>

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

notebook_execution_name: Option<String>

A name for the notebook execution.

notebook_params: Option<String>

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

status: Option<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.

start_time: Option<DateTime>

The timestamp when notebook execution started.

end_time: Option<DateTime>

The timestamp when notebook execution ended.

arn: Option<String>

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

output_notebook_uri: Option<String>

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

last_state_change_reason: Option<String>

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

notebook_instance_security_group_id: Option<String>

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.

tags: Option<Vec<Tag>>

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.

notebook_s3_location: Option<NotebookS3LocationForOutput>

The Amazon S3 location that stores the notebook execution input.

output_notebook_s3_location: Option<OutputNotebookS3LocationForOutput>

The Amazon S3 location for the notebook execution output.

output_notebook_format: Option<OutputNotebookFormat>

The output format for the notebook execution.

environment_variables: Option<HashMap<String, String>>

The environment variables associated with the notebook execution.

Implementations

impl NotebookExecution

pub fn notebook_execution_id(&self) -> Option<&str>

The unique identifier of a notebook execution.

pub fn editor_id(&self) -> Option<&str>

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

pub fn execution_engine(&self) -> Option<&ExecutionEngineConfig>

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

pub fn notebook_execution_name(&self) -> Option<&str>

A name for the notebook execution.

pub fn notebook_params(&self) -> Option<&str>

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

pub fn status(&self) -> Option<&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.

pub fn start_time(&self) -> Option<&DateTime>

The timestamp when notebook execution started.

pub fn end_time(&self) -> Option<&DateTime>

The timestamp when notebook execution ended.

pub fn arn(&self) -> Option<&str>

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

pub fn output_notebook_uri(&self) -> Option<&str>

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

pub fn last_state_change_reason(&self) -> Option<&str>

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

pub fn notebook_instance_security_group_id(&self) -> Option<&str>

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.

pub fn tags(&self) -> &[Tag]

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.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .tags.is_none().

pub fn notebook_s3_location(&self) -> Option<&NotebookS3LocationForOutput>

The Amazon S3 location that stores the notebook execution input.

pub fn output_notebook_s3_location( &self ) -> Option<&OutputNotebookS3LocationForOutput>

The Amazon S3 location for the notebook execution output.

pub fn output_notebook_format(&self) -> Option<&OutputNotebookFormat>

The output format for the notebook execution.

pub fn environment_variables(&self) -> Option<&HashMap<String, String>>

The environment variables associated with the notebook execution.

impl NotebookExecution

pub fn builder() -> NotebookExecutionBuilder

Creates a new builder-style object to manufacture NotebookExecution.

Trait Implementations

impl Clone for NotebookExecution

fn clone(&self) -> NotebookExecution

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for NotebookExecution

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for NotebookExecution

fn eq(&self, other: &NotebookExecution) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for NotebookExecution