Struct aws_sdk_qconnect::operation::get_recommendations::builders::GetRecommendationsFluentBuilder

pub struct GetRecommendationsFluentBuilder { /* private fields */ }

👎Deprecated: 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.

Fluent builder constructing a request to GetRecommendations.

Retrieves recommendations for the specified session. To avoid retrieving the same recommendations in subsequent calls, use NotifyRecommendationsReceived. This API supports long-polling behavior with the waitTimeSeconds parameter. Short poll is the default behavior and only returns recommendations already available. To perform a manual query against an assistant, use QueryAssistant.

Implementations

impl GetRecommendationsFluentBuilder

pub fn as_input(&self) -> &GetRecommendationsInputBuilder

Access the GetRecommendations as a reference.

pub async fn send( self ) -> Result<GetRecommendationsOutput, SdkError<GetRecommendationsError, HttpResponse>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn customize( self ) -> CustomizableOperation<GetRecommendationsOutput, GetRecommendationsError, Self>

Consumes this builder, creating a customizable operation that can be modified before being sent.

pub fn assistant_id(self, input: impl Into<String>) -> Self

The identifier of the Amazon Q assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

pub fn set_assistant_id(self, input: Option<String>) -> Self

The identifier of the Amazon Q assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

pub fn get_assistant_id(&self) -> &Option<String>

The identifier of the Amazon Q assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

pub fn session_id(self, input: impl Into<String>) -> Self

The identifier of the session. Can be either the ID or the ARN. URLs cannot contain the ARN.

pub fn set_session_id(self, input: Option<String>) -> Self

The identifier of the session. Can be either the ID or the ARN. URLs cannot contain the ARN.

pub fn get_session_id(&self) -> &Option<String>

The identifier of the session. Can be either the ID or the ARN. URLs cannot contain the ARN.

pub fn max_results(self, input: i32) -> Self

The maximum number of results to return per page.

pub fn set_max_results(self, input: Option<i32>) -> Self

The maximum number of results to return per page.

pub fn get_max_results(&self) -> &Option<i32>

The maximum number of results to return per page.

pub fn wait_time_seconds(self, input: i32) -> Self

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 WaitTimeSeconds. If no messages are available and the wait time expires, the call returns successfully with an empty list.

pub fn set_wait_time_seconds(self, input: Option<i32>) -> Self

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 WaitTimeSeconds. If no messages are available and the wait time expires, the call returns successfully with an empty list.

pub fn get_wait_time_seconds(&self) -> &Option<i32>

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 WaitTimeSeconds. If no messages are available and the wait time expires, the call returns successfully with an empty list.

Trait Implementations

impl Clone for GetRecommendationsFluentBuilder

fn clone(&self) -> GetRecommendationsFluentBuilder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for GetRecommendationsFluentBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.