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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-emr/lib/aws-sdk-emr/types.rb

Overview

Note:

When making an API call, you may pass StartNotebookExecutionInput data as a hash:

{
  editor_id: "XmlStringMaxLen256", # required
  relative_path: "XmlString", # required
  notebook_execution_name: "XmlStringMaxLen256",
  notebook_params: "XmlString",
  execution_engine: { # required
    id: "XmlStringMaxLen256", # required
    type: "EMR", # accepts EMR
    master_instance_security_group_id: "XmlStringMaxLen256",
  },
  service_role: "XmlString", # required
  notebook_instance_security_group_id: "XmlStringMaxLen256",
  tags: [
    {
      key: "String",
      value: "String",
    },
  ],
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#editor_idString

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

Returns:

  • (String)


7399
7400
7401
7402
7403
7404
7405
7406
7407
7408
7409
7410
# File 'gems/aws-sdk-emr/lib/aws-sdk-emr/types.rb', line 7399

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

#execution_engineTypes::ExecutionEngineConfig

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



7399
7400
7401
7402
7403
7404
7405
7406
7407
7408
7409
7410
# File 'gems/aws-sdk-emr/lib/aws-sdk-emr/types.rb', line 7399

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

#notebook_execution_nameString

An optional name for the notebook execution.

Returns:

  • (String)


7399
7400
7401
7402
7403
7404
7405
7406
7407
7408
7409
7410
# File 'gems/aws-sdk-emr/lib/aws-sdk-emr/types.rb', line 7399

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

#notebook_instance_security_group_idString

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

Returns:

  • (String)


7399
7400
7401
7402
7403
7404
7405
7406
7407
7408
7409
7410
# File 'gems/aws-sdk-emr/lib/aws-sdk-emr/types.rb', line 7399

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

#notebook_paramsString

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

Returns:

  • (String)


7399
7400
7401
7402
7403
7404
7405
7406
7407
7408
7409
7410
# File 'gems/aws-sdk-emr/lib/aws-sdk-emr/types.rb', line 7399

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

#relative_pathString

The path and file name of the notebook file for this execution, relative to the path specified for the EMR Notebook. For example, if you specify a path of s3://MyBucket/MyNotebooks when you create an 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)


7399
7400
7401
7402
7403
7404
7405
7406
7407
7408
7409
7410
# File 'gems/aws-sdk-emr/lib/aws-sdk-emr/types.rb', line 7399

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

#service_roleString

The name or ARN of the IAM role that is used as the service role for Amazon EMR (the EMR role) for the notebook execution.

Returns:

  • (String)


7399
7400
7401
7402
7403
7404
7405
7406
7407
7408
7409
7410
# File 'gems/aws-sdk-emr/lib/aws-sdk-emr/types.rb', line 7399

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

#tagsArray<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:



7399
7400
7401
7402
7403
7404
7405
7406
7407
7408
7409
7410
# File 'gems/aws-sdk-emr/lib/aws-sdk-emr/types.rb', line 7399

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