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

Inherits:

Struct

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

show all

Includes:: Structure

Defined in:: lib/aws-sdk-emr/types.rb

Overview

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

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#arn ⇒ String

The Amazon Resource Name (ARN) of the notebook execution.
#editor_id ⇒ String

The unique identifier of the Amazon EMR Notebook that is used for the notebook execution.
#end_time ⇒ Time

The timestamp when notebook execution ended.
#environment_variables ⇒ Hash<String,String>

The environment variables associated with the notebook execution.
#execution_engine ⇒ Types::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 ⇒ 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 Amazon EC2 security group associated with the Amazon EMR Notebook instance.
#notebook_params ⇒ String

Input parameters in JSON format passed to the Amazon EMR Notebook at runtime for execution.
#notebook_s3_location ⇒ Types::NotebookS3LocationForOutput

The Amazon S3 location that stores the notebook execution input.
#output_notebook_format ⇒ String

The output format for the notebook execution.
#output_notebook_s3_location ⇒ Types::OutputNotebookS3LocationForOutput

The Amazon S3 location for the notebook execution output.
#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 'lib/aws-sdk-emr/types.rb', line 5160

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,
  :notebook_s3_location,
  :output_notebook_s3_location,
  :output_notebook_format,
  :environment_variables)
  SENSITIVE = []
  include Aws::Structure
end

#editor_id ⇒ `String`

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

Returns:

(String)

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

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,
  :notebook_s3_location,
  :output_notebook_s3_location,
  :output_notebook_format,
  :environment_variables)
  SENSITIVE = []
  include Aws::Structure
end

#end_time ⇒ `Time`

The timestamp when notebook execution ended.

Returns:

(Time)

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

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,
  :notebook_s3_location,
  :output_notebook_s3_location,
  :output_notebook_format,
  :environment_variables)
  SENSITIVE = []
  include Aws::Structure
end

#environment_variables ⇒ `Hash<String,String>`

The environment variables associated with the notebook execution.

Returns:

(Hash<String,String>)

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

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,
  :notebook_s3_location,
  :output_notebook_s3_location,
  :output_notebook_format,
  :environment_variables)
  SENSITIVE = []
  include Aws::Structure
end

#execution_engine ⇒ `Types::ExecutionEngineConfig`

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

Returns:

(Types::ExecutionEngineConfig)

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

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,
  :notebook_s3_location,
  :output_notebook_s3_location,
  :output_notebook_format,
  :environment_variables)
  SENSITIVE = []
  include Aws::Structure
end

#last_state_change_reason ⇒ `String`

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

Returns:

(String)

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

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,
  :notebook_s3_location,
  :output_notebook_s3_location,
  :output_notebook_format,
  :environment_variables)
  SENSITIVE = []
  include Aws::Structure
end

#notebook_execution_id ⇒ `String`

The unique identifier of a notebook execution.

Returns:

(String)

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

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,
  :notebook_s3_location,
  :output_notebook_s3_location,
  :output_notebook_format,
  :environment_variables)
  SENSITIVE = []
  include Aws::Structure
end

#notebook_execution_name ⇒ `String`

A name for the notebook execution.

Returns:

(String)

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

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,
  :notebook_s3_location,
  :output_notebook_s3_location,
  :output_notebook_format,
  :environment_variables)
  SENSITIVE = []
  include Aws::Structure
end

#notebook_instance_security_group_id ⇒ `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][1

in the *Amazon EMR Management Guide*.

[1]: docs.aws.amazon.com/emr/latest/ManagementGuide/emr-managed-notebooks-security-groups.html

Returns:

(String)

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

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,
  :notebook_s3_location,
  :output_notebook_s3_location,
  :output_notebook_format,
  :environment_variables)
  SENSITIVE = []
  include Aws::Structure
end

#notebook_params ⇒ `String`

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

Returns:

(String)

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

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,
  :notebook_s3_location,
  :output_notebook_s3_location,
  :output_notebook_format,
  :environment_variables)
  SENSITIVE = []
  include Aws::Structure
end

#notebook_s3_location ⇒ `Types::NotebookS3LocationForOutput`

The Amazon S3 location that stores the notebook execution input.

Returns:

(Types::NotebookS3LocationForOutput)

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

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,
  :notebook_s3_location,
  :output_notebook_s3_location,
  :output_notebook_format,
  :environment_variables)
  SENSITIVE = []
  include Aws::Structure
end

#output_notebook_format ⇒ `String`

The output format for the notebook execution.

Returns:

(String)

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

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,
  :notebook_s3_location,
  :output_notebook_s3_location,
  :output_notebook_format,
  :environment_variables)
  SENSITIVE = []
  include Aws::Structure
end

#output_notebook_s3_location ⇒ `Types::OutputNotebookS3LocationForOutput`

The Amazon S3 location for the notebook execution output.

Returns:

(Types::OutputNotebookS3LocationForOutput)

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

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,
  :notebook_s3_location,
  :output_notebook_s3_location,
  :output_notebook_format,
  :environment_variables)
  SENSITIVE = []
  include Aws::Structure
end

#output_notebook_uri ⇒ `String`

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

Returns:

(String)

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

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,
  :notebook_s3_location,
  :output_notebook_s3_location,
  :output_notebook_format,
  :environment_variables)
  SENSITIVE = []
  include Aws::Structure
end

#start_time ⇒ `Time`

The timestamp when notebook execution started.

Returns:

(Time)

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

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,
  :notebook_s3_location,
  :output_notebook_s3_location,
  :output_notebook_format,
  :environment_variables)
  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 'lib/aws-sdk-emr/types.rb', line 5160

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,
  :notebook_s3_location,
  :output_notebook_s3_location,
  :output_notebook_format,
  :environment_variables)
  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 'lib/aws-sdk-emr/types.rb', line 5160

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,
  :notebook_s3_location,
  :output_notebook_s3_location,
  :output_notebook_format,
  :environment_variables)
  SENSITIVE = []
  include Aws::Structure
end

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

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#arn ⇒ String

#editor_id ⇒ String

#end_time ⇒ Time

#environment_variables ⇒ Hash<String,String>

#execution_engine ⇒ Types::ExecutionEngineConfig

#last_state_change_reason ⇒ String

#notebook_execution_id ⇒ String

#notebook_execution_name ⇒ String

#notebook_instance_security_group_id ⇒ String

#notebook_params ⇒ String

#notebook_s3_location ⇒ Types::NotebookS3LocationForOutput

#output_notebook_format ⇒ String

#output_notebook_s3_location ⇒ Types::OutputNotebookS3LocationForOutput

#output_notebook_uri ⇒ String

#start_time ⇒ Time

#status ⇒ String

#tags ⇒ Array<Types::Tag>

#arn ⇒ `String`

#editor_id ⇒ `String`

#end_time ⇒ `Time`

#environment_variables ⇒ `Hash<String,String>`

#execution_engine ⇒ `Types::ExecutionEngineConfig`

#last_state_change_reason ⇒ `String`

#notebook_execution_id ⇒ `String`

#notebook_execution_name ⇒ `String`

#notebook_instance_security_group_id ⇒ `String`

#notebook_params ⇒ `String`

#notebook_s3_location ⇒ `Types::NotebookS3LocationForOutput`

#output_notebook_format ⇒ `String`

#output_notebook_s3_location ⇒ `Types::OutputNotebookS3LocationForOutput`

#output_notebook_uri ⇒ `String`

#start_time ⇒ `Time`

#status ⇒ `String`

#tags ⇒ `Array<Types::Tag>`