aws_sdk_bedrockagentcore/client/
start_recommendation.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 [`StartRecommendation`](crate::operation::start_recommendation::builders::StartRecommendationFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`name(impl Into<String>)`](crate::operation::start_recommendation::builders::StartRecommendationFluentBuilder::name) / [`set_name(Option<String>)`](crate::operation::start_recommendation::builders::StartRecommendationFluentBuilder::set_name):<br>required: **true**<br><p>The name of the recommendation. Must be unique within your account.</p><br>
7    ///   - [`description(impl Into<String>)`](crate::operation::start_recommendation::builders::StartRecommendationFluentBuilder::description) / [`set_description(Option<String>)`](crate::operation::start_recommendation::builders::StartRecommendationFluentBuilder::set_description):<br>required: **false**<br><p>The description of the recommendation.</p><br>
8    ///   - [`r#type(RecommendationType)`](crate::operation::start_recommendation::builders::StartRecommendationFluentBuilder::type) / [`set_type(Option<RecommendationType>)`](crate::operation::start_recommendation::builders::StartRecommendationFluentBuilder::set_type):<br>required: **true**<br><p>The type of recommendation to generate. Valid values are <code>SYSTEM_PROMPT_RECOMMENDATION</code> for system prompt optimization or <code>TOOL_DESCRIPTION_RECOMMENDATION</code> for tool description optimization.</p><br>
9    ///   - [`recommendation_config(RecommendationConfig)`](crate::operation::start_recommendation::builders::StartRecommendationFluentBuilder::recommendation_config) / [`set_recommendation_config(Option<RecommendationConfig>)`](crate::operation::start_recommendation::builders::StartRecommendationFluentBuilder::set_recommendation_config):<br>required: **true**<br><p>The configuration for the recommendation, including the input to optimize, agent traces to analyze, and evaluation settings.</p><br>
10    ///   - [`kms_key_arn(impl Into<String>)`](crate::operation::start_recommendation::builders::StartRecommendationFluentBuilder::kms_key_arn) / [`set_kms_key_arn(Option<String>)`](crate::operation::start_recommendation::builders::StartRecommendationFluentBuilder::set_kms_key_arn):<br>required: **false**<br><p>The ARN of the KMS key used to encrypt recommendation data. If provided, customer data is encrypted at rest with the specified key.</p><br>
11    ///   - [`client_token(impl Into<String>)`](crate::operation::start_recommendation::builders::StartRecommendationFluentBuilder::client_token) / [`set_client_token(Option<String>)`](crate::operation::start_recommendation::builders::StartRecommendationFluentBuilder::set_client_token):<br>required: **false**<br><p>A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, the service ignores the request, but does not return an error.</p><br>
12    ///   - [`tags(impl Into<String>, impl Into<String>)`](crate::operation::start_recommendation::builders::StartRecommendationFluentBuilder::tags) / [`set_tags(Option<HashMap::<String, String>>)`](crate::operation::start_recommendation::builders::StartRecommendationFluentBuilder::set_tags):<br>required: **false**<br><p>A map of tag keys and values to associate with the recommendation.</p><br>
13    /// - On success, responds with [`StartRecommendationOutput`](crate::operation::start_recommendation::StartRecommendationOutput) with field(s):
14    ///   - [`recommendation_id(String)`](crate::operation::start_recommendation::StartRecommendationOutput::recommendation_id): <p>The unique identifier of the created recommendation.</p>
15    ///   - [`recommendation_arn(String)`](crate::operation::start_recommendation::StartRecommendationOutput::recommendation_arn): <p>The Amazon Resource Name (ARN) of the created recommendation.</p>
16    ///   - [`name(String)`](crate::operation::start_recommendation::StartRecommendationOutput::name): <p>The name of the recommendation.</p>
17    ///   - [`description(Option<String>)`](crate::operation::start_recommendation::StartRecommendationOutput::description): <p>The description of the recommendation.</p>
18    ///   - [`r#type(RecommendationType)`](crate::operation::start_recommendation::StartRecommendationOutput::type): <p>The type of recommendation.</p>
19    ///   - [`recommendation_config(Option<RecommendationConfig>)`](crate::operation::start_recommendation::StartRecommendationOutput::recommendation_config): <p>The configuration for the recommendation.</p>
20    ///   - [`status(RecommendationStatus)`](crate::operation::start_recommendation::StartRecommendationOutput::status): <p>The status of the recommendation.</p>
21    ///   - [`created_at(DateTime)`](crate::operation::start_recommendation::StartRecommendationOutput::created_at): <p>The timestamp when the recommendation was created.</p>
22    ///   - [`updated_at(DateTime)`](crate::operation::start_recommendation::StartRecommendationOutput::updated_at): <p>The timestamp when the recommendation was last updated.</p>
23    /// - On failure, responds with [`SdkError<StartRecommendationError>`](crate::operation::start_recommendation::StartRecommendationError)
24    pub fn start_recommendation(&self) -> crate::operation::start_recommendation::builders::StartRecommendationFluentBuilder {
25        crate::operation::start_recommendation::builders::StartRecommendationFluentBuilder::new(self.handle.clone())
26    }
27}
aws_sdk_bedrockagentcore/client/start_recommendation.rs

aws_sdk_bedrockagentcore/client/
start_recommendation.rs
