Parameter: Workflow Parameter Class

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

Workflow Parameter Class

Description

Pipeline parameter for workflow.

Super class

sagemaker.workflow::Entity -> Parameter

Public fields

name

The name of the parameter.

parameter_type

The type of the parameter

default_value

The default python value of the parameter

Active bindings

expr

The 'Get' expression dict for a 'Parameter'

Methods

Public methods

• Parameter$new()

• Parameter$to_request()

• Parameter$clone()

Inherited methods

• sagemaker.workflow::Entity$format()

---

Method new()

Initialize Parameter class

Usage

Parameter$new(
  name,
  parameter_type = ParameterTypeEnum$new(),
  default_value = NULL
)

Arguments

name

(str): The name of the parameter.

parameter_type

(ParameterTypeEnum): The type of the parameter.

default_value

(PrimitiveType): The default Python value of the parameter.

---

Method to_request()

Get the request structure for workflow service calls.

Usage

Parameter$to_request()

---

Method clone()

The objects of this class are cloneable with this method.

Usage

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