Skip to content

DescribeAutoMLJobResponse

Source code in docs_src/capo_sagemaker/types/describe_auto_ml_job_response.py
class DescribeAutoMLJobResponse(TypedDict, closed=True):
    auto_ml_job_name: NotRequired["capo_sagemaker.types.auto_ml_job_name.AutoMLJobName"]
    """<p>Returns the name of the AutoML job.</p>"""
    auto_ml_job_arn: NotRequired["capo_sagemaker.types.auto_ml_job_arn.AutoMLJobArn"]
    """<p>Returns the ARN of the AutoML job.</p>"""
    input_data_config: NotRequired[
        "capo_sagemaker.types.auto_ml_input_data_config.AutoMLInputDataConfig"
    ]
    """<p>Returns the input data configuration for the AutoML job.</p>"""
    output_data_config: NotRequired[
        "capo_sagemaker.types.auto_ml_output_data_config.AutoMLOutputDataConfig"
    ]
    """<p>Returns the job's output data config.</p>"""
    role_arn: NotRequired["capo_sagemaker.types.role_arn.RoleArn"]
    """<p>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.</p>"""
    auto_ml_job_objective: NotRequired[
        "capo_sagemaker.types.auto_ml_job_objective.AutoMLJobObjective"
    ]
    """<p>Returns the job's objective.</p>"""
    problem_type: NotRequired["capo_sagemaker.types.problem_type.ProblemType"]
    """<p>Returns the job's problem type.</p>"""
    auto_ml_job_config: NotRequired[
        "capo_sagemaker.types.auto_ml_job_config.AutoMLJobConfig"
    ]
    """<p>Returns the configuration for the AutoML job.</p>"""
    creation_time: NotRequired["capo_sagemaker.types.timestamp.Timestamp"]
    """<p>Returns the creation time of the AutoML job.</p>"""
    end_time: NotRequired["capo_sagemaker.types.timestamp.Timestamp"]
    """<p>Returns the end time of the AutoML job.</p>"""
    last_modified_time: NotRequired["capo_sagemaker.types.timestamp.Timestamp"]
    """<p>Returns the job's last modified time.</p>"""
    failure_reason: NotRequired[
        "capo_sagemaker.types.auto_ml_failure_reason.AutoMLFailureReason"
    ]
    """<p>Returns the failure reason for an AutoML job, when applicable.</p>"""
    partial_failure_reasons: NotRequired[
        "capo_sagemaker.types.auto_ml_partial_failure_reasons.AutoMLPartialFailureReasons"
    ]
    """<p>Returns a list of reasons for partial failures within an AutoML job.</p>"""
    best_candidate: NotRequired[
        "capo_sagemaker.types.auto_ml_candidate.AutoMLCandidate"
    ]
    """<p>The best model candidate selected by SageMaker AI Autopilot using both the best objective metric and lowest <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/autopilot-metrics-validation.html">InferenceLatency</a> for an experiment.</p>"""
    auto_ml_job_status: NotRequired[
        "capo_sagemaker.types.auto_ml_job_status.AutoMLJobStatus"
    ]
    """<p>Returns the status of the AutoML job.</p>"""
    auto_ml_job_secondary_status: NotRequired[
        "capo_sagemaker.types.auto_ml_job_secondary_status.AutoMLJobSecondaryStatus"
    ]
    """<p>Returns the secondary status of the AutoML job.</p>"""
    generate_candidate_definitions_only: NotRequired[
        "capo_sagemaker.types.generate_candidate_definitions_only.GenerateCandidateDefinitionsOnly"
    ]
    """<p>Indicates whether the output for an AutoML job generates candidate definitions only.</p>"""
    auto_ml_job_artifacts: NotRequired[
        "capo_sagemaker.types.auto_ml_job_artifacts.AutoMLJobArtifacts"
    ]
    """<p>Returns information on the job's artifacts found in <code>AutoMLJobArtifacts</code>.</p>"""
    resolved_attributes: NotRequired[
        "capo_sagemaker.types.resolved_attributes.ResolvedAttributes"
    ]
    """<p>Contains <code>ProblemType</code>, <code>AutoMLJobObjective</code>, and <code>CompletionCriteria</code>. If you do not provide these values, they are inferred.</p>"""
    model_deploy_config: NotRequired[
        "capo_sagemaker.types.model_deploy_config.ModelDeployConfig"
    ]
    """<p>Indicates whether the model was deployed automatically to an endpoint and the name of that endpoint if deployed automatically.</p>"""
    model_deploy_result: NotRequired[
        "capo_sagemaker.types.model_deploy_result.ModelDeployResult"
    ]
    """<p>Provides information about endpoint for the model deployment.</p>"""

auto_ml_job_arn instance-attribute

auto_ml_job_arn: NotRequired[AutoMLJobArn]

Returns the ARN of the AutoML job.

auto_ml_job_artifacts instance-attribute

auto_ml_job_artifacts: NotRequired[AutoMLJobArtifacts]

Returns information on the job's artifacts found in AutoMLJobArtifacts.

auto_ml_job_config instance-attribute

auto_ml_job_config: NotRequired[AutoMLJobConfig]

Returns the configuration for the AutoML job.

auto_ml_job_name instance-attribute

auto_ml_job_name: NotRequired[AutoMLJobName]

Returns the name of the AutoML job.

auto_ml_job_objective instance-attribute

auto_ml_job_objective: NotRequired[AutoMLJobObjective]

Returns the job's objective.

auto_ml_job_secondary_status instance-attribute

auto_ml_job_secondary_status: NotRequired[AutoMLJobSecondaryStatus]

Returns the secondary status of the AutoML job.

auto_ml_job_status instance-attribute

auto_ml_job_status: NotRequired[AutoMLJobStatus]

Returns the status of the AutoML job.

best_candidate instance-attribute

best_candidate: NotRequired[AutoMLCandidate]

The best model candidate selected by SageMaker AI Autopilot using both the best objective metric and lowest InferenceLatency for an experiment.

creation_time instance-attribute

creation_time: NotRequired[Timestamp]

Returns the creation time of the AutoML job.

end_time instance-attribute

end_time: NotRequired[Timestamp]

Returns the end time of the AutoML job.

failure_reason instance-attribute

failure_reason: NotRequired[AutoMLFailureReason]

Returns the failure reason for an AutoML job, when applicable.

generate_candidate_definitions_only instance-attribute

generate_candidate_definitions_only: NotRequired[GenerateCandidateDefinitionsOnly]

Indicates whether the output for an AutoML job generates candidate definitions only.

input_data_config instance-attribute

input_data_config: NotRequired[AutoMLInputDataConfig]

Returns the input data configuration for the AutoML job.

last_modified_time instance-attribute

last_modified_time: NotRequired[Timestamp]

Returns the job's last modified time.

model_deploy_config instance-attribute

model_deploy_config: NotRequired[ModelDeployConfig]

Indicates whether the model was deployed automatically to an endpoint and the name of that endpoint if deployed automatically.

model_deploy_result instance-attribute

model_deploy_result: NotRequired[ModelDeployResult]

Provides information about endpoint for the model deployment.

output_data_config instance-attribute

output_data_config: NotRequired[AutoMLOutputDataConfig]

Returns the job's output data config.

partial_failure_reasons instance-attribute

partial_failure_reasons: NotRequired[AutoMLPartialFailureReasons]

Returns a list of reasons for partial failures within an AutoML job.

problem_type instance-attribute

problem_type: NotRequired[ProblemType]

Returns the job's problem type.

resolved_attributes instance-attribute

resolved_attributes: NotRequired[ResolvedAttributes]

Contains ProblemType, AutoMLJobObjective, and CompletionCriteria. If you do not provide these values, they are inferred.

role_arn instance-attribute

role_arn: NotRequired[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.