Step: Workflow Step class

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

Workflow Step class

Description

Pipeline step for workflow.

Super class

sagemaker.workflow::Entity -> Step

Public fields

name

The name of the step.

display_name

The display name of the step.

description

The description of the step.

step_type

The type of the step.

depends_on

The list of step names the current step depends on

retry_policies

(List[RetryPolicy]): The custom retry policy configuration

Active bindings

arguments

The arguments to the particular step service call.

properties

The properties of the particular step.

ref

Gets a reference dict for steps

Methods

Public methods

• Step$new()

• Step$to_request()

• Step$add_depends_on()

• Step$format()

• Step$clone()

Inherited methods

---

Method new()

Initialize Workflow Step

Usage

Step$new(
  name,
  display_name = NULL,
  description = NULL,
  step_type = enum_items(StepTypeEnum),
  depends_on = NULL
)

Arguments

name

(str): The name of the step.

display_name

(str): The display name of the step.

description

(str): The description of the step.

step_type

(StepTypeEnum): The type of the step.

depends_on

(List[str] or List[Step]): The list of step names or step instances the current step depends on

---

Method to_request()

Gets the request structure for workflow service calls.

Usage

Step$to_request()

---

Method add_depends_on()

Add step names to the current step depends on list

Usage

Step$add_depends_on(step_names)

Arguments

step_names

(list): placeholder

---

Method format()

formats class

Usage

Step$format()

---

Method clone()

The objects of this class are cloneable with this method.

Usage

Step$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.