aws_sdk_qconnect/client/
get_recommendations.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 [`GetRecommendations`](crate::operation::get_recommendations::builders::GetRecommendationsFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`assistant_id(impl Into<String>)`](crate::operation::get_recommendations::builders::GetRecommendationsFluentBuilder::assistant_id) / [`set_assistant_id(Option<String>)`](crate::operation::get_recommendations::builders::GetRecommendationsFluentBuilder::set_assistant_id):<br>required: **true**<br><p>The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</p><br>
7    ///   - [`session_id(impl Into<String>)`](crate::operation::get_recommendations::builders::GetRecommendationsFluentBuilder::session_id) / [`set_session_id(Option<String>)`](crate::operation::get_recommendations::builders::GetRecommendationsFluentBuilder::set_session_id):<br>required: **true**<br><p>The identifier of the session. Can be either the ID or the ARN. URLs cannot contain the ARN.</p><br>
8    ///   - [`max_results(i32)`](crate::operation::get_recommendations::builders::GetRecommendationsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::get_recommendations::builders::GetRecommendationsFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of results to return per page.</p><br>
9    ///   - [`wait_time_seconds(i32)`](crate::operation::get_recommendations::builders::GetRecommendationsFluentBuilder::wait_time_seconds) / [`set_wait_time_seconds(Option<i32>)`](crate::operation::get_recommendations::builders::GetRecommendationsFluentBuilder::set_wait_time_seconds):<br>required: **false**<br><p>The duration (in seconds) for which the call waits for a recommendation to be made available before returning. If a recommendation is available, the call returns sooner than <code>WaitTimeSeconds</code>. If no messages are available and the wait time expires, the call returns successfully with an empty list.</p><br>
10    ///   - [`next_chunk_token(impl Into<String>)`](crate::operation::get_recommendations::builders::GetRecommendationsFluentBuilder::next_chunk_token) / [`set_next_chunk_token(Option<String>)`](crate::operation::get_recommendations::builders::GetRecommendationsFluentBuilder::set_next_chunk_token):<br>required: **false**<br><p>The token for the next set of chunks. Use the value returned in the previous response in the next request to retrieve the next set of chunks.</p><br>
11    /// - On success, responds with [`GetRecommendationsOutput`](crate::operation::get_recommendations::GetRecommendationsOutput) with field(s):
12    ///   - [`recommendations(Vec::<RecommendationData>)`](crate::operation::get_recommendations::GetRecommendationsOutput::recommendations): <p>The recommendations.</p>
13    ///   - [`triggers(Option<Vec::<RecommendationTrigger>>)`](crate::operation::get_recommendations::GetRecommendationsOutput::triggers): <p>The triggers corresponding to recommendations.</p>
14    /// - On failure, responds with [`SdkError<GetRecommendationsError>`](crate::operation::get_recommendations::GetRecommendationsError)
15    #[deprecated(
16        note = "GetRecommendations API will be discontinued starting June 1, 2024. To receive generative responses after March 1, 2024 you will need to create a new Assistant in the Connect console and integrate the Amazon Q in Connect JavaScript library (amazon-q-connectjs) into your applications."
17    )]
18    pub fn get_recommendations(&self) -> crate::operation::get_recommendations::builders::GetRecommendationsFluentBuilder {
19        crate::operation::get_recommendations::builders::GetRecommendationsFluentBuilder::new(self.handle.clone())
20    }
21}
aws_sdk_qconnect/client/get_recommendations.rs

aws_sdk_qconnect/client/
get_recommendations.rs
