class_docstr: `AutoMLStep` for SageMaker Pipelines Workflows.
class_docstr_tok: ["`","AutoMLStep","`","for","SageMaker","Pipelines","Workflows","."]
docstr: Construct a `AutoMLStep`, given a `AutoML` instance.
  
  In addition to the `AutoML` instance, the other arguments are those
  that are supplied to the `fit` method of the `sagemaker.automl.automl.AutoML`.
  
  Args:
      name (str): The name of the `AutoMLStep`.
      step_args (_JobStepArguments): The arguments for the `AutoMLStep` definition.
      display_name (str): The display name of the `AutoMLStep`.
      description (str): The description of the `AutoMLStep`.
      cache_config (CacheConfig): A `sagemaker.workflow.steps.CacheConfig` instance.
      depends_on (List[Union[str, Step, StepCollection]]): A list of `Step`/`StepCollection`
          names or `Step` instances or `StepCollection` instances that this `AutoMLStep`
          depends on.
      retry_policies (List[RetryPolicy]): A list of retry policies.
docstr_tok: ["Construct","a","`","AutoMLStep","`",",","given","a","`","AutoML","`","instance",".","In","addition","to","the","`","AutoML","`","instance",",","the","other","arguments","are","those","that","are","supplied","to","the","`","fit","`","method","of","the","`","sagemaker.automl.automl.AutoML","`",".","Args",":","name","(","str",")",":","The","name","of","the","`","AutoMLStep","`",".","step_args","(","_JobStepArguments",")",":","The","arguments","for","the","`","AutoMLStep","`","definition",".","display_name","(","str",")",":","The","display","name","of","the","`","AutoMLStep","`",".","description","(","str",")",":","The","description","of","the","`","AutoMLStep","`",".","cache_config","(","CacheConfig",")",":","A","`","sagemaker.workflow.steps.CacheConfig","`","instance",".","depends_on","(","List","[","Union","[","str",",","Step",",","StepCollection","]","]",")",":","A","list","of","`","Step","`","\/","`","StepCollection","`","names","or","`","Step","`","instances","or","`","StepCollection","`","instances","that","this","`","AutoMLStep","`","depends","on",".","retry_policies","(","List","[","RetryPolicy","]",")",":","A","list","of","retry","policies","."]
code: def __init__(
      self,
      name: str,
      step_args: _JobStepArguments,
      display_name: str = None,
      description: str = None,
      cache_config: CacheConfig = None,
      depends_on: Optional[
          List[Union[str, Step, StepCollection]]
      ] = None,
      retry_policies: List[RetryPolicy] = None,
  ):
      """Construct a `AutoMLStep`, given a `AutoML` instance.
  
      In addition to the `AutoML` instance, the other arguments are those
      that are supplied to the `fit` method of the `sagemaker.automl.automl.AutoML`.
  
      Args:
          name (str): The name of the `AutoMLStep`.
          step_args (_JobStepArguments): The arguments for the `AutoMLStep` definition.
          display_name (str): The display name of the `AutoMLStep`.
          description (str): The description of the `AutoMLStep`.
          cache_config (CacheConfig): A `sagemaker.workflow.steps.CacheConfig` instance.
          depends_on (List[Union[str, Step, StepCollection]]): A list of `Step`/`StepCollection`
              names or `Step` instances or `StepCollection` instances that this `AutoMLStep`
              depends on.
          retry_policies (List[RetryPolicy]): A list of retry policies.
      """
      super(AutoMLStep, self).__init__(
          name,
          StepTypeEnum.AUTOML,
          display_name,
          description,
          depends_on,
          retry_policies,
      )
  
      validate_step_args_input(
          step_args=step_args,
          expected_caller={Session.auto_ml.__name__},
          error_message="The step_args of AutoMLStep must be obtained "
          "from automl.fit().",
      )
  
      self.step_args = step_args
      self.cache_config = cache_config
  
      root_property = Properties(
          step_name=name,
          step=self,
          shape_name="DescribeAutoMLJobResponse",
      )
  
      best_candidate_properties = Properties(
          step_name=name, step=self, path="BestCandidateProperties"
      )
      best_candidate_properties.__dict__[
          "ModelInsightsJsonReportPath"
      ] = Properties(
          step_name=name,
          step=self,
          path="BestCandidateProperties.ModelInsightsJsonReportPath",
      )
      best_candidate_properties.__dict__[
          "ExplainabilityJsonReportPath"
      ] = Properties(
          step_name=name,
          step=self,
          path="BestCandidateProperties.ExplainabilityJsonReportPath",
      )
  
      root_property.__dict__[
          "BestCandidateProperties"
      ] = best_candidate_properties
      self._properties = root_property
  
file_path: sagemaker-python-sdk/src/sagemaker/workflow/automl_step.py
imports: from __future__ import absolute_import
  from typing import Union, Optional, List
  from sagemaker import Session, Model
  from sagemaker.exceptions import AutoMLStepInvalidModeError
  from sagemaker.workflow.entities import RequestType
  from sagemaker.workflow.pipeline_context import _JobStepArguments
  from sagemaker.workflow.properties import Properties
  from sagemaker.workflow.retry import RetryPolicy
  from sagemaker.workflow.steps import ConfigurableRetryStep, CacheConfig, Step, StepTypeEnum
  from sagemaker.workflow.utilities import validate_step_args_input, trim_request_dict
  from sagemaker.workflow.step_collections import StepCollection
label_desc: Use image node_id 1 to create a new AutoMLStep object from inherited base classes: ConfigurableRetryStep with example: obj = AutoMLStep(name, step_args, display_name, description, cache_config, depends_on, retry_policies)