AutoMLCandidate - Amazon SageMaker
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China.

AutoMLCandidate

Information about a candidate produced by an AutoML training job, including its status, steps, and other properties.

Contents

CandidateName

The name of the candidate.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Required: Yes

CandidateProperties

The properties of an AutoML candidate job.

Type: CandidateProperties object

Required: No

CandidateStatus

The candidate's status.

Type: String

Valid Values: Completed | InProgress | Failed | Stopped | Stopping

Required: Yes

CandidateSteps

Information about the candidate's steps.

Type: Array of AutoMLCandidateStep objects

Required: Yes

CreationTime

The creation time.

Type: Timestamp

Required: Yes

EndTime

The end time.

Type: Timestamp

Required: No

FailureReason

The failure reason.

Type: String

Length Constraints: Maximum length of 1024.

Required: No

FinalAutoMLJobObjectiveMetric

The best candidate result from an AutoML training job.

Type: FinalAutoMLJobObjectiveMetric object

Required: No

InferenceContainers

Information about the inference container definitions.

Type: Array of AutoMLContainerDefinition objects

Array Members: Maximum number of 5 items.

Required: No

LastModifiedTime

The last modified time.

Type: Timestamp

Required: Yes

ObjectiveStatus

The objective's status.

Type: String

Valid Values: Succeeded | Pending | Failed

Required: Yes

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: