The London Perl and Raku Workshop takes place on 26th Oct 2024. If your company depends on Perl, please consider sponsoring and/or attending.
 / 
Paws-0.46
River stage two • 9 direct dependents • 11 total dependents
/ Paws::SageMaker::ListCandidatesForAutoMLJob

NAME

Paws::SageMaker::ListCandidatesForAutoMLJob - Arguments for method ListCandidatesForAutoMLJob on Paws::SageMaker

DESCRIPTION

This class represents the parameters used for calling the method ListCandidatesForAutoMLJob on the Amazon SageMaker Service service. Use the attributes of this class as arguments to method ListCandidatesForAutoMLJob.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ListCandidatesForAutoMLJob.

SYNOPSIS

my $api.sagemaker = Paws->service('SageMaker');
my $ListCandidatesForAutoMLJobResponse =
  $api . sagemaker->ListCandidatesForAutoMLJob(
  AutoMLJobName       => 'MyAutoMLJobName',
  CandidateNameEquals => 'MyCandidateName',    # OPTIONAL
  MaxResults          => 1,                    # OPTIONAL
  NextToken           => 'MyNextToken',        # OPTIONAL
  SortBy              => 'CreationTime',       # OPTIONAL
  SortOrder           => 'Ascending',          # OPTIONAL
  StatusEquals        => 'Completed',          # OPTIONAL
  );

# Results:
my $Candidates = $ListCandidatesForAutoMLJobResponse->Candidates;
my $NextToken  = $ListCandidatesForAutoMLJobResponse->NextToken;

# Returns a L<Paws::SageMaker::ListCandidatesForAutoMLJobResponse> object.

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/api.sagemaker/ListCandidatesForAutoMLJob

ATTRIBUTES

REQUIRED AutoMLJobName => Str

List the candidates created for the job by providing the job's name.

CandidateNameEquals => Str

List the candidates for the job and filter by candidate name.

MaxResults => Int

List the job's candidates up to a specified limit.

NextToken => Str

If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.

SortBy => Str

The parameter by which to sort the results. The default is Descending.

Valid values are: "CreationTime", "Status", "FinalObjectiveMetricValue"

SortOrder => Str

The sort order for the results. The default is Ascending.

Valid values are: "Ascending", "Descending"

StatusEquals => Str

List the candidates for the job and filter by status.

Valid values are: "Completed", "InProgress", "Failed", "Stopped", "Stopping"

SEE ALSO

This class forms part of Paws, documenting arguments for method ListCandidatesForAutoMLJob in Paws::SageMaker

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues