sagemaker.mlops.workflow.notebook_job_step

The notebook job step definitions for workflow.

Classes

NotebookJobStep(input_notebook, image_uri, ...)

NotebookJobStep for SageMaker Pipelines Workflows.

class sagemaker.mlops.workflow.notebook_job_step.NotebookJobStep(input_notebook: str, image_uri: str, kernel_name: str, name: str | None = None, display_name: str | None = None, description: str | None = None, notebook_job_name: str | None = None, role: str | None = None, s3_root_uri: str | None = None, parameters: Dict[str, str | PipelineVariable] | None = None, environment_variables: Dict[str, str | PipelineVariable] | None = None, initialization_script: str | None = None, s3_kms_key: str | PipelineVariable | None = None, instance_type: str | PipelineVariable | None = 'ml.m5.large', volume_size: int | PipelineVariable = 30, volume_kms_key: str | PipelineVariable | None = None, encrypt_inter_container_traffic: bool | PipelineVariable | None = True, security_group_ids: List[str | PipelineVariable] | None = None, subnets: List[str | PipelineVariable] | None = None, max_retry_attempts: int = 1, max_runtime_in_seconds: int = 172800, tags: List[Dict[str, str | PipelineVariable]] | Dict[str, str | PipelineVariable] | None = None, additional_dependencies: List[str] | None = None, retry_policies: List[RetryPolicy] | None = None, depends_on: List[Step | StepOutput] | None = None)

Bases: ConfigurableRetryStep

NotebookJobStep for SageMaker Pipelines Workflows.

For more details about SageMaker Notebook Jobs, see SageMaker Notebook Jobs.

property arguments: Dict[str, Any] | List[Dict[str, Any]]

Generates the arguments dictionary that is used to create the job.

property depends_on: List[str | Step | StepCollection | StepOutput] | None

The list of steps the current Step depends on.

property properties

A Properties object representing the notebook job step output

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

Gets the request structure for workflow service calls.