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
- CandidateStatus
-
The candidate's status.
Type: String
Valid Values:
Completed | InProgress | Failed | Stopped | StoppingRequired: Yes
- CandidateSteps
-
Information about the candidate's steps.
Type: Array of AutoMLCandidateStep objects
Required: Yes
- CreationTime
-
The creation time.
Type: Timestamp
Required: Yes
- LastModifiedTime
-
The last modified time.
Type: Timestamp
Required: Yes
- ObjectiveStatus
-
The objective's status.
Type: String
Valid Values:
Succeeded | Pending | FailedRequired: Yes
- CandidateProperties
-
The properties of an AutoML candidate job.
Type: CandidateProperties object
Required: No
- 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
- InferenceContainerDefinitions
-
The mapping of all supported processing unit (CPU, GPU, etc...) to inference container definitions for the candidate. This field is populated for the V2 API only (for example, for jobs created by calling
CreateAutoMLJobV2).Type: String to array of AutoMLContainerDefinition objects map
Map Entries: Maximum number of 2 items.
Valid Keys:
CPU | GPUArray Members: Maximum number of 5 items.
Required: No
- InferenceContainers
-
Information about the recommended inference container definitions.
Type: Array of AutoMLContainerDefinition objects
Array Members: Maximum number of 5 items.
Required: No
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: