You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing StartNotebookExecutionInput as input to an Aws::Client method, you can use a vanilla 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",
    },
  ],
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#editor_id ⇒ String

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

Returns:

  • (String) —

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

#execution_engine ⇒ Types::ExecutionEngineConfig

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

Returns:

#notebook_execution_name ⇒ String

An optional name for the notebook execution.

Returns:

  • (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 EMR Notebook for this notebook execution.

Returns:

  • (String) —

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

#notebook_params ⇒ String

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

Returns:

  • (String) —

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

#relative_path ⇒ String

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) —

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

#service_role ⇒ String

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) —

    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.

#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>) —

    A list of tags associated with a notebook execution.