Amazonka.EMR.StartNotebookExecution

Starts a notebook execution.

Creating a Request

data StartNotebookExecution

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

ToJSON StartNotebookExecution

Defined in Amazonka.EMR.StartNotebookExecution

Methods

toJSON :: StartNotebookExecution -> Value

toEncoding :: StartNotebookExecution -> Encoding

toJSONList :: [StartNotebookExecution] -> Value

toEncodingList :: [StartNotebookExecution] -> Encoding

ToHeaders StartNotebookExecution

Defined in Amazonka.EMR.StartNotebookExecution

Methods

toHeaders :: StartNotebookExecution -> [Header]

ToPath StartNotebookExecution

Defined in Amazonka.EMR.StartNotebookExecution

Methods

toPath :: StartNotebookExecution -> ByteString

ToQuery StartNotebookExecution

Defined in Amazonka.EMR.StartNotebookExecution

Methods

toQuery :: StartNotebookExecution -> QueryString

AWSRequest StartNotebookExecution

Defined in Amazonka.EMR.StartNotebookExecution

Associated Types

type AWSResponse StartNotebookExecution

Methods

request :: (Service -> Service) -> StartNotebookExecution -> Request StartNotebookExecution

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy StartNotebookExecution -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse StartNotebookExecution)))

Generic StartNotebookExecution

Defined in Amazonka.EMR.StartNotebookExecution

Associated Types

type Rep StartNotebookExecution :: Type -> Type

Methods

from :: StartNotebookExecution -> Rep StartNotebookExecution x

to :: Rep StartNotebookExecution x -> StartNotebookExecution

Read StartNotebookExecution

Defined in Amazonka.EMR.StartNotebookExecution

Methods

readsPrec :: Int -> ReadS StartNotebookExecution

readList :: ReadS [StartNotebookExecution]

readPrec :: ReadPrec StartNotebookExecution

readListPrec :: ReadPrec [StartNotebookExecution]

Show StartNotebookExecution

Defined in Amazonka.EMR.StartNotebookExecution

Methods

showsPrec :: Int -> StartNotebookExecution -> ShowS

show :: StartNotebookExecution -> String

showList :: [StartNotebookExecution] -> ShowS

NFData StartNotebookExecution

Defined in Amazonka.EMR.StartNotebookExecution

Methods

rnf :: StartNotebookExecution -> ()

Eq StartNotebookExecution

Defined in Amazonka.EMR.StartNotebookExecution

Methods

(==) :: StartNotebookExecution -> StartNotebookExecution -> Bool

(/=) :: StartNotebookExecution -> StartNotebookExecution -> Bool

Hashable StartNotebookExecution

Defined in Amazonka.EMR.StartNotebookExecution

Methods

hashWithSalt :: Int -> StartNotebookExecution -> Int

hash :: StartNotebookExecution -> Int

type AWSResponse StartNotebookExecution

Defined in Amazonka.EMR.StartNotebookExecution

type AWSResponse StartNotebookExecution = StartNotebookExecutionResponse

type Rep StartNotebookExecution

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

Arguments

:: Text

StartNotebookExecution

-> Text

$sel:relativePath:StartNotebookExecution'

-> ExecutionEngineConfig

StartNotebookExecution

-> Text

StartNotebookExecution

-> StartNotebookExecution

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_notebookExecutionName :: Lens' StartNotebookExecution (Maybe Text)

An optional name for the notebook execution.

startNotebookExecution_notebookInstanceSecurityGroupId :: Lens' StartNotebookExecution (Maybe Text)

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)

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

startNotebookExecution_tags :: Lens' StartNotebookExecution (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.

startNotebookExecution_editorId :: Lens' StartNotebookExecution Text

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

startNotebookExecution_relativePath :: Lens' StartNotebookExecution 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.

startNotebookExecution_executionEngine :: Lens' StartNotebookExecution ExecutionEngineConfig

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

startNotebookExecution_serviceRole :: Lens' StartNotebookExecution 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.

Destructuring the Response

data StartNotebookExecutionResponse

See: newStartNotebookExecutionResponse smart constructor.

Constructors

StartNotebookExecutionResponse'

Fields

• notebookExecutionId :: Maybe Text

  The unique identifier of the notebook execution.

• httpStatus :: Int

  The response's http status code.

Instances

Generic StartNotebookExecutionResponse

Defined in Amazonka.EMR.StartNotebookExecution

Associated Types

type Rep StartNotebookExecutionResponse :: Type -> Type

Methods

from :: StartNotebookExecutionResponse -> Rep StartNotebookExecutionResponse x

to :: Rep StartNotebookExecutionResponse x -> StartNotebookExecutionResponse

Read StartNotebookExecutionResponse

Defined in Amazonka.EMR.StartNotebookExecution

Methods

readsPrec :: Int -> ReadS StartNotebookExecutionResponse

readList :: ReadS [StartNotebookExecutionResponse]

readPrec :: ReadPrec StartNotebookExecutionResponse

readListPrec :: ReadPrec [StartNotebookExecutionResponse]

Show StartNotebookExecutionResponse

Defined in Amazonka.EMR.StartNotebookExecution

Methods

showsPrec :: Int -> StartNotebookExecutionResponse -> ShowS

show :: StartNotebookExecutionResponse -> String

showList :: [StartNotebookExecutionResponse] -> ShowS

NFData StartNotebookExecutionResponse

Defined in Amazonka.EMR.StartNotebookExecution

Methods

rnf :: StartNotebookExecutionResponse -> ()

Eq StartNotebookExecutionResponse

Defined in Amazonka.EMR.StartNotebookExecution

Methods

(==) :: StartNotebookExecutionResponse -> StartNotebookExecutionResponse -> Bool

(/=) :: StartNotebookExecutionResponse -> StartNotebookExecutionResponse -> Bool

type Rep StartNotebookExecutionResponse

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

Arguments

:: Int

$sel:httpStatus:StartNotebookExecutionResponse'

-> StartNotebookExecutionResponse

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

startNotebookExecutionResponse_notebookExecutionId :: Lens' StartNotebookExecutionResponse (Maybe Text)

The unique identifier of the notebook execution.

startNotebookExecutionResponse_httpStatus :: Lens' StartNotebookExecutionResponse Int

The response's http status code.