amazonka-emr-2.0: Amazon EMR SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.EMR.StartNotebookExecution

Description

Starts a notebook execution.

Synopsis

Creating a Request

data StartNotebookExecution Source #

See: newStartNotebookExecution smart constructor.

Constructors

StartNotebookExecution' 

Fields

  • notebookExecutionName :: Maybe Text

    An optional name for the notebook execution.

  • notebookInstanceSecurityGroupId :: Maybe Text

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

  • notebookParams :: Maybe Text

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

  • tags :: Maybe [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.

  • editorId :: Text

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

  • relativePath :: Text

    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.

  • executionEngine :: ExecutionEngineConfig

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

  • serviceRole :: Text

    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.

Instances

Instances details
ToJSON StartNotebookExecution Source # 
Instance details

Defined in Amazonka.EMR.StartNotebookExecution

ToHeaders StartNotebookExecution Source # 
Instance details

Defined in Amazonka.EMR.StartNotebookExecution

ToPath StartNotebookExecution Source # 
Instance details

Defined in Amazonka.EMR.StartNotebookExecution

ToQuery StartNotebookExecution Source # 
Instance details

Defined in Amazonka.EMR.StartNotebookExecution

AWSRequest StartNotebookExecution Source # 
Instance details

Defined in Amazonka.EMR.StartNotebookExecution

Associated Types

type AWSResponse StartNotebookExecution #

Generic StartNotebookExecution Source # 
Instance details

Defined in Amazonka.EMR.StartNotebookExecution

Associated Types

type Rep StartNotebookExecution :: Type -> Type #

Read StartNotebookExecution Source # 
Instance details

Defined in Amazonka.EMR.StartNotebookExecution

Show StartNotebookExecution Source # 
Instance details

Defined in Amazonka.EMR.StartNotebookExecution

NFData StartNotebookExecution Source # 
Instance details

Defined in Amazonka.EMR.StartNotebookExecution

Methods

rnf :: StartNotebookExecution -> () #

Eq StartNotebookExecution Source # 
Instance details

Defined in Amazonka.EMR.StartNotebookExecution

Hashable StartNotebookExecution Source # 
Instance details

Defined in Amazonka.EMR.StartNotebookExecution

type AWSResponse StartNotebookExecution Source # 
Instance details

Defined in Amazonka.EMR.StartNotebookExecution

type Rep StartNotebookExecution Source # 
Instance details

Defined in Amazonka.EMR.StartNotebookExecution

type Rep StartNotebookExecution = D1 ('MetaData "StartNotebookExecution" "Amazonka.EMR.StartNotebookExecution" "amazonka-emr-2.0-B3cWhP6sdymF3IBUMdPGcd" 'False) (C1 ('MetaCons "StartNotebookExecution'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "notebookExecutionName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "notebookInstanceSecurityGroupId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "notebookParams") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])))) :*: ((S1 ('MetaSel ('Just "editorId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "relativePath") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "executionEngine") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ExecutionEngineConfig) :*: S1 ('MetaSel ('Just "serviceRole") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newStartNotebookExecution Source #

Create a value of StartNotebookExecution with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

StartNotebookExecution, startNotebookExecution_notebookExecutionName - An optional name for the notebook execution.

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

StartNotebookExecution, startNotebookExecution_notebookParams - Input parameters in JSON format passed to the EMR Notebook at runtime for execution.

StartNotebookExecution, startNotebookExecution_tags - 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.

StartNotebookExecution, startNotebookExecution_editorId - The unique identifier of the EMR Notebook to use for notebook execution.

$sel:relativePath:StartNotebookExecution', startNotebookExecution_relativePath - 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.

StartNotebookExecution, startNotebookExecution_executionEngine - Specifies the execution engine (cluster) that runs the notebook execution.

StartNotebookExecution, startNotebookExecution_serviceRole - 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.

Request Lenses

startNotebookExecution_notebookInstanceSecurityGroupId :: Lens' StartNotebookExecution (Maybe Text) Source #

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

startNotebookExecution_notebookParams :: Lens' StartNotebookExecution (Maybe Text) Source #

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

startNotebookExecution_tags :: Lens' StartNotebookExecution (Maybe [Tag]) Source #

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.

startNotebookExecution_editorId :: Lens' StartNotebookExecution Text Source #

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

startNotebookExecution_relativePath :: Lens' StartNotebookExecution Text Source #

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.

startNotebookExecution_executionEngine :: Lens' StartNotebookExecution ExecutionEngineConfig Source #

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

startNotebookExecution_serviceRole :: Lens' StartNotebookExecution Text Source #

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.

Destructuring the Response

data StartNotebookExecutionResponse Source #

See: newStartNotebookExecutionResponse smart constructor.

Constructors

StartNotebookExecutionResponse' 

Fields

Instances

Instances details
Generic StartNotebookExecutionResponse Source # 
Instance details

Defined in Amazonka.EMR.StartNotebookExecution

Associated Types

type Rep StartNotebookExecutionResponse :: Type -> Type #

Read StartNotebookExecutionResponse Source # 
Instance details

Defined in Amazonka.EMR.StartNotebookExecution

Show StartNotebookExecutionResponse Source # 
Instance details

Defined in Amazonka.EMR.StartNotebookExecution

NFData StartNotebookExecutionResponse Source # 
Instance details

Defined in Amazonka.EMR.StartNotebookExecution

Eq StartNotebookExecutionResponse Source # 
Instance details

Defined in Amazonka.EMR.StartNotebookExecution

type Rep StartNotebookExecutionResponse Source # 
Instance details

Defined in Amazonka.EMR.StartNotebookExecution

type Rep StartNotebookExecutionResponse = D1 ('MetaData "StartNotebookExecutionResponse" "Amazonka.EMR.StartNotebookExecution" "amazonka-emr-2.0-B3cWhP6sdymF3IBUMdPGcd" 'False) (C1 ('MetaCons "StartNotebookExecutionResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "notebookExecutionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newStartNotebookExecutionResponse Source #

Create a value of StartNotebookExecutionResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

StartNotebookExecutionResponse, startNotebookExecutionResponse_notebookExecutionId - The unique identifier of the notebook execution.

$sel:httpStatus:StartNotebookExecutionResponse', startNotebookExecutionResponse_httpStatus - The response's http status code.

Response Lenses