aws_sdk_customerprofiles/client/
get_recommender.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 [`GetRecommender`](crate::operation::get_recommender::builders::GetRecommenderFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`domain_name(impl Into<String>)`](crate::operation::get_recommender::builders::GetRecommenderFluentBuilder::domain_name) / [`set_domain_name(Option<String>)`](crate::operation::get_recommender::builders::GetRecommenderFluentBuilder::set_domain_name):<br>required: **true**<br><p>The unique name of the domain.</p><br>
7    ///   - [`recommender_name(impl Into<String>)`](crate::operation::get_recommender::builders::GetRecommenderFluentBuilder::recommender_name) / [`set_recommender_name(Option<String>)`](crate::operation::get_recommender::builders::GetRecommenderFluentBuilder::set_recommender_name):<br>required: **true**<br><p>The name of the recommender.</p><br>
8    ///   - [`training_metrics_count(i32)`](crate::operation::get_recommender::builders::GetRecommenderFluentBuilder::training_metrics_count) / [`set_training_metrics_count(Option<i32>)`](crate::operation::get_recommender::builders::GetRecommenderFluentBuilder::set_training_metrics_count):<br>required: **false**<br><p>The number of training metrics to retrieve for the recommender.</p><br>
9    /// - On success, responds with [`GetRecommenderOutput`](crate::operation::get_recommender::GetRecommenderOutput) with field(s):
10    ///   - [`recommender_name(String)`](crate::operation::get_recommender::GetRecommenderOutput::recommender_name): <p>The name of the recommender.</p>
11    ///   - [`recommender_recipe_name(RecommenderRecipeName)`](crate::operation::get_recommender::GetRecommenderOutput::recommender_recipe_name): <p>The name of the recipe used by the recommender to generate recommendations.</p>
12    ///   - [`recommender_config(Option<RecommenderConfig>)`](crate::operation::get_recommender::GetRecommenderOutput::recommender_config): <p>The configuration settings for the recommender, including parameters and settings that define its behavior.</p>
13    ///   - [`description(Option<String>)`](crate::operation::get_recommender::GetRecommenderOutput::description): <p>A detailed description of the recommender providing information about its purpose and functionality.</p>
14    ///   - [`status(Option<RecommenderStatus>)`](crate::operation::get_recommender::GetRecommenderOutput::status): <p>The current status of the recommender, indicating whether it is active, creating, updating, or in another state.</p>
15    ///   - [`last_updated_at(Option<DateTime>)`](crate::operation::get_recommender::GetRecommenderOutput::last_updated_at): <p>The timestamp of when the recommender was edited.</p>
16    ///   - [`created_at(Option<DateTime>)`](crate::operation::get_recommender::GetRecommenderOutput::created_at): <p>The timestamp of when the recommender was created.</p>
17    ///   - [`failure_reason(Option<String>)`](crate::operation::get_recommender::GetRecommenderOutput::failure_reason): <p>If the recommender fails, provides the reason for the failure.</p>
18    ///   - [`latest_recommender_update(Option<RecommenderUpdate>)`](crate::operation::get_recommender::GetRecommenderOutput::latest_recommender_update): <p>Information about the most recent update performed on the recommender, including status and timestamp.</p>
19    ///   - [`training_metrics(Option<Vec::<TrainingMetrics>>)`](crate::operation::get_recommender::GetRecommenderOutput::training_metrics): <p>A set of metrics that provide information about the recommender's training performance and accuracy.</p>
20    ///   - [`tags(Option<HashMap::<String, String>>)`](crate::operation::get_recommender::GetRecommenderOutput::tags): <p>The tags used to organize, track, or control access for this resource.</p>
21    /// - On failure, responds with [`SdkError<GetRecommenderError>`](crate::operation::get_recommender::GetRecommenderError)
22    pub fn get_recommender(&self) -> crate::operation::get_recommender::builders::GetRecommenderFluentBuilder {
23        crate::operation::get_recommender::builders::GetRecommenderFluentBuilder::new(self.handle.clone())
24    }
25}