FailStep: Workflow FailStep

In DyfanJones/sagemaker-r-workflow: sagemaker pipeline and workflows

Workflow FailStep

Description

FailStep' for SageMaker Pipelines Workflows.

Super classes

sagemaker.workflow::Entity -> sagemaker.workflow::Step -> FailStep

Public fields

error_message

An error message defined by the user.

Active bindings

arguments

The arguments dictionary that is used to define the 'FailStep'.

properties

A 'Properties' object is not available for the 'FailStep'. Executing a 'FailStep' will terminate the pipeline. 'FailStep' properties should not be referenced.

Methods

Public methods

• FailStep$new()

• FailStep$clone()

Inherited methods

• sagemaker.workflow::Step$add_depends_on()

• sagemaker.workflow::Step$format()

• sagemaker.workflow::Step$to_request()

---

Method new()

Constructs a 'FailStep'.

Usage

FailStep$new(
  name,
  error_message = NULL,
  display_name = NULL,
  description = NULL,
  depends_on = NULL
)

Arguments

name

(str): The name of the 'FailStep'. A name is required and must be unique within a pipeline.

error_message

(str or PipelineNonPrimitiveInputTypes): An error message defined by the user. Once the 'FailStep' is reached, the execution fails and the error message is set as the failure reason (default: None).

display_name

(str): The display name of the 'FailStep'. The display name provides better UI readability. (default: None).

description

(str): The description of the 'FailStep' (default: None).

depends_on

(List[str] or List[Step]): A list of 'Step' names or 'Step' instances that this 'FailStep' depends on. If a listed 'Step' name does not exist, an error is returned (default: None).

---

Method clone()

The objects of this class are cloneable with this method.

Usage

FailStep$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

DyfanJones/sagemaker-r-workflow documentation built on April 3, 2022, 11:28 p.m.