Class: Aws::EMR::Types::StartNotebookExecutionInput

Inherits:

Struct

• Object
• Struct
• Aws::EMR::Types::StartNotebookExecutionInput

Includes:

Structure

Defined in:

lib/aws-sdk-emr/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #editor_id ⇒ String

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

• #environment_variables ⇒ Hash<String,String>

  The environment variables associated with the notebook execution.

• #execution_engine ⇒ Types::ExecutionEngineConfig

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

• #notebook_execution_name ⇒ String

  An optional name for the notebook execution.

• #notebook_instance_security_group_id ⇒ String

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

• #notebook_params ⇒ String

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

• #notebook_s3_location ⇒ Types::NotebookS3LocationFromInput

  The Amazon S3 location for the notebook execution input.

• #output_notebook_format ⇒ String

  The output format for the notebook execution.

• #output_notebook_s3_location ⇒ Types::OutputNotebookS3LocationFromInput

  The Amazon S3 location for the notebook execution output.

• #relative_path ⇒ String

  The path and file name of the notebook file for this execution, relative to the path specified for the Amazon EMR Notebook.

• #service_role ⇒ String

  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 ⇒ Array<Types::Tag>

  A list of tags associated with a notebook execution.

Instance Attribute Details

#editor_id ⇒ String

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

Returns:

• (String)

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

class StartNotebookExecutionInput < Struct.new(
  :editor_id,
  :relative_path,
  :notebook_execution_name,
  :notebook_params,
  :execution_engine,
  :service_role,
  :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 6289

class StartNotebookExecutionInput < Struct.new(
  :editor_id,
  :relative_path,
  :notebook_execution_name,
  :notebook_params,
  :execution_engine,
  :service_role,
  :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

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

Returns:

• (Types::ExecutionEngineConfig)

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

class StartNotebookExecutionInput < Struct.new(
  :editor_id,
  :relative_path,
  :notebook_execution_name,
  :notebook_params,
  :execution_engine,
  :service_role,
  :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

An optional name for the notebook execution.

Returns:

• (String)

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

class StartNotebookExecutionInput < Struct.new(
  :editor_id,
  :relative_path,
  :notebook_execution_name,
  :notebook_params,
  :execution_engine,
  :service_role,
  :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 to associate with the Amazon EMR Notebook for this notebook execution.

Returns:

• (String)

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

class StartNotebookExecutionInput < Struct.new(
  :editor_id,
  :relative_path,
  :notebook_execution_name,
  :notebook_params,
  :execution_engine,
  :service_role,
  :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 6289

class StartNotebookExecutionInput < Struct.new(
  :editor_id,
  :relative_path,
  :notebook_execution_name,
  :notebook_params,
  :execution_engine,
  :service_role,
  :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::NotebookS3LocationFromInput

The Amazon S3 location for the notebook execution input.

Returns:

• (Types::NotebookS3LocationFromInput)

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

class StartNotebookExecutionInput < Struct.new(
  :editor_id,
  :relative_path,
  :notebook_execution_name,
  :notebook_params,
  :execution_engine,
  :service_role,
  :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 6289

class StartNotebookExecutionInput < Struct.new(
  :editor_id,
  :relative_path,
  :notebook_execution_name,
  :notebook_params,
  :execution_engine,
  :service_role,
  :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::OutputNotebookS3LocationFromInput

The Amazon S3 location for the notebook execution output.

Returns:

• (Types::OutputNotebookS3LocationFromInput)

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

class StartNotebookExecutionInput < Struct.new(
  :editor_id,
  :relative_path,
  :notebook_execution_name,
  :notebook_params,
  :execution_engine,
  :service_role,
  :notebook_instance_security_group_id,
  :tags,
  :notebook_s3_location,
  :output_notebook_s3_location,
  :output_notebook_format,
  :environment_variables)
  SENSITIVE = []
  include Aws::Structure
end

#relative_path ⇒ String

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

Returns:

• (String)

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

class StartNotebookExecutionInput < Struct.new(
  :editor_id,
  :relative_path,
  :notebook_execution_name,
  :notebook_params,
  :execution_engine,
  :service_role,
  :notebook_instance_security_group_id,
  :tags,
  :notebook_s3_location,
  :output_notebook_s3_location,
  :output_notebook_format,
  :environment_variables)
  SENSITIVE = []
  include Aws::Structure
end

#service_role ⇒ String

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.

Returns:

• (String)

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

class StartNotebookExecutionInput < Struct.new(
  :editor_id,
  :relative_path,
  :notebook_execution_name,
  :notebook_params,
  :execution_engine,
  :service_role,
  :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 6289

class StartNotebookExecutionInput < Struct.new(
  :editor_id,
  :relative_path,
  :notebook_execution_name,
  :notebook_params,
  :execution_engine,
  :service_role,
  :notebook_instance_security_group_id,
  :tags,
  :notebook_s3_location,
  :output_notebook_s3_location,
  :output_notebook_format,
  :environment_variables)
  SENSITIVE = []
  include Aws::Structure
end