Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.EMR.Types.NotebookExecution

Description

Synopsis

data NotebookExecution = NotebookExecution' {
- status :: Maybe NotebookExecutionStatus
- executionEngine :: Maybe ExecutionEngineConfig
- notebookInstanceSecurityGroupId :: Maybe Text
- editorId :: Maybe Text
- startTime :: Maybe POSIX
- arn :: Maybe Text
- outputNotebookURI :: Maybe Text
- notebookExecutionId :: Maybe Text
- notebookExecutionName :: Maybe Text
- lastStateChangeReason :: Maybe Text
- endTime :: Maybe POSIX
- notebookParams :: Maybe Text
- tags :: Maybe [Tag]
}
newNotebookExecution :: NotebookExecution
notebookExecution_status :: Lens' NotebookExecution (Maybe NotebookExecutionStatus)
notebookExecution_executionEngine :: Lens' NotebookExecution (Maybe ExecutionEngineConfig)
notebookExecution_notebookInstanceSecurityGroupId :: Lens' NotebookExecution (Maybe Text)
notebookExecution_editorId :: Lens' NotebookExecution (Maybe Text)
notebookExecution_startTime :: Lens' NotebookExecution (Maybe UTCTime)
notebookExecution_arn :: Lens' NotebookExecution (Maybe Text)
notebookExecution_outputNotebookURI :: Lens' NotebookExecution (Maybe Text)
notebookExecution_notebookExecutionId :: Lens' NotebookExecution (Maybe Text)
notebookExecution_notebookExecutionName :: Lens' NotebookExecution (Maybe Text)
notebookExecution_lastStateChangeReason :: Lens' NotebookExecution (Maybe Text)
notebookExecution_endTime :: Lens' NotebookExecution (Maybe UTCTime)
notebookExecution_notebookParams :: Lens' NotebookExecution (Maybe Text)
notebookExecution_tags :: Lens' NotebookExecution (Maybe [Tag])

Documentation

data NotebookExecution Source #

A notebook execution. An execution is a specific instance that an EMR Notebook is run using the StartNotebookExecution action.

See: newNotebookExecution smart constructor.

Constructors

NotebookExecution'

Fields

status :: Maybe NotebookExecutionStatus
The status of the notebook execution.
- START_PENDING indicates that the cluster has received the execution request but execution has not begun.
- STARTING indicates that the execution is starting on the cluster.
- RUNNING indicates that the execution is being processed by the cluster.
- FINISHING indicates that execution processing is in the final stages.
- FINISHED indicates that the execution has completed without error.
- FAILING indicates that the execution is failing and will not finish successfully.
- FAILED indicates that the execution failed.
- STOP_PENDING indicates that the cluster has received a StopNotebookExecution request and the stop is pending.
- STOPPING indicates that the cluster is in the process of stopping the execution as a result of a StopNotebookExecution request.
- STOPPED indicates that the execution stopped because of a StopNotebookExecution request.
executionEngine :: Maybe ExecutionEngineConfig
The execution engine, such as an EMR cluster, used to run the EMR notebook and perform the notebook execution.
notebookInstanceSecurityGroupId :: Maybe Text
The unique identifier of the EC2 security group associated with the EMR Notebook instance. For more information see Specifying EC2 Security Groups for EMR Notebooks in the EMR Management Guide.
editorId :: Maybe Text
The unique identifier of the EMR Notebook that is used for the notebook execution.
startTime :: Maybe POSIX
The timestamp when notebook execution started.
arn :: Maybe Text
The Amazon Resource Name (ARN) of the notebook execution.
outputNotebookURI :: Maybe Text
The location of the notebook execution's output file in Amazon S3.
notebookExecutionId :: Maybe Text
The unique identifier of a notebook execution.
notebookExecutionName :: Maybe Text
A name for the notebook execution.
lastStateChangeReason :: Maybe Text
The reason for the latest status change of the notebook execution.
endTime :: Maybe POSIX
The timestamp when notebook execution ended.
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.

Instances

Instances details

Eq NotebookExecution Source #
Instance details Defined in Amazonka.EMR.Types.NotebookExecution Methods (==) :: NotebookExecution -> NotebookExecution -> Bool # (/=) :: NotebookExecution -> NotebookExecution -> Bool #
Read NotebookExecution Source #
Instance details Defined in Amazonka.EMR.Types.NotebookExecution Methods readsPrec :: Int -> ReadS NotebookExecution # readList :: ReadS [NotebookExecution] # readPrec :: ReadPrec NotebookExecution # readListPrec :: ReadPrec [NotebookExecution] #
Show NotebookExecution Source #
Instance details Defined in Amazonka.EMR.Types.NotebookExecution Methods showsPrec :: Int -> NotebookExecution -> ShowS # show :: NotebookExecution -> String # showList :: [NotebookExecution] -> ShowS #
Generic NotebookExecution Source #
Instance details Defined in Amazonka.EMR.Types.NotebookExecution Associated Types type Rep NotebookExecution :: Type -> Type # Methods from :: NotebookExecution -> Rep NotebookExecution x # to :: Rep NotebookExecution x -> NotebookExecution #
NFData NotebookExecution Source #
Instance details Defined in Amazonka.EMR.Types.NotebookExecution Methods rnf :: NotebookExecution -> () #
Hashable NotebookExecution Source #
Instance details Defined in Amazonka.EMR.Types.NotebookExecution Methods hashWithSalt :: Int -> NotebookExecution -> Int # hash :: NotebookExecution -> Int #
FromJSON NotebookExecution Source #
Instance details Defined in Amazonka.EMR.Types.NotebookExecution Methods parseJSON :: Value -> Parser NotebookExecution # parseJSONList :: Value -> Parser [NotebookExecution] #
type Rep NotebookExecution Source #
Instance details Defined in Amazonka.EMR.Types.NotebookExecution type Rep NotebookExecution = D1 ('MetaData "NotebookExecution" "Amazonka.EMR.Types.NotebookExecution" "libZSservicesZSamazonka-emrZSamazonka-emr" 'False) (C1 ('MetaCons "NotebookExecution'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe NotebookExecutionStatus)) :: (S1 ('MetaSel ('Just "executionEngine") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ExecutionEngineConfig)) :: S1 ('MetaSel ('Just "notebookInstanceSecurityGroupId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "editorId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "startTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "outputNotebookURI") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "notebookExecutionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "notebookExecutionName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "lastStateChangeReason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "endTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :: (S1 ('MetaSel ('Just "notebookParams") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])))))))

newNotebookExecution :: NotebookExecution Source #

Create a value of NotebookExecution 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:

$sel:status:NotebookExecution', notebookExecution_status - The status of the notebook execution.

START_PENDING indicates that the cluster has received the execution request but execution has not begun.
STARTING indicates that the execution is starting on the cluster.
RUNNING indicates that the execution is being processed by the cluster.
FINISHING indicates that execution processing is in the final stages.
FINISHED indicates that the execution has completed without error.
FAILING indicates that the execution is failing and will not finish successfully.
FAILED indicates that the execution failed.
STOP_PENDING indicates that the cluster has received a StopNotebookExecution request and the stop is pending.
STOPPING indicates that the cluster is in the process of stopping the execution as a result of a StopNotebookExecution request.
STOPPED indicates that the execution stopped because of a StopNotebookExecution request.

$sel:executionEngine:NotebookExecution', notebookExecution_executionEngine - The execution engine, such as an EMR cluster, used to run the EMR notebook and perform the notebook execution.

$sel:notebookInstanceSecurityGroupId:NotebookExecution', notebookExecution_notebookInstanceSecurityGroupId - The unique identifier of the EC2 security group associated with the EMR Notebook instance. For more information see Specifying EC2 Security Groups for EMR Notebooks in the EMR Management Guide.

$sel:editorId:NotebookExecution', notebookExecution_editorId - The unique identifier of the EMR Notebook that is used for the notebook execution.

$sel:startTime:NotebookExecution', notebookExecution_startTime - The timestamp when notebook execution started.

$sel:arn:NotebookExecution', notebookExecution_arn - The Amazon Resource Name (ARN) of the notebook execution.

$sel:outputNotebookURI:NotebookExecution', notebookExecution_outputNotebookURI - The location of the notebook execution's output file in Amazon S3.

$sel:notebookExecutionId:NotebookExecution', notebookExecution_notebookExecutionId - The unique identifier of a notebook execution.

$sel:notebookExecutionName:NotebookExecution', notebookExecution_notebookExecutionName - A name for the notebook execution.

$sel:lastStateChangeReason:NotebookExecution', notebookExecution_lastStateChangeReason - The reason for the latest status change of the notebook execution.

$sel:endTime:NotebookExecution', notebookExecution_endTime - The timestamp when notebook execution ended.

$sel:notebookParams:NotebookExecution', notebookExecution_notebookParams - Input parameters in JSON format passed to the EMR Notebook at runtime for execution.

$sel:tags:NotebookExecution', notebookExecution_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.

notebookExecution_status :: Lens' NotebookExecution (Maybe NotebookExecutionStatus) Source #

The status of the notebook execution.

START_PENDING indicates that the cluster has received the execution request but execution has not begun.
STARTING indicates that the execution is starting on the cluster.
RUNNING indicates that the execution is being processed by the cluster.
FINISHING indicates that execution processing is in the final stages.
FINISHED indicates that the execution has completed without error.
FAILING indicates that the execution is failing and will not finish successfully.
FAILED indicates that the execution failed.
STOP_PENDING indicates that the cluster has received a StopNotebookExecution request and the stop is pending.
STOPPING indicates that the cluster is in the process of stopping the execution as a result of a StopNotebookExecution request.
STOPPED indicates that the execution stopped because of a StopNotebookExecution request.

notebookExecution_executionEngine :: Lens' NotebookExecution (Maybe ExecutionEngineConfig) Source #

The execution engine, such as an EMR cluster, used to run the EMR notebook and perform the notebook execution.

notebookExecution_notebookInstanceSecurityGroupId :: Lens' NotebookExecution (Maybe Text) Source #

The unique identifier of the EC2 security group associated with the EMR Notebook instance. For more information see Specifying EC2 Security Groups for EMR Notebooks in the EMR Management Guide.

notebookExecution_editorId :: Lens' NotebookExecution (Maybe Text) Source #

The unique identifier of the EMR Notebook that is used for the notebook execution.

notebookExecution_startTime :: Lens' NotebookExecution (Maybe UTCTime) Source #

The timestamp when notebook execution started.

notebookExecution_arn :: Lens' NotebookExecution (Maybe Text) Source #

The Amazon Resource Name (ARN) of the notebook execution.

notebookExecution_outputNotebookURI :: Lens' NotebookExecution (Maybe Text) Source #

The location of the notebook execution's output file in Amazon S3.

notebookExecution_notebookExecutionId :: Lens' NotebookExecution (Maybe Text) Source #

The unique identifier of a notebook execution.

notebookExecution_notebookExecutionName :: Lens' NotebookExecution (Maybe Text) Source #

A name for the notebook execution.

notebookExecution_lastStateChangeReason :: Lens' NotebookExecution (Maybe Text) Source #

The reason for the latest status change of the notebook execution.

notebookExecution_endTime :: Lens' NotebookExecution (Maybe UTCTime) Source #

The timestamp when notebook execution ended.

notebookExecution_notebookParams :: Lens' NotebookExecution (Maybe Text) Source #

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

notebookExecution_tags :: Lens' NotebookExecution (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.