Skip to content

/AWS1/CL_SGMPIPELINEEXECSTEP

An execution of a step in a pipeline.

CONSTRUCTOR

IMPORTING

Optional arguments:

iv_stepname TYPE /AWS1/SGMSTEPNAME /AWS1/SGMSTEPNAME

The name of the step that is executed.

iv_stepdisplayname TYPE /AWS1/SGMSTEPDISPLAYNAME /AWS1/SGMSTEPDISPLAYNAME

The display name of the step.

iv_stepdescription TYPE /AWS1/SGMSTEPDESCRIPTION /AWS1/SGMSTEPDESCRIPTION

The description of the step.

iv_starttime TYPE /AWS1/SGMTIMESTAMP /AWS1/SGMTIMESTAMP

The time that the step started executing.

iv_endtime TYPE /AWS1/SGMTIMESTAMP /AWS1/SGMTIMESTAMP

The time that the step stopped executing.

iv_stepstatus TYPE /AWS1/SGMSTEPSTATUS /AWS1/SGMSTEPSTATUS

The status of the step execution.

io_cachehitresult TYPE REF TO /AWS1/CL_SGMCACHEHITRESULT /AWS1/CL_SGMCACHEHITRESULT

If this pipeline execution step was cached, details on the cache hit.

iv_failurereason TYPE /AWS1/SGMFAILUREREASON /AWS1/SGMFAILUREREASON

The reason why the step failed execution. This is only returned if the step failed its execution.

io_metadata TYPE REF TO /AWS1/CL_SGMPLINEXECSTEPMET /AWS1/CL_SGMPLINEXECSTEPMET

Metadata to run the pipeline step.

iv_attemptcount TYPE /AWS1/SGMINTEGER /AWS1/SGMINTEGER

The current attempt of the execution step. For more information, see Retry Policy for SageMaker Pipelines steps.

io_selectiveexecutionresult TYPE REF TO /AWS1/CL_SGMSELECTIVEEXECRSLT /AWS1/CL_SGMSELECTIVEEXECRSLT

The ARN from an execution of the current pipeline from which results are reused for this step.


Queryable Attributes

StepName

The name of the step that is executed.

Accessible with the following methods

Method Description
GET_STEPNAME() Getter for STEPNAME, with configurable default
ASK_STEPNAME() Getter for STEPNAME w/ exceptions if field has no value
HAS_STEPNAME() Determine if STEPNAME has a value

StepDisplayName

The display name of the step.

Accessible with the following methods

Method Description
GET_STEPDISPLAYNAME() Getter for STEPDISPLAYNAME, with configurable default
ASK_STEPDISPLAYNAME() Getter for STEPDISPLAYNAME w/ exceptions if field has no val
HAS_STEPDISPLAYNAME() Determine if STEPDISPLAYNAME has a value

StepDescription

The description of the step.

Accessible with the following methods

Method Description
GET_STEPDESCRIPTION() Getter for STEPDESCRIPTION, with configurable default
ASK_STEPDESCRIPTION() Getter for STEPDESCRIPTION w/ exceptions if field has no val
HAS_STEPDESCRIPTION() Determine if STEPDESCRIPTION has a value

StartTime

The time that the step started executing.

Accessible with the following methods

Method Description
GET_STARTTIME() Getter for STARTTIME, with configurable default
ASK_STARTTIME() Getter for STARTTIME w/ exceptions if field has no value
HAS_STARTTIME() Determine if STARTTIME has a value

EndTime

The time that the step stopped executing.

Accessible with the following methods

Method Description
GET_ENDTIME() Getter for ENDTIME, with configurable default
ASK_ENDTIME() Getter for ENDTIME w/ exceptions if field has no value
HAS_ENDTIME() Determine if ENDTIME has a value

StepStatus

The status of the step execution.

Accessible with the following methods

Method Description
GET_STEPSTATUS() Getter for STEPSTATUS, with configurable default
ASK_STEPSTATUS() Getter for STEPSTATUS w/ exceptions if field has no value
HAS_STEPSTATUS() Determine if STEPSTATUS has a value

CacheHitResult

If this pipeline execution step was cached, details on the cache hit.

Accessible with the following methods

Method Description
GET_CACHEHITRESULT() Getter for CACHEHITRESULT

FailureReason

The reason why the step failed execution. This is only returned if the step failed its execution.

Accessible with the following methods

Method Description
GET_FAILUREREASON() Getter for FAILUREREASON, with configurable default
ASK_FAILUREREASON() Getter for FAILUREREASON w/ exceptions if field has no value
HAS_FAILUREREASON() Determine if FAILUREREASON has a value

Metadata

Metadata to run the pipeline step.

Accessible with the following methods

Method Description
GET_METADATA() Getter for METADATA

AttemptCount

The current attempt of the execution step. For more information, see Retry Policy for SageMaker Pipelines steps.

Accessible with the following methods

Method Description
GET_ATTEMPTCOUNT() Getter for ATTEMPTCOUNT, with configurable default
ASK_ATTEMPTCOUNT() Getter for ATTEMPTCOUNT w/ exceptions if field has no value
HAS_ATTEMPTCOUNT() Determine if ATTEMPTCOUNT has a value

SelectiveExecutionResult

The ARN from an execution of the current pipeline from which results are reused for this step.

Accessible with the following methods

Method Description
GET_SELECTIVEEXECUTIONRESULT() Getter for SELECTIVEEXECUTIONRESULT

Public Local Types In This Class

Internal table types, representing arrays and maps of this class, are defined as local types:

TT_PIPELINEEXECUTIONSTEPLIST

TYPES TT_PIPELINEEXECUTIONSTEPLIST TYPE STANDARD TABLE OF REF TO /AWS1/CL_SGMPIPELINEEXECSTEP WITH DEFAULT KEY
.