Class: Aws::EMR::Types::NotebookExecution

Inherits:

Struct

• Object
• Struct
• Aws::EMR::Types::NotebookExecution

Defined in:

gems/aws-sdk-emr/lib/aws-sdk-emr/types.rb

Overview

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

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #arn ⇒ String

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

• #editor_id ⇒ String

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

• #end_time ⇒ Time

  The timestamp when notebook execution ended.

• #execution_engine ⇒ Types::ExecutionEngineConfig

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

• #last_state_change_reason ⇒ String

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

• #notebook_execution_id ⇒ String

  The unique identifier of a notebook execution.

• #notebook_execution_name ⇒ String

  A name for the notebook execution.

• #notebook_instance_security_group_id ⇒ String

  The unique identifier of the EC2 security group associated with the EMR Notebook instance.

• #notebook_params ⇒ String

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

• #output_notebook_uri ⇒ String

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

• #start_time ⇒ Time

  The timestamp when notebook execution started.

• #status ⇒ String

  The status of the notebook execution.

• #tags ⇒ Array<Types::Tag>

  A list of tags associated with a notebook execution.

Instance Attribute Details

#arn ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-emr/lib/aws-sdk-emr/types.rb', line 4376

class NotebookExecution < Struct.new(
  :notebook_execution_id,
  :editor_id,
  :execution_engine,
  :notebook_execution_name,
  :notebook_params,
  :status,
  :start_time,
  :end_time,
  :arn,
  :output_notebook_uri,
  :last_state_change_reason,
  :notebook_instance_security_group_id,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#editor_id ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-emr/lib/aws-sdk-emr/types.rb', line 4376

class NotebookExecution < Struct.new(
  :notebook_execution_id,
  :editor_id,
  :execution_engine,
  :notebook_execution_name,
  :notebook_params,
  :status,
  :start_time,
  :end_time,
  :arn,
  :output_notebook_uri,
  :last_state_change_reason,
  :notebook_instance_security_group_id,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#end_time ⇒ Time

The timestamp when notebook execution ended.

Returns:

• (Time)

# File 'gems/aws-sdk-emr/lib/aws-sdk-emr/types.rb', line 4376

class NotebookExecution < Struct.new(
  :notebook_execution_id,
  :editor_id,
  :execution_engine,
  :notebook_execution_name,
  :notebook_params,
  :status,
  :start_time,
  :end_time,
  :arn,
  :output_notebook_uri,
  :last_state_change_reason,
  :notebook_instance_security_group_id,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#execution_engine ⇒ Types::ExecutionEngineConfig

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

Returns:

• (Types::ExecutionEngineConfig)

# File 'gems/aws-sdk-emr/lib/aws-sdk-emr/types.rb', line 4376

class NotebookExecution < Struct.new(
  :notebook_execution_id,
  :editor_id,
  :execution_engine,
  :notebook_execution_name,
  :notebook_params,
  :status,
  :start_time,
  :end_time,
  :arn,
  :output_notebook_uri,
  :last_state_change_reason,
  :notebook_instance_security_group_id,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#last_state_change_reason ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-emr/lib/aws-sdk-emr/types.rb', line 4376

class NotebookExecution < Struct.new(
  :notebook_execution_id,
  :editor_id,
  :execution_engine,
  :notebook_execution_name,
  :notebook_params,
  :status,
  :start_time,
  :end_time,
  :arn,
  :output_notebook_uri,
  :last_state_change_reason,
  :notebook_instance_security_group_id,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#notebook_execution_id ⇒ String

The unique identifier of a notebook execution.

Returns:

• (String)

# File 'gems/aws-sdk-emr/lib/aws-sdk-emr/types.rb', line 4376

class NotebookExecution < Struct.new(
  :notebook_execution_id,
  :editor_id,
  :execution_engine,
  :notebook_execution_name,
  :notebook_params,
  :status,
  :start_time,
  :end_time,
  :arn,
  :output_notebook_uri,
  :last_state_change_reason,
  :notebook_instance_security_group_id,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#notebook_execution_name ⇒ String

A name for the notebook execution.

Returns:

• (String)

# File 'gems/aws-sdk-emr/lib/aws-sdk-emr/types.rb', line 4376

class NotebookExecution < Struct.new(
  :notebook_execution_id,
  :editor_id,
  :execution_engine,
  :notebook_execution_name,
  :notebook_params,
  :status,
  :start_time,
  :end_time,
  :arn,
  :output_notebook_uri,
  :last_state_change_reason,
  :notebook_instance_security_group_id,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#notebook_instance_security_group_id ⇒ String

The unique identifier of the EC2 security group associated with the EMR Notebook instance. For more information see Specifying EC2 Security Groups for EMR Notebooks in the EMR Management Guide.

Returns:

• (String)

# File 'gems/aws-sdk-emr/lib/aws-sdk-emr/types.rb', line 4376

class NotebookExecution < Struct.new(
  :notebook_execution_id,
  :editor_id,
  :execution_engine,
  :notebook_execution_name,
  :notebook_params,
  :status,
  :start_time,
  :end_time,
  :arn,
  :output_notebook_uri,
  :last_state_change_reason,
  :notebook_instance_security_group_id,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#notebook_params ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-emr/lib/aws-sdk-emr/types.rb', line 4376

class NotebookExecution < Struct.new(
  :notebook_execution_id,
  :editor_id,
  :execution_engine,
  :notebook_execution_name,
  :notebook_params,
  :status,
  :start_time,
  :end_time,
  :arn,
  :output_notebook_uri,
  :last_state_change_reason,
  :notebook_instance_security_group_id,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#output_notebook_uri ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-emr/lib/aws-sdk-emr/types.rb', line 4376

class NotebookExecution < Struct.new(
  :notebook_execution_id,
  :editor_id,
  :execution_engine,
  :notebook_execution_name,
  :notebook_params,
  :status,
  :start_time,
  :end_time,
  :arn,
  :output_notebook_uri,
  :last_state_change_reason,
  :notebook_instance_security_group_id,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#start_time ⇒ Time

The timestamp when notebook execution started.

Returns:

• (Time)

# File 'gems/aws-sdk-emr/lib/aws-sdk-emr/types.rb', line 4376

class NotebookExecution < Struct.new(
  :notebook_execution_id,
  :editor_id,
  :execution_engine,
  :notebook_execution_name,
  :notebook_params,
  :status,
  :start_time,
  :end_time,
  :arn,
  :output_notebook_uri,
  :last_state_change_reason,
  :notebook_instance_security_group_id,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

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.

Returns:

• (String)

# File 'gems/aws-sdk-emr/lib/aws-sdk-emr/types.rb', line 4376

class NotebookExecution < Struct.new(
  :notebook_execution_id,
  :editor_id,
  :execution_engine,
  :notebook_execution_name,
  :notebook_params,
  :status,
  :start_time,
  :end_time,
  :arn,
  :output_notebook_uri,
  :last_state_change_reason,
  :notebook_instance_security_group_id,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Array<Types::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.

Returns:

• (Array<Types::Tag>)

# File 'gems/aws-sdk-emr/lib/aws-sdk-emr/types.rb', line 4376

class NotebookExecution < Struct.new(
  :notebook_execution_id,
  :editor_id,
  :execution_engine,
  :notebook_execution_name,
  :notebook_params,
  :status,
  :start_time,
  :end_time,
  :arn,
  :output_notebook_uri,
  :last_state_change_reason,
  :notebook_instance_security_group_id,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end