aws_sdk_sagemaker/client/
describe_inference_recommendations_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 [`DescribeInferenceRecommendationsJob`](crate::operation::describe_inference_recommendations_job::builders::DescribeInferenceRecommendationsJobFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`job_name(impl Into<String>)`](crate::operation::describe_inference_recommendations_job::builders::DescribeInferenceRecommendationsJobFluentBuilder::job_name) / [`set_job_name(Option<String>)`](crate::operation::describe_inference_recommendations_job::builders::DescribeInferenceRecommendationsJobFluentBuilder::set_job_name):<br>required: **true**<br><p>The name of the job. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.</p><br>
7    /// - On success, responds with [`DescribeInferenceRecommendationsJobOutput`](crate::operation::describe_inference_recommendations_job::DescribeInferenceRecommendationsJobOutput) with field(s):
8    ///   - [`job_name(Option<String>)`](crate::operation::describe_inference_recommendations_job::DescribeInferenceRecommendationsJobOutput::job_name): <p>The name of the job. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.</p>
9    ///   - [`job_description(Option<String>)`](crate::operation::describe_inference_recommendations_job::DescribeInferenceRecommendationsJobOutput::job_description): <p>The job description that you provided when you initiated the job.</p>
10    ///   - [`job_type(Option<RecommendationJobType>)`](crate::operation::describe_inference_recommendations_job::DescribeInferenceRecommendationsJobOutput::job_type): <p>The job type that you provided when you initiated the job.</p>
11    ///   - [`job_arn(Option<String>)`](crate::operation::describe_inference_recommendations_job::DescribeInferenceRecommendationsJobOutput::job_arn): <p>The Amazon Resource Name (ARN) of the job.</p>
12    ///   - [`role_arn(Option<String>)`](crate::operation::describe_inference_recommendations_job::DescribeInferenceRecommendationsJobOutput::role_arn): <p>The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role you provided when you initiated the job.</p>
13    ///   - [`status(Option<RecommendationJobStatus>)`](crate::operation::describe_inference_recommendations_job::DescribeInferenceRecommendationsJobOutput::status): <p>The status of the job.</p>
14    ///   - [`creation_time(Option<DateTime>)`](crate::operation::describe_inference_recommendations_job::DescribeInferenceRecommendationsJobOutput::creation_time): <p>A timestamp that shows when the job was created.</p>
15    ///   - [`completion_time(Option<DateTime>)`](crate::operation::describe_inference_recommendations_job::DescribeInferenceRecommendationsJobOutput::completion_time): <p>A timestamp that shows when the job completed.</p>
16    ///   - [`last_modified_time(Option<DateTime>)`](crate::operation::describe_inference_recommendations_job::DescribeInferenceRecommendationsJobOutput::last_modified_time): <p>A timestamp that shows when the job was last modified.</p>
17    ///   - [`failure_reason(Option<String>)`](crate::operation::describe_inference_recommendations_job::DescribeInferenceRecommendationsJobOutput::failure_reason): <p>If the job fails, provides information why the job failed.</p>
18    ///   - [`input_config(Option<RecommendationJobInputConfig>)`](crate::operation::describe_inference_recommendations_job::DescribeInferenceRecommendationsJobOutput::input_config): <p>Returns information about the versioned model package Amazon Resource Name (ARN), the traffic pattern, and endpoint configurations you provided when you initiated the job.</p>
19    ///   - [`stopping_conditions(Option<RecommendationJobStoppingConditions>)`](crate::operation::describe_inference_recommendations_job::DescribeInferenceRecommendationsJobOutput::stopping_conditions): <p>The stopping conditions that you provided when you initiated the job.</p>
20    ///   - [`inference_recommendations(Option<Vec::<InferenceRecommendation>>)`](crate::operation::describe_inference_recommendations_job::DescribeInferenceRecommendationsJobOutput::inference_recommendations): <p>The recommendations made by Inference Recommender.</p>
21    ///   - [`endpoint_performances(Option<Vec::<EndpointPerformance>>)`](crate::operation::describe_inference_recommendations_job::DescribeInferenceRecommendationsJobOutput::endpoint_performances): <p>The performance results from running an Inference Recommender job on an existing endpoint.</p>
22    /// - On failure, responds with [`SdkError<DescribeInferenceRecommendationsJobError>`](crate::operation::describe_inference_recommendations_job::DescribeInferenceRecommendationsJobError)
23    pub fn describe_inference_recommendations_job(
24        &self,
25    ) -> crate::operation::describe_inference_recommendations_job::builders::DescribeInferenceRecommendationsJobFluentBuilder {
26        crate::operation::describe_inference_recommendations_job::builders::DescribeInferenceRecommendationsJobFluentBuilder::new(self.handle.clone())
27    }
28}
aws_sdk_sagemaker/client/describe_inference_recommendations_job.rs

aws_sdk_sagemaker/client/
describe_inference_recommendations_job.rs
