DescribeAutoMLJob - Amazon SageMaker Service

DescribeAutoMLJob

Returns information about an Amazon SageMaker job.

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

Request information about a job using that job's unique name.

Type: String

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

Pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9])*

Required: Yes

Response Syntax

{ "AutoMLJobArn": "string", "AutoMLJobArtifacts": { "CandidateDefinitionNotebookLocation": "string", "DataExplorationNotebookLocation": "string" }, "AutoMLJobConfig": { "CompletionCriteria": { "MaxAutoMLJobRuntimeInSeconds": number, "MaxCandidates": number, "MaxRuntimePerTrainingJobInSeconds": number }, "SecurityConfig": { "EnableInterContainerTrafficEncryption": boolean, "VolumeKmsKeyId": "string", "VpcConfig": { "SecurityGroupIds": [ "string" ], "Subnets": [ "string" ] } } }, "AutoMLJobName": "string", "AutoMLJobObjective": { "MetricName": "string" }, "AutoMLJobSecondaryStatus": "string", "AutoMLJobStatus": "string", "BestCandidate": { "CandidateName": "string", "CandidateStatus": "string", "CandidateSteps": [ { "CandidateStepArn": "string", "CandidateStepName": "string", "CandidateStepType": "string" } ], "CreationTime": number, "EndTime": number, "FailureReason": "string", "FinalAutoMLJobObjectiveMetric": { "MetricName": "string", "Type": "string", "Value": number }, "InferenceContainers": [ { "Environment": { "string" : "string" }, "Image": "string", "ModelDataUrl": "string" } ], "LastModifiedTime": number, "ObjectiveStatus": "string" }, "CreationTime": number, "EndTime": number, "FailureReason": "string", "GenerateCandidateDefinitionsOnly": boolean, "InputDataConfig": [ { "CompressionType": "string", "DataSource": { "S3DataSource": { "S3DataType": "string", "S3Uri": "string" } }, "TargetAttributeName": "string" } ], "LastModifiedTime": number, "OutputDataConfig": { "KmsKeyId": "string", "S3OutputPath": "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 job's ARN.

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 job's config.

Type: AutoMLJobConfig object

AutoMLJobName

Returns the name of a job.

Type: String

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

Pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9])*

AutoMLJobObjective

Returns the job's objective.

Type: AutoMLJobObjective object

AutoMLJobSecondaryStatus

Returns the job's AutoMLJobSecondaryStatus.

Type: String

Valid Values: Starting | AnalyzingData | FeatureEngineering | ModelTuning | MaxCandidatesReached | Failed | Stopped | MaxAutoMLJobRuntimeReached | Stopping | CandidateDefinitionsGenerated

AutoMLJobStatus

Returns the job's AutoMLJobStatus.

Type: String

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

BestCandidate

Returns the job's BestCandidate.

Type: AutoMLCandidate object

CreationTime

Returns the job's creation time.

Type: Timestamp

EndTime

Returns the job's end time.

Type: Timestamp

FailureReason

Returns the job's FailureReason.

Type: String

Length Constraints: Maximum length of 1024.

GenerateCandidateDefinitionsOnly

Returns the job's output from GenerateCandidateDefinitionsOnly.

Type: Boolean

InputDataConfig

Returns the job's input data config.

Type: Array of AutoMLChannel objects

Array Members: Minimum number of 1 item. Maximum number of 20 items.

LastModifiedTime

Returns the job's last modified time.

Type: Timestamp

OutputDataConfig

Returns the job's output data config.

Type: AutoMLOutputDataConfig object

ProblemType

Returns the job's problem type.

Type: String

Valid Values: BinaryClassification | MulticlassClassification | Regression

ResolvedAttributes

This contains ProblemType, AutoMLJobObjective and CompletionCriteria. They're auto-inferred values, if not provided by you. If you do provide them, then they'll be the same as provided.

Type: ResolvedAttributes object

RoleArn

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (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: