Skip to content

/AWS1/CL_DZNSTRTNOTEBOOKRUNOUT

StartNotebookRunOutput

CONSTRUCTOR

IMPORTING

Required arguments:

iv_id TYPE /AWS1/DZNNOTEBOOKRUNID /AWS1/DZNNOTEBOOKRUNID

The identifier of the notebook run.

iv_domainid TYPE /AWS1/DZNDOMAINID /AWS1/DZNDOMAINID

The identifier of the Amazon DataZone domain.

iv_owningprojectid TYPE /AWS1/DZNPROJECTID /AWS1/DZNPROJECTID

The identifier of the project that owns the notebook run.

iv_notebookid TYPE /AWS1/DZNNOTEBOOKID /AWS1/DZNNOTEBOOKID

The identifier of the notebook.

iv_status TYPE /AWS1/DZNNOTEBOOKRUNSTATUS /AWS1/DZNNOTEBOOKRUNSTATUS

The status of the notebook run.

Optional arguments:

iv_scheduleid TYPE /AWS1/DZNSCHEDULEID /AWS1/DZNSCHEDULEID

The identifier of the schedule associated with the notebook run.

it_cellorder TYPE /AWS1/CL_DZNCELLINFORMATION=>TT_CELLORDER TT_CELLORDER

The ordered list of cells in the notebook run.

it_metadata TYPE /AWS1/CL_DZNMETADATA_W=>TT_METADATA TT_METADATA

The metadata of the notebook run.

it_parameters TYPE /AWS1/CL_DZNPARAMETERS_W=>TT_PARAMETERS TT_PARAMETERS

The sensitive parameters of the notebook run.

io_computeconfiguration TYPE REF TO /AWS1/CL_DZNCOMPUTECONFIG /AWS1/CL_DZNCOMPUTECONFIG

The compute configuration of the notebook run.

io_networkconfiguration TYPE REF TO /AWS1/CL_DZNNETWORKCONFIG /AWS1/CL_DZNNETWORKCONFIG

The network configuration of the notebook run.

io_timeoutconfiguration TYPE REF TO /AWS1/CL_DZNTIMEOUTCONFIG /AWS1/CL_DZNTIMEOUTCONFIG

The timeout configuration of the notebook run.

io_environmentconfiguration TYPE REF TO /AWS1/CL_DZNENVIRONMENTCONFIG /AWS1/CL_DZNENVIRONMENTCONFIG

The environment configuration of the notebook run, including image version and package settings.

io_storageconfiguration TYPE REF TO /AWS1/CL_DZNSTORAGECONFIG /AWS1/CL_DZNSTORAGECONFIG

The storage configuration of the notebook run, including the Amazon Simple Storage Service path and KMS key ARN.

io_triggersource TYPE REF TO /AWS1/CL_DZNTRIGGERSOURCE /AWS1/CL_DZNTRIGGERSOURCE

The source that triggered the notebook run.

io_error TYPE REF TO /AWS1/CL_DZNNOTEBOOKRUNERROR /AWS1/CL_DZNNOTEBOOKRUNERROR

The error details if the notebook run failed.

iv_createdat TYPE /AWS1/DZNCREATEDAT /AWS1/DZNCREATEDAT

The timestamp of when the notebook run was created.

iv_createdby TYPE /AWS1/DZNCREATEDBY /AWS1/DZNCREATEDBY

The identifier of the user who created the notebook run.

iv_updatedat TYPE /AWS1/DZNUPDATEDAT /AWS1/DZNUPDATEDAT

The timestamp of when the notebook run was last updated.

iv_updatedby TYPE /AWS1/DZNUPDATEDBY /AWS1/DZNUPDATEDBY

The identifier of the user who last updated the notebook run.

iv_startedat TYPE /AWS1/DZNTIMESTAMP /AWS1/DZNTIMESTAMP

The timestamp of when the notebook run started executing.

iv_completedat TYPE /AWS1/DZNTIMESTAMP /AWS1/DZNTIMESTAMP

The timestamp of when the notebook run completed.


Queryable Attributes

id

The identifier of the notebook run.

Accessible with the following methods

Method Description
GET_ID() Getter for ID, with configurable default
ASK_ID() Getter for ID w/ exceptions if field has no value
HAS_ID() Determine if ID has a value

domainId

The identifier of the Amazon DataZone domain.

Accessible with the following methods

Method Description
GET_DOMAINID() Getter for DOMAINID, with configurable default
ASK_DOMAINID() Getter for DOMAINID w/ exceptions if field has no value
HAS_DOMAINID() Determine if DOMAINID has a value

owningProjectId

The identifier of the project that owns the notebook run.

Accessible with the following methods

Method Description
GET_OWNINGPROJECTID() Getter for OWNINGPROJECTID, with configurable default
ASK_OWNINGPROJECTID() Getter for OWNINGPROJECTID w/ exceptions if field has no val
HAS_OWNINGPROJECTID() Determine if OWNINGPROJECTID has a value

notebookId

The identifier of the notebook.

Accessible with the following methods

Method Description
GET_NOTEBOOKID() Getter for NOTEBOOKID, with configurable default
ASK_NOTEBOOKID() Getter for NOTEBOOKID w/ exceptions if field has no value
HAS_NOTEBOOKID() Determine if NOTEBOOKID has a value

scheduleId

The identifier of the schedule associated with the notebook run.

Accessible with the following methods

Method Description
GET_SCHEDULEID() Getter for SCHEDULEID, with configurable default
ASK_SCHEDULEID() Getter for SCHEDULEID w/ exceptions if field has no value
HAS_SCHEDULEID() Determine if SCHEDULEID has a value

status

The status of the notebook run.

Accessible with the following methods

Method Description
GET_STATUS() Getter for STATUS, with configurable default
ASK_STATUS() Getter for STATUS w/ exceptions if field has no value
HAS_STATUS() Determine if STATUS has a value

cellOrder

The ordered list of cells in the notebook run.

Accessible with the following methods

Method Description
GET_CELLORDER() Getter for CELLORDER, with configurable default
ASK_CELLORDER() Getter for CELLORDER w/ exceptions if field has no value
HAS_CELLORDER() Determine if CELLORDER has a value

metadata

The metadata of the notebook run.

Accessible with the following methods

Method Description
GET_METADATA() Getter for METADATA, with configurable default
ASK_METADATA() Getter for METADATA w/ exceptions if field has no value
HAS_METADATA() Determine if METADATA has a value

parameters

The sensitive parameters of the notebook run.

Accessible with the following methods

Method Description
GET_PARAMETERS() Getter for PARAMETERS, with configurable default
ASK_PARAMETERS() Getter for PARAMETERS w/ exceptions if field has no value
HAS_PARAMETERS() Determine if PARAMETERS has a value

computeConfiguration

The compute configuration of the notebook run.

Accessible with the following methods

Method Description
GET_COMPUTECONFIGURATION() Getter for COMPUTECONFIGURATION

networkConfiguration

The network configuration of the notebook run.

Accessible with the following methods

Method Description
GET_NETWORKCONFIGURATION() Getter for NETWORKCONFIGURATION

timeoutConfiguration

The timeout configuration of the notebook run.

Accessible with the following methods

Method Description
GET_TIMEOUTCONFIGURATION() Getter for TIMEOUTCONFIGURATION

environmentConfiguration

The environment configuration of the notebook run, including image version and package settings.

Accessible with the following methods

Method Description
GET_ENVIRONMENTCONFIGURATION() Getter for ENVIRONMENTCONFIGURATION

storageConfiguration

The storage configuration of the notebook run, including the Amazon Simple Storage Service path and KMS key ARN.

Accessible with the following methods

Method Description
GET_STORAGECONFIGURATION() Getter for STORAGECONFIGURATION

triggerSource

The source that triggered the notebook run.

Accessible with the following methods

Method Description
GET_TRIGGERSOURCE() Getter for TRIGGERSOURCE

error

The error details if the notebook run failed.

Accessible with the following methods

Method Description
GET_ERROR() Getter for ERROR

createdAt

The timestamp of when the notebook run was created.

Accessible with the following methods

Method Description
GET_CREATEDAT() Getter for CREATEDAT, with configurable default
ASK_CREATEDAT() Getter for CREATEDAT w/ exceptions if field has no value
HAS_CREATEDAT() Determine if CREATEDAT has a value

createdBy

The identifier of the user who created the notebook run.

Accessible with the following methods

Method Description
GET_CREATEDBY() Getter for CREATEDBY, with configurable default
ASK_CREATEDBY() Getter for CREATEDBY w/ exceptions if field has no value
HAS_CREATEDBY() Determine if CREATEDBY has a value

updatedAt

The timestamp of when the notebook run was last updated.

Accessible with the following methods

Method Description
GET_UPDATEDAT() Getter for UPDATEDAT, with configurable default
ASK_UPDATEDAT() Getter for UPDATEDAT w/ exceptions if field has no value
HAS_UPDATEDAT() Determine if UPDATEDAT has a value

updatedBy

The identifier of the user who last updated the notebook run.

Accessible with the following methods

Method Description
GET_UPDATEDBY() Getter for UPDATEDBY, with configurable default
ASK_UPDATEDBY() Getter for UPDATEDBY w/ exceptions if field has no value
HAS_UPDATEDBY() Determine if UPDATEDBY has a value

startedAt

The timestamp of when the notebook run started executing.

Accessible with the following methods

Method Description
GET_STARTEDAT() Getter for STARTEDAT, with configurable default
ASK_STARTEDAT() Getter for STARTEDAT w/ exceptions if field has no value
HAS_STARTEDAT() Determine if STARTEDAT has a value

completedAt

The timestamp of when the notebook run completed.

Accessible with the following methods

Method Description
GET_COMPLETEDAT() Getter for COMPLETEDAT, with configurable default
ASK_COMPLETEDAT() Getter for COMPLETEDAT w/ exceptions if field has no value
HAS_COMPLETEDAT() Determine if COMPLETEDAT has a value