aws_sdk_lexmodelsv2/client/
describe_bot_analyzer_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 [`DescribeBotAnalyzerRecommendation`](crate::operation::describe_bot_analyzer_recommendation::builders::DescribeBotAnalyzerRecommendationFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::describe_bot_analyzer_recommendation::builders::DescribeBotAnalyzerRecommendationFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`bot_id(impl Into<String>)`](crate::operation::describe_bot_analyzer_recommendation::builders::DescribeBotAnalyzerRecommendationFluentBuilder::bot_id) / [`set_bot_id(Option<String>)`](crate::operation::describe_bot_analyzer_recommendation::builders::DescribeBotAnalyzerRecommendationFluentBuilder::set_bot_id):<br>required: **true**<br><p>The unique identifier of the bot.</p><br>
8    ///   - [`bot_analyzer_request_id(impl Into<String>)`](crate::operation::describe_bot_analyzer_recommendation::builders::DescribeBotAnalyzerRecommendationFluentBuilder::bot_analyzer_request_id) / [`set_bot_analyzer_request_id(Option<String>)`](crate::operation::describe_bot_analyzer_recommendation::builders::DescribeBotAnalyzerRecommendationFluentBuilder::set_bot_analyzer_request_id):<br>required: **true**<br><p>The unique identifier of the analysis request.</p><br>
9    ///   - [`next_token(impl Into<String>)`](crate::operation::describe_bot_analyzer_recommendation::builders::DescribeBotAnalyzerRecommendationFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::describe_bot_analyzer_recommendation::builders::DescribeBotAnalyzerRecommendationFluentBuilder::set_next_token):<br>required: **false**<br><p>If the response from a previous request was truncated, the <code>nextToken</code> value is used to retrieve the next page of recommendations.</p><br>
10    ///   - [`max_results(i32)`](crate::operation::describe_bot_analyzer_recommendation::builders::DescribeBotAnalyzerRecommendationFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::describe_bot_analyzer_recommendation::builders::DescribeBotAnalyzerRecommendationFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of recommendations to return in the response. The default is 5.</p><br>
11    /// - On success, responds with [`DescribeBotAnalyzerRecommendationOutput`](crate::operation::describe_bot_analyzer_recommendation::DescribeBotAnalyzerRecommendationOutput) with field(s):
12    ///   - [`bot_id(Option<String>)`](crate::operation::describe_bot_analyzer_recommendation::DescribeBotAnalyzerRecommendationOutput::bot_id): <p>The unique identifier of the bot.</p>
13    ///   - [`bot_version(Option<String>)`](crate::operation::describe_bot_analyzer_recommendation::DescribeBotAnalyzerRecommendationOutput::bot_version): <p>The version of the bot that was analyzed.</p>
14    ///   - [`locale_id(Option<String>)`](crate::operation::describe_bot_analyzer_recommendation::DescribeBotAnalyzerRecommendationOutput::locale_id): <p>The locale identifier of the bot locale that was analyzed.</p>
15    ///   - [`bot_analyzer_status(Option<BotAnalyzerStatus>)`](crate::operation::describe_bot_analyzer_recommendation::DescribeBotAnalyzerRecommendationOutput::bot_analyzer_status): <p>The current status of the analysis.</p> <p>Valid Values: <code>Processing | Available | Failed | Stopping | Stopped</code></p>
16    ///   - [`creation_date_time(Option<DateTime>)`](crate::operation::describe_bot_analyzer_recommendation::DescribeBotAnalyzerRecommendationOutput::creation_date_time): <p>The date and time when the analysis was initiated.</p>
17    ///   - [`bot_analyzer_recommendation_list(Option<Vec::<BotAnalyzerRecommendation>>)`](crate::operation::describe_bot_analyzer_recommendation::DescribeBotAnalyzerRecommendationOutput::bot_analyzer_recommendation_list): <p>A list of recommendations for optimizing your bot configuration. Each recommendation includes the issue location, priority, description, and proposed fix.</p>
18    ///   - [`next_token(Option<String>)`](crate::operation::describe_bot_analyzer_recommendation::DescribeBotAnalyzerRecommendationOutput::next_token): <p>If the response is truncated, this token can be used in a subsequent request to retrieve the next page of recommendations.</p>
19    /// - On failure, responds with [`SdkError<DescribeBotAnalyzerRecommendationError>`](crate::operation::describe_bot_analyzer_recommendation::DescribeBotAnalyzerRecommendationError)
20    pub fn describe_bot_analyzer_recommendation(
21        &self,
22    ) -> crate::operation::describe_bot_analyzer_recommendation::builders::DescribeBotAnalyzerRecommendationFluentBuilder {
23        crate::operation::describe_bot_analyzer_recommendation::builders::DescribeBotAnalyzerRecommendationFluentBuilder::new(self.handle.clone())
24    }
25}
aws_sdk_lexmodelsv2/client/describe_bot_analyzer_recommendation.rs

aws_sdk_lexmodelsv2/client/
describe_bot_analyzer_recommendation.rs
