DescribeAutoMLJob
Returns information about an AutoML job created by calling CreateAutoMLJob.
Note
AutoML jobs created by calling CreateAutoMLJobV2 cannot be described by
DescribeAutoMLJob.
Request Syntax
{
"AutoMLJobName": "string"
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- AutoMLJobName
-
Requests information about an AutoML job using its unique name.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 32.
Pattern:
^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,31}Required: Yes
Response Syntax
{
"AutoMLJobArn": "string",
"AutoMLJobArtifacts": {
"CandidateDefinitionNotebookLocation": "string",
"DataExplorationNotebookLocation": "string"
},
"AutoMLJobConfig": {
"CandidateGenerationConfig": {
"AlgorithmsConfig": [
{
"AutoMLAlgorithms": [ "string" ]
}
],
"FeatureSpecificationS3Uri": "string"
},
"CompletionCriteria": {
"MaxAutoMLJobRuntimeInSeconds": number,
"MaxCandidates": number,
"MaxRuntimePerTrainingJobInSeconds": number
},
"DataSplitConfig": {
"ValidationFraction": number
},
"Mode": "string",
"SecurityConfig": {
"EnableInterContainerTrafficEncryption": boolean,
"VolumeKmsKeyId": "string",
"VpcConfig": {
"SecurityGroupIds": [ "string" ],
"Subnets": [ "string" ]
}
}
},
"AutoMLJobName": "string",
"AutoMLJobObjective": {
"MetricName": "string"
},
"AutoMLJobSecondaryStatus": "string",
"AutoMLJobStatus": "string",
"BestCandidate": {
"CandidateName": "string",
"CandidateProperties": {
"CandidateArtifactLocations": {
"BacktestResults": "string",
"Explainability": "string",
"ModelInsights": "string"
},
"CandidateMetrics": [
{
"MetricName": "string",
"Set": "string",
"StandardMetricName": "string",
"Value": number
}
]
},
"CandidateStatus": "string",
"CandidateSteps": [
{
"CandidateStepArn": "string",
"CandidateStepName": "string",
"CandidateStepType": "string"
}
],
"CreationTime": number,
"EndTime": number,
"FailureReason": "string",
"FinalAutoMLJobObjectiveMetric": {
"MetricName": "string",
"StandardMetricName": "string",
"Type": "string",
"Value": number
},
"InferenceContainerDefinitions": {
"string" : [
{
"Environment": {
"string" : "string"
},
"Image": "string",
"ModelDataUrl": "string"
}
]
},
"InferenceContainers": [
{
"Environment": {
"string" : "string"
},
"Image": "string",
"ModelDataUrl": "string"
}
],
"LastModifiedTime": number,
"ObjectiveStatus": "string"
},
"CreationTime": number,
"EndTime": number,
"FailureReason": "string",
"GenerateCandidateDefinitionsOnly": boolean,
"InputDataConfig": [
{
"ChannelType": "string",
"CompressionType": "string",
"ContentType": "string",
"DataSource": {
"S3DataSource": {
"S3DataType": "string",
"S3Uri": "string"
}
},
"SampleWeightAttributeName": "string",
"TargetAttributeName": "string"
}
],
"LastModifiedTime": number,
"ModelDeployConfig": {
"AutoGenerateEndpointName": boolean,
"EndpointName": "string"
},
"ModelDeployResult": {
"EndpointName": "string"
},
"OutputDataConfig": {
"KmsKeyId": "string",
"S3OutputPath": "string"
},
"PartialFailureReasons": [
{
"PartialFailureMessage": "string"
}
],
"ProblemType": "string",
"ResolvedAttributes": {
"AutoMLJobObjective": {
"MetricName": "string"
},
"CompletionCriteria": {
"MaxAutoMLJobRuntimeInSeconds": number,
"MaxCandidates": number,
"MaxRuntimePerTrainingJobInSeconds": number
},
"ProblemType": "string"
},
"RoleArn": "string"
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- AutoMLJobArn
-
Returns the ARN of the AutoML job.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:automl-job/.* - AutoMLJobArtifacts
-
Returns information on the job's artifacts found in
AutoMLJobArtifacts.Type: AutoMLJobArtifacts object
- AutoMLJobConfig
-
Returns the configuration for the AutoML job.
Type: AutoMLJobConfig object
- AutoMLJobName
-
Returns the name of the AutoML job.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 32.
Pattern:
^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,31} - AutoMLJobObjective
-
Returns the job's objective.
Type: AutoMLJobObjective object
- AutoMLJobSecondaryStatus
-
Returns the secondary status of the AutoML job.
Type: String
Valid Values:
Starting | MaxCandidatesReached | Failed | Stopped | MaxAutoMLJobRuntimeReached | Stopping | CandidateDefinitionsGenerated | Completed | ExplainabilityError | DeployingModel | ModelDeploymentError | GeneratingModelInsightsReport | ModelInsightsError | AnalyzingData | FeatureEngineering | ModelTuning | GeneratingExplainabilityReport | TrainingModels | PreTraining - AutoMLJobStatus
-
Returns the status of the AutoML job.
Type: String
Valid Values:
Completed | InProgress | Failed | Stopped | Stopping - BestCandidate
-
The best model candidate selected by SageMaker AI Autopilot using both the best objective metric and lowest InferenceLatency for an experiment.
Type: AutoMLCandidate object
- CreationTime
-
Returns the creation time of the AutoML job.
Type: Timestamp
- EndTime
-
Returns the end time of the AutoML job.
Type: Timestamp
- FailureReason
-
Returns the failure reason for an AutoML job, when applicable.
Type: String
Length Constraints: Maximum length of 1024.
- GenerateCandidateDefinitionsOnly
-
Indicates whether the output for an AutoML job generates candidate definitions only.
Type: Boolean
- InputDataConfig
-
Returns the input data configuration for the AutoML job.
Type: Array of AutoMLChannel objects
Array Members: Minimum number of 1 item. Maximum number of 2 items.
- LastModifiedTime
-
Returns the job's last modified time.
Type: Timestamp
- ModelDeployConfig
-
Indicates whether the model was deployed automatically to an endpoint and the name of that endpoint if deployed automatically.
Type: ModelDeployConfig object
- ModelDeployResult
-
Provides information about endpoint for the model deployment.
Type: ModelDeployResult object
- OutputDataConfig
-
Returns the job's output data config.
Type: AutoMLOutputDataConfig object
- PartialFailureReasons
-
Returns a list of reasons for partial failures within an AutoML job.
Type: Array of AutoMLPartialFailureReason objects
Array Members: Minimum number of 1 item. Maximum number of 5 items.
- ProblemType
-
Returns the job's problem type.
Type: String
Valid Values:
BinaryClassification | MulticlassClassification | Regression - ResolvedAttributes
-
Contains
ProblemType,AutoMLJobObjective, andCompletionCriteria. If you do not provide these values, they are inferred.Type: ResolvedAttributes object
- RoleArn
-
The ARN of the IAM role that has read permission to the input data location and write permission to the output data location in Amazon S3.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
Pattern:
^arn:aws[a-z\-]*:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+$
Errors
For information about the errors that are common to all actions, see Common Errors.
- ResourceNotFound
-
Resource being access is not found.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
