sagemaker.core.workflow.parameters

Pipeline parameters and conditions for workflow.

Classes

Parameter([name, parameter_type, default_value])	Pipeline parameter for workflow.
ParameterFloat(name[, default_value])	Float parameter for pipelines.
ParameterInteger(name[, default_value])	Integer parameter for pipelines.
ParameterString(name[, default_value, ...])	String parameter for pipelines.
ParameterTypeEnum(*args[, value])	Parameter type enum.

class sagemaker.core.workflow.parameters.Parameter(name: str = NOTHING, parameter_type: ParameterTypeEnum = NOTHING, default_value: str | int | bool | float | None = None)

Bases: PipelineVariable, Entity

Pipeline parameter for workflow.

name

The name of the parameter.

Type:

str

parameter_type

The type of the parameter.

Type:

ParameterTypeEnum

default_value

The default value of the parameter.

Type:

PrimitiveType

default_value: str | int | bool | float | None

property expr: Dict[str, str]

The ‘Get’ expression dict for a Parameter.

name: str

parameter_type: ParameterTypeEnum

to_request() → Dict[str, Any] | List[Dict[str, Any]]

Get the request structure for workflow service calls.

class sagemaker.core.workflow.parameters.ParameterFloat(name: str, default_value: float | None = None)

Bases: Parameter

Float parameter for pipelines.

class sagemaker.core.workflow.parameters.ParameterInteger(name: str, default_value: int | None = None)

Bases: Parameter

Integer parameter for pipelines.

class sagemaker.core.workflow.parameters.ParameterString(name: str, default_value: str | None = None, enum_values: List[str] | None = None)

Bases: Parameter

String parameter for pipelines.

to_request() → Dict[str, Any] | List[Dict[str, Any]]

Get the request structure for workflow service calls.

to_string() → PipelineVariable

Prompt the pipeline to convert the pipeline variable to String in runtime

As ParameterString is treated as String in runtime, no extra actions are needed.

class sagemaker.core.workflow.parameters.ParameterTypeEnum(*args, value=<object object>, **kwargs)

Bases: Enum

Parameter type enum.

BOOLEAN = 'Boolean'

FLOAT = 'Float'

INTEGER = 'Integer'

STRING = 'String'

property python_type: Type

Provide the Python type of the enum value.