aws_sdk_sagemaker/client/

describe_auto_ml_job_v2.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`DescribeAutoMLJobV2`](crate::operation::describe_auto_ml_job_v2::builders::DescribeAutoMLJobV2FluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`auto_ml_job_name(impl Into<String>)`](crate::operation::describe_auto_ml_job_v2::builders::DescribeAutoMLJobV2FluentBuilder::auto_ml_job_name) / [`set_auto_ml_job_name(Option<String>)`](crate::operation::describe_auto_ml_job_v2::builders::DescribeAutoMLJobV2FluentBuilder::set_auto_ml_job_name):<br>required: **true**<br><p>Requests information about an AutoML job V2 using its unique name.</p><br>
    /// - On success, responds with [`DescribeAutoMlJobV2Output`](crate::operation::describe_auto_ml_job_v2::DescribeAutoMlJobV2Output) with field(s):
    ///   - [`auto_ml_job_name(Option<String>)`](crate::operation::describe_auto_ml_job_v2::DescribeAutoMlJobV2Output::auto_ml_job_name): <p>Returns the name of the AutoML job V2.</p>
    ///   - [`auto_ml_job_arn(Option<String>)`](crate::operation::describe_auto_ml_job_v2::DescribeAutoMlJobV2Output::auto_ml_job_arn): <p>Returns the Amazon Resource Name (ARN) of the AutoML job V2.</p>
    ///   - [`auto_ml_job_input_data_config(Option<Vec::<AutoMlJobChannel>>)`](crate::operation::describe_auto_ml_job_v2::DescribeAutoMlJobV2Output::auto_ml_job_input_data_config): <p>Returns an array of channel objects describing the input data and their location.</p>
    ///   - [`output_data_config(Option<AutoMlOutputDataConfig>)`](crate::operation::describe_auto_ml_job_v2::DescribeAutoMlJobV2Output::output_data_config): <p>Returns the job's output data config.</p>
    ///   - [`role_arn(Option<String>)`](crate::operation::describe_auto_ml_job_v2::DescribeAutoMlJobV2Output::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>
    ///   - [`auto_ml_job_objective(Option<AutoMlJobObjective>)`](crate::operation::describe_auto_ml_job_v2::DescribeAutoMlJobV2Output::auto_ml_job_objective): <p>Returns the job's objective.</p>
    ///   - [`auto_ml_problem_type_config(Option<AutoMlProblemTypeConfig>)`](crate::operation::describe_auto_ml_job_v2::DescribeAutoMlJobV2Output::auto_ml_problem_type_config): <p>Returns the configuration settings of the problem type set for the AutoML job V2.</p>
    ///   - [`auto_ml_problem_type_config_name(Option<AutoMlProblemTypeConfigName>)`](crate::operation::describe_auto_ml_job_v2::DescribeAutoMlJobV2Output::auto_ml_problem_type_config_name): <p>Returns the name of the problem type configuration set for the AutoML job V2.</p>
    ///   - [`creation_time(Option<DateTime>)`](crate::operation::describe_auto_ml_job_v2::DescribeAutoMlJobV2Output::creation_time): <p>Returns the creation time of the AutoML job V2.</p>
    ///   - [`end_time(Option<DateTime>)`](crate::operation::describe_auto_ml_job_v2::DescribeAutoMlJobV2Output::end_time): <p>Returns the end time of the AutoML job V2.</p>
    ///   - [`last_modified_time(Option<DateTime>)`](crate::operation::describe_auto_ml_job_v2::DescribeAutoMlJobV2Output::last_modified_time): <p>Returns the job's last modified time.</p>
    ///   - [`failure_reason(Option<String>)`](crate::operation::describe_auto_ml_job_v2::DescribeAutoMlJobV2Output::failure_reason): <p>Returns the reason for the failure of the AutoML job V2, when applicable.</p>
    ///   - [`partial_failure_reasons(Option<Vec::<AutoMlPartialFailureReason>>)`](crate::operation::describe_auto_ml_job_v2::DescribeAutoMlJobV2Output::partial_failure_reasons): <p>Returns a list of reasons for partial failures within an AutoML job V2.</p>
    ///   - [`best_candidate(Option<AutoMlCandidate>)`](crate::operation::describe_auto_ml_job_v2::DescribeAutoMlJobV2Output::best_candidate): <p>Information about the candidate produced by an AutoML training job V2, including its status, steps, and other properties.</p>
    ///   - [`auto_ml_job_status(Option<AutoMlJobStatus>)`](crate::operation::describe_auto_ml_job_v2::DescribeAutoMlJobV2Output::auto_ml_job_status): <p>Returns the status of the AutoML job V2.</p>
    ///   - [`auto_ml_job_secondary_status(Option<AutoMlJobSecondaryStatus>)`](crate::operation::describe_auto_ml_job_v2::DescribeAutoMlJobV2Output::auto_ml_job_secondary_status): <p>Returns the secondary status of the AutoML job V2.</p>
    ///   - [`auto_ml_job_artifacts(Option<AutoMlJobArtifacts>)`](crate::operation::describe_auto_ml_job_v2::DescribeAutoMlJobV2Output::auto_ml_job_artifacts): <p>The artifacts that are generated during an AutoML job.</p>
    ///   - [`resolved_attributes(Option<AutoMlResolvedAttributes>)`](crate::operation::describe_auto_ml_job_v2::DescribeAutoMlJobV2Output::resolved_attributes): <p>Returns the resolved attributes used by the AutoML job V2.</p>
    ///   - [`model_deploy_config(Option<ModelDeployConfig>)`](crate::operation::describe_auto_ml_job_v2::DescribeAutoMlJobV2Output::model_deploy_config): <p>Indicates whether the model was deployed automatically to an endpoint and the name of that endpoint if deployed automatically.</p>
    ///   - [`model_deploy_result(Option<ModelDeployResult>)`](crate::operation::describe_auto_ml_job_v2::DescribeAutoMlJobV2Output::model_deploy_result): <p>Provides information about endpoint for the model deployment.</p>
    ///   - [`data_split_config(Option<AutoMlDataSplitConfig>)`](crate::operation::describe_auto_ml_job_v2::DescribeAutoMlJobV2Output::data_split_config): <p>Returns the configuration settings of how the data are split into train and validation datasets.</p>
    ///   - [`security_config(Option<AutoMlSecurityConfig>)`](crate::operation::describe_auto_ml_job_v2::DescribeAutoMlJobV2Output::security_config): <p>Returns the security configuration for traffic encryption or Amazon VPC settings.</p>
    ///   - [`auto_ml_compute_config(Option<AutoMlComputeConfig>)`](crate::operation::describe_auto_ml_job_v2::DescribeAutoMlJobV2Output::auto_ml_compute_config): <p>The compute configuration used for the AutoML job V2.</p>
    /// - On failure, responds with [`SdkError<DescribeAutoMLJobV2Error>`](crate::operation::describe_auto_ml_job_v2::DescribeAutoMLJobV2Error)
    pub fn describe_auto_ml_job_v2(&self) -> crate::operation::describe_auto_ml_job_v2::builders::DescribeAutoMLJobV2FluentBuilder {
        crate::operation::describe_auto_ml_job_v2::builders::DescribeAutoMLJobV2FluentBuilder::new(self.handle.clone())
    }
}