aws_sdk_qconnect/client/
send_message.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 [`SendMessage`](crate::operation::send_message::builders::SendMessageFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`assistant_id(impl Into<String>)`](crate::operation::send_message::builders::SendMessageFluentBuilder::assistant_id) / [`set_assistant_id(Option<String>)`](crate::operation::send_message::builders::SendMessageFluentBuilder::set_assistant_id):<br>required: **true**<br><p>The identifier of the Amazon Q in Connect assistant.</p><br>
7    ///   - [`session_id(impl Into<String>)`](crate::operation::send_message::builders::SendMessageFluentBuilder::session_id) / [`set_session_id(Option<String>)`](crate::operation::send_message::builders::SendMessageFluentBuilder::set_session_id):<br>required: **true**<br><p>The identifier of the Amazon Q in Connect session.</p><br>
8    ///   - [`r#type(MessageType)`](crate::operation::send_message::builders::SendMessageFluentBuilder::type) / [`set_type(Option<MessageType>)`](crate::operation::send_message::builders::SendMessageFluentBuilder::set_type):<br>required: **true**<br><p>The message type.</p><br>
9    ///   - [`message(MessageInput)`](crate::operation::send_message::builders::SendMessageFluentBuilder::message) / [`set_message(Option<MessageInput>)`](crate::operation::send_message::builders::SendMessageFluentBuilder::set_message):<br>required: **true**<br><p>The message data to submit to the Amazon Q in Connect session.</p><br>
10    ///   - [`ai_agent_id(impl Into<String>)`](crate::operation::send_message::builders::SendMessageFluentBuilder::ai_agent_id) / [`set_ai_agent_id(Option<String>)`](crate::operation::send_message::builders::SendMessageFluentBuilder::set_ai_agent_id):<br>required: **false**<br><p>The identifier of the AI Agent to use for processing the message.</p><br>
11    ///   - [`conversation_context(ConversationContext)`](crate::operation::send_message::builders::SendMessageFluentBuilder::conversation_context) / [`set_conversation_context(Option<ConversationContext>)`](crate::operation::send_message::builders::SendMessageFluentBuilder::set_conversation_context):<br>required: **false**<br><p>The conversation context before the Amazon Q in Connect session.</p><br>
12    ///   - [`configuration(MessageConfiguration)`](crate::operation::send_message::builders::SendMessageFluentBuilder::configuration) / [`set_configuration(Option<MessageConfiguration>)`](crate::operation::send_message::builders::SendMessageFluentBuilder::set_configuration):<br>required: **false**<br><p>The configuration of the <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_amazon-q-connect_SendMessage.html">SendMessage</a> request.</p><br>
13    ///   - [`client_token(impl Into<String>)`](crate::operation::send_message::builders::SendMessageFluentBuilder::client_token) / [`set_client_token(Option<String>)`](crate::operation::send_message::builders::SendMessageFluentBuilder::set_client_token):<br>required: **false**<br><p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the AWS SDK populates this field.For more information about idempotency, see Making retries safe with idempotent APIs.</p><br>
14    ///   - [`orchestrator_use_case(impl Into<String>)`](crate::operation::send_message::builders::SendMessageFluentBuilder::orchestrator_use_case) / [`set_orchestrator_use_case(Option<String>)`](crate::operation::send_message::builders::SendMessageFluentBuilder::set_orchestrator_use_case):<br>required: **false**<br><p>The orchestrator use case for message processing.</p><br>
15    ///   - [`metadata(impl Into<String>, impl Into<String>)`](crate::operation::send_message::builders::SendMessageFluentBuilder::metadata) / [`set_metadata(Option<HashMap::<String, String>>)`](crate::operation::send_message::builders::SendMessageFluentBuilder::set_metadata):<br>required: **false**<br><p>Additional metadata for the message.</p><br>
16    /// - On success, responds with [`SendMessageOutput`](crate::operation::send_message::SendMessageOutput) with field(s):
17    ///   - [`request_message_id(String)`](crate::operation::send_message::SendMessageOutput::request_message_id): <p>The identifier of the submitted message.</p>
18    ///   - [`configuration(Option<MessageConfiguration>)`](crate::operation::send_message::SendMessageOutput::configuration): <p>The configuration of the <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_amazon-q-connect_SendMessage.html">SendMessage</a> request.</p>
19    ///   - [`next_message_token(String)`](crate::operation::send_message::SendMessageOutput::next_message_token): <p>The token for the next message, used by GetNextMessage.</p>
20    /// - On failure, responds with [`SdkError<SendMessageError>`](crate::operation::send_message::SendMessageError)
21    pub fn send_message(&self) -> crate::operation::send_message::builders::SendMessageFluentBuilder {
22        crate::operation::send_message::builders::SendMessageFluentBuilder::new(self.handle.clone())
23    }
24}