class_docstr: A class for creating and interacting with SageMaker AutoML jobs.
docstr: Returns the list of candidates of an AutoML job for a given name.
  
  Args:
      job_name (str): The name of the AutoML job. If None, will use object's
          _current_job name.
      status_equals (str): Filter the result with candidate status, values could be
          "Completed", "InProgress", "Failed", "Stopped", "Stopping"
      candidate_name (str): The name of a specified candidate to list.
          Default to None.
      candidate_arn (str): The Arn of a specified candidate to list.
          Default to None.
      sort_order (str): The order that the candidates will be listed in result.
          Default to None.
      sort_by (str): The value that the candidates will be sorted by.
          Default to None.
      max_results (int): The number of candidates will be listed in results,
          between 1 to 100. Default to None. If None, will return all the candidates.
  
  Returns:
      list: A list of dictionaries with candidates information.
docstr_tok: ["Returns","the","list","of","candidates","of","an","AutoML","job","for","a","given","name",".","Args",":","job_name","(","str",")",":","The","name","of","the","AutoML","job",".","If","None",",","will","use","object's","_current_job","name",".","status_equals","(","str",")",":","Filter","the","result","with","candidate","status",",","values","could","be","``","Completed","''",",","``","InProgress","''",",","``","Failed","''",",","``","Stopped","''",",","``","Stopping","''","candidate_name","(","str",")",":","The","name","of","a","specified","candidate","to","list",".","Default","to","None",".","candidate_arn","(","str",")",":","The","Arn","of","a","specified","candidate","to","list",".","Default","to","None",".","sort_order","(","str",")",":","The","order","that","the","candidates","will","be","listed","in","result",".","Default","to","None",".","sort_by","(","str",")",":","The","value","that","the","candidates","will","be","sorted","by",".","Default","to","None",".","max_results","(","int",")",":","The","number","of","candidates","will","be","listed","in","results",",","between","1","to","100",".","Default","to","None",".","If","None",",","will","return","all","the","candidates",".","Returns",":","list",":","A","list","of","dictionaries","with","candidates","information","."]
code: def list_candidates(
      self,
      job_name=None,
      status_equals=None,
      candidate_name=None,
      candidate_arn=None,
      sort_order=None,
      sort_by=None,
      max_results=None,
  ):
      """Returns the list of candidates of an AutoML job for a given name.
  
      Args:
          job_name (str): The name of the AutoML job. If None, will use object's
              _current_job name.
          status_equals (str): Filter the result with candidate status, values could be
              "Completed", "InProgress", "Failed", "Stopped", "Stopping"
          candidate_name (str): The name of a specified candidate to list.
              Default to None.
          candidate_arn (str): The Arn of a specified candidate to list.
              Default to None.
          sort_order (str): The order that the candidates will be listed in result.
              Default to None.
          sort_by (str): The value that the candidates will be sorted by.
              Default to None.
          max_results (int): The number of candidates will be listed in results,
              between 1 to 100. Default to None. If None, will return all the candidates.
  
      Returns:
          list: A list of dictionaries with candidates information.
      """
      if job_name is None:
          job_name = self.current_job_name
  
      list_candidates_args = {"job_name": job_name}
  
      if status_equals:
          list_candidates_args["status_equals"] = status_equals
      if candidate_name:
          list_candidates_args["candidate_name"] = candidate_name
      if candidate_arn:
          list_candidates_args["candidate_arn"] = candidate_arn
      if sort_order:
          list_candidates_args["sort_order"] = sort_order
      if sort_by:
          list_candidates_args["sort_by"] = sort_by
      if max_results:
          list_candidates_args["max_results"] = max_results
  
      return self.sagemaker_session.list_candidates(
          **list_candidates_args
      )["Candidates"]
  
imports: from __future__ import absolute_import
  import logging
  from typing import Optional, List, Dict
  from six import string_types
  from sagemaker import Model, PipelineModel, s3
  from sagemaker.automl.candidate_estimator import CandidateEstimator
  from sagemaker.config import AUTO_ML_ROLE_ARN_PATH, AUTO_ML_KMS_KEY_ID_PATH, AUTO_ML_VPC_CONFIG_PATH, AUTO_ML_VOLUME_KMS_KEY_ID_PATH, AUTO_ML_INTER_CONTAINER_ENCRYPTION_PATH
  from sagemaker.job import _Job
  from sagemaker.session import Session
  from sagemaker.utils import name_from_base, resolve_value_from_config, format_tags, Tags
  from sagemaker.workflow.entities import PipelineVariable
  from sagemaker.workflow.pipeline_context import runnable_by_pipeline
label_desc: Use image node_id 6 for calling the AutoML obj's underlying member method code with example usage: obj.list_candidates(job_name, status_equals, candidate_name, candidate_arn, sort_order, sort_by, max_results) and returns: self