aws_sdk_sagemaker/client/
describe_ai_recommendation_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 [`DescribeAIRecommendationJob`](crate::operation::describe_ai_recommendation_job::builders::DescribeAIRecommendationJobFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`ai_recommendation_job_name(impl Into<String>)`](crate::operation::describe_ai_recommendation_job::builders::DescribeAIRecommendationJobFluentBuilder::ai_recommendation_job_name) / [`set_ai_recommendation_job_name(Option<String>)`](crate::operation::describe_ai_recommendation_job::builders::DescribeAIRecommendationJobFluentBuilder::set_ai_recommendation_job_name):<br>required: **true**<br><p>The name of the AI recommendation job to describe.</p><br>
7    /// - On success, responds with [`DescribeAiRecommendationJobOutput`](crate::operation::describe_ai_recommendation_job::DescribeAiRecommendationJobOutput) with field(s):
8    ///   - [`ai_recommendation_job_name(Option<String>)`](crate::operation::describe_ai_recommendation_job::DescribeAiRecommendationJobOutput::ai_recommendation_job_name): <p>The name of the AI recommendation job.</p>
9    ///   - [`ai_recommendation_job_arn(Option<String>)`](crate::operation::describe_ai_recommendation_job::DescribeAiRecommendationJobOutput::ai_recommendation_job_arn): <p>The Amazon Resource Name (ARN) of the AI recommendation job.</p>
10    ///   - [`ai_recommendation_job_status(Option<AiRecommendationJobStatus>)`](crate::operation::describe_ai_recommendation_job::DescribeAiRecommendationJobOutput::ai_recommendation_job_status): <p>The status of the AI recommendation job.</p>
11    ///   - [`failure_reason(Option<String>)`](crate::operation::describe_ai_recommendation_job::DescribeAiRecommendationJobOutput::failure_reason): <p>If the recommendation job failed, the reason it failed.</p>
12    ///   - [`model_source(Option<AiModelSource>)`](crate::operation::describe_ai_recommendation_job::DescribeAiRecommendationJobOutput::model_source): <p>The source of the model that was analyzed.</p>
13    ///   - [`output_config(Option<AiRecommendationOutputResult>)`](crate::operation::describe_ai_recommendation_job::DescribeAiRecommendationJobOutput::output_config): <p>The output configuration for the recommendation job.</p>
14    ///   - [`inference_specification(Option<AiRecommendationInferenceSpecification>)`](crate::operation::describe_ai_recommendation_job::DescribeAiRecommendationJobOutput::inference_specification): <p>The inference framework configuration.</p>
15    ///   - [`ai_workload_config_identifier(Option<String>)`](crate::operation::describe_ai_recommendation_job::DescribeAiRecommendationJobOutput::ai_workload_config_identifier): <p>The name or Amazon Resource Name (ARN) of the AI workload configuration used for this recommendation job.</p>
16    ///   - [`optimize_model(Option<bool>)`](crate::operation::describe_ai_recommendation_job::DescribeAiRecommendationJobOutput::optimize_model): <p>Whether model optimization techniques were allowed.</p>
17    ///   - [`performance_target(Option<AiRecommendationPerformanceTarget>)`](crate::operation::describe_ai_recommendation_job::DescribeAiRecommendationJobOutput::performance_target): <p>The performance targets specified for the recommendation job.</p>
18    ///   - [`recommendations(Option<Vec::<AiRecommendation>>)`](crate::operation::describe_ai_recommendation_job::DescribeAiRecommendationJobOutput::recommendations): <p>The list of optimization recommendations generated by the job. Each recommendation includes optimization details, deployment configuration, expected performance metrics, and the associated benchmark job ARN.</p>
19    ///   - [`role_arn(Option<String>)`](crate::operation::describe_ai_recommendation_job::DescribeAiRecommendationJobOutput::role_arn): <p>The Amazon Resource Name (ARN) of the IAM role used by the recommendation job.</p>
20    ///   - [`compute_spec(Option<AiRecommendationComputeSpec>)`](crate::operation::describe_ai_recommendation_job::DescribeAiRecommendationJobOutput::compute_spec): <p>The compute resource specification for the recommendation job.</p>
21    ///   - [`creation_time(Option<DateTime>)`](crate::operation::describe_ai_recommendation_job::DescribeAiRecommendationJobOutput::creation_time): <p>A timestamp that indicates when the recommendation job was created.</p>
22    ///   - [`start_time(Option<DateTime>)`](crate::operation::describe_ai_recommendation_job::DescribeAiRecommendationJobOutput::start_time): <p>A timestamp that indicates when the recommendation job started running.</p>
23    ///   - [`end_time(Option<DateTime>)`](crate::operation::describe_ai_recommendation_job::DescribeAiRecommendationJobOutput::end_time): <p>A timestamp that indicates when the recommendation job completed.</p>
24    ///   - [`tags(Option<Vec::<Tag>>)`](crate::operation::describe_ai_recommendation_job::DescribeAiRecommendationJobOutput::tags): <p>The tags associated with the recommendation job.</p>
25    /// - On failure, responds with [`SdkError<DescribeAIRecommendationJobError>`](crate::operation::describe_ai_recommendation_job::DescribeAIRecommendationJobError)
26    pub fn describe_ai_recommendation_job(
27        &self,
28    ) -> crate::operation::describe_ai_recommendation_job::builders::DescribeAIRecommendationJobFluentBuilder {
29        crate::operation::describe_ai_recommendation_job::builders::DescribeAIRecommendationJobFluentBuilder::new(self.handle.clone())
30    }
31}
aws_sdk_sagemaker/client/describe_ai_recommendation_job.rs

aws_sdk_sagemaker/client/
describe_ai_recommendation_job.rs
