DescribeAutoMLJobV2
Returns information about an AutoML job created by calling CreateAutoMLJobV2 or CreateAutoMLJob.
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 V2 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
{ "AutoMLComputeConfig": { "EmrServerlessComputeConfig": { "ExecutionRoleARN": "string" } }, "AutoMLJobArn": "string", "AutoMLJobArtifacts": { "CandidateDefinitionNotebookLocation": "string", "DataExplorationNotebookLocation": "string" }, "AutoMLJobInputDataConfig": [ { "ChannelType": "string", "CompressionType": "string", "ContentType": "string", "DataSource": { "S3DataSource": { "S3DataType": "string", "S3Uri": "string" } } } ], "AutoMLJobName": "string", "AutoMLJobObjective": { "MetricName": "string" }, "AutoMLJobSecondaryStatus": "string", "AutoMLJobStatus": "string", "AutoMLProblemTypeConfig": { ... }, "AutoMLProblemTypeConfigName": "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, "DataSplitConfig": { "ValidationFraction": number }, "EndTime": number, "FailureReason": "string", "LastModifiedTime": number, "ModelDeployConfig": { "AutoGenerateEndpointName": boolean, "EndpointName": "string" }, "ModelDeployResult": { "EndpointName": "string" }, "OutputDataConfig": { "KmsKeyId": "string", "S3OutputPath": "string" }, "PartialFailureReasons": [ { "PartialFailureMessage": "string" } ], "ResolvedAttributes": { "AutoMLJobObjective": { "MetricName": "string" }, "AutoMLProblemTypeResolvedAttributes": { ... }, "CompletionCriteria": { "MaxAutoMLJobRuntimeInSeconds": number, "MaxCandidates": number, "MaxRuntimePerTrainingJobInSeconds": number } }, "RoleArn": "string", "SecurityConfig": { "EnableInterContainerTrafficEncryption": boolean, "VolumeKmsKeyId": "string", "VpcConfig": { "SecurityGroupIds": [ "string" ], "Subnets": [ "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.
- AutoMLComputeConfig
-
The compute configuration used for the AutoML job V2.
Type: AutoMLComputeConfig object
- AutoMLJobArn
-
Returns the Amazon Resource Name (ARN) of the AutoML job V2.
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
-
The artifacts that are generated during an AutoML job.
Type: AutoMLJobArtifacts object
- AutoMLJobInputDataConfig
-
Returns an array of channel objects describing the input data and their location.
Type: Array of AutoMLJobChannel objects
Array Members: Minimum number of 1 item. Maximum number of 2 items.
- AutoMLJobName
-
Returns the name of the AutoML job V2.
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 V2.
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 V2.
Type: String
Valid Values:
Completed | InProgress | Failed | Stopped | Stopping - AutoMLProblemTypeConfig
-
Returns the configuration settings of the problem type set for the AutoML job V2.
Type: AutoMLProblemTypeConfig object
Note: This object is a Union. Only one member of this object can be specified or returned.
- AutoMLProblemTypeConfigName
-
Returns the name of the problem type configuration set for the AutoML job V2.
Type: String
Valid Values:
ImageClassification | TextClassification | TimeSeriesForecasting | Tabular | TextGeneration - BestCandidate
-
Information about the candidate produced by an AutoML training job V2, including its status, steps, and other properties.
Type: AutoMLCandidate object
- CreationTime
-
Returns the creation time of the AutoML job V2.
Type: Timestamp
- DataSplitConfig
-
Returns the configuration settings of how the data are split into train and validation datasets.
Type: AutoMLDataSplitConfig object
- EndTime
-
Returns the end time of the AutoML job V2.
Type: Timestamp
- FailureReason
-
Returns the reason for the failure of the AutoML job V2, when applicable.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1024.
- 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 V2.
Type: Array of AutoMLPartialFailureReason objects
Array Members: Minimum number of 1 item. Maximum number of 5 items.
- ResolvedAttributes
-
Returns the resolved attributes used by the AutoML job V2.
Type: AutoMLResolvedAttributes 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+=,.@\-_/]+ - SecurityConfig
-
Returns the security configuration for traffic encryption or Amazon VPC settings.
Type: AutoMLSecurityConfig object
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: