aws_sdk_sagemaker/client/
describe_auto_ml_job.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`DescribeAutoMLJob`](crate::operation::describe_auto_ml_job::builders::DescribeAutoMLJobFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`auto_ml_job_name(impl Into<String>)`](crate::operation::describe_auto_ml_job::builders::DescribeAutoMLJobFluentBuilder::auto_ml_job_name) / [`set_auto_ml_job_name(Option<String>)`](crate::operation::describe_auto_ml_job::builders::DescribeAutoMLJobFluentBuilder::set_auto_ml_job_name):<br>required: **true**<br><p>Requests information about an AutoML job using its unique name.</p><br>
7    /// - On success, responds with [`DescribeAutoMlJobOutput`](crate::operation::describe_auto_ml_job::DescribeAutoMlJobOutput) with field(s):
8    ///   - [`auto_ml_job_name(Option<String>)`](crate::operation::describe_auto_ml_job::DescribeAutoMlJobOutput::auto_ml_job_name): <p>Returns the name of the AutoML job.</p>
9    ///   - [`auto_ml_job_arn(Option<String>)`](crate::operation::describe_auto_ml_job::DescribeAutoMlJobOutput::auto_ml_job_arn): <p>Returns the ARN of the AutoML job.</p>
10    ///   - [`input_data_config(Option<Vec::<AutoMlChannel>>)`](crate::operation::describe_auto_ml_job::DescribeAutoMlJobOutput::input_data_config): <p>Returns the input data configuration for the AutoML job.</p>
11    ///   - [`output_data_config(Option<AutoMlOutputDataConfig>)`](crate::operation::describe_auto_ml_job::DescribeAutoMlJobOutput::output_data_config): <p>Returns the job's output data config.</p>
12    ///   - [`role_arn(Option<String>)`](crate::operation::describe_auto_ml_job::DescribeAutoMlJobOutput::role_arn): <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>
13    ///   - [`auto_ml_job_objective(Option<AutoMlJobObjective>)`](crate::operation::describe_auto_ml_job::DescribeAutoMlJobOutput::auto_ml_job_objective): <p>Returns the job's objective.</p>
14    ///   - [`problem_type(Option<ProblemType>)`](crate::operation::describe_auto_ml_job::DescribeAutoMlJobOutput::problem_type): <p>Returns the job's problem type.</p>
15    ///   - [`auto_ml_job_config(Option<AutoMlJobConfig>)`](crate::operation::describe_auto_ml_job::DescribeAutoMlJobOutput::auto_ml_job_config): <p>Returns the configuration for the AutoML job.</p>
16    ///   - [`creation_time(Option<DateTime>)`](crate::operation::describe_auto_ml_job::DescribeAutoMlJobOutput::creation_time): <p>Returns the creation time of the AutoML job.</p>
17    ///   - [`end_time(Option<DateTime>)`](crate::operation::describe_auto_ml_job::DescribeAutoMlJobOutput::end_time): <p>Returns the end time of the AutoML job.</p>
18    ///   - [`last_modified_time(Option<DateTime>)`](crate::operation::describe_auto_ml_job::DescribeAutoMlJobOutput::last_modified_time): <p>Returns the job's last modified time.</p>
19    ///   - [`failure_reason(Option<String>)`](crate::operation::describe_auto_ml_job::DescribeAutoMlJobOutput::failure_reason): <p>Returns the failure reason for an AutoML job, when applicable.</p>
20    ///   - [`partial_failure_reasons(Option<Vec::<AutoMlPartialFailureReason>>)`](crate::operation::describe_auto_ml_job::DescribeAutoMlJobOutput::partial_failure_reasons): <p>Returns a list of reasons for partial failures within an AutoML job.</p>
21    ///   - [`best_candidate(Option<AutoMlCandidate>)`](crate::operation::describe_auto_ml_job::DescribeAutoMlJobOutput::best_candidate): <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>
22    ///   - [`auto_ml_job_status(Option<AutoMlJobStatus>)`](crate::operation::describe_auto_ml_job::DescribeAutoMlJobOutput::auto_ml_job_status): <p>Returns the status of the AutoML job.</p>
23    ///   - [`auto_ml_job_secondary_status(Option<AutoMlJobSecondaryStatus>)`](crate::operation::describe_auto_ml_job::DescribeAutoMlJobOutput::auto_ml_job_secondary_status): <p>Returns the secondary status of the AutoML job.</p>
24    ///   - [`generate_candidate_definitions_only(Option<bool>)`](crate::operation::describe_auto_ml_job::DescribeAutoMlJobOutput::generate_candidate_definitions_only): <p>Indicates whether the output for an AutoML job generates candidate definitions only.</p>
25    ///   - [`auto_ml_job_artifacts(Option<AutoMlJobArtifacts>)`](crate::operation::describe_auto_ml_job::DescribeAutoMlJobOutput::auto_ml_job_artifacts): <p>Returns information on the job's artifacts found in <code>AutoMLJobArtifacts</code>.</p>
26    ///   - [`resolved_attributes(Option<ResolvedAttributes>)`](crate::operation::describe_auto_ml_job::DescribeAutoMlJobOutput::resolved_attributes): <p>Contains <code>ProblemType</code>, <code>AutoMLJobObjective</code>, and <code>CompletionCriteria</code>. If you do not provide these values, they are inferred.</p>
27    ///   - [`model_deploy_config(Option<ModelDeployConfig>)`](crate::operation::describe_auto_ml_job::DescribeAutoMlJobOutput::model_deploy_config): <p>Indicates whether the model was deployed automatically to an endpoint and the name of that endpoint if deployed automatically.</p>
28    ///   - [`model_deploy_result(Option<ModelDeployResult>)`](crate::operation::describe_auto_ml_job::DescribeAutoMlJobOutput::model_deploy_result): <p>Provides information about endpoint for the model deployment.</p>
29    /// - On failure, responds with [`SdkError<DescribeAutoMLJobError>`](crate::operation::describe_auto_ml_job::DescribeAutoMLJobError)
30    pub fn describe_auto_ml_job(&self) -> crate::operation::describe_auto_ml_job::builders::DescribeAutoMLJobFluentBuilder {
31        crate::operation::describe_auto_ml_job::builders::DescribeAutoMLJobFluentBuilder::new(self.handle.clone())
32    }
33}
aws_sdk_sagemaker/client/describe_auto_ml_job.rs

aws_sdk_sagemaker/client/
describe_auto_ml_job.rs
