aws-sdk-connect 1.195.0

AWS SDK for Amazon Connect Service
Documentation
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`StartAssistantContact`](crate::operation::start_assistant_contact::builders::StartAssistantContactFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`instance_id(impl Into<String>)`](crate::operation::start_assistant_contact::builders::StartAssistantContactFluentBuilder::instance_id) / [`set_instance_id(Option<String>)`](crate::operation::start_assistant_contact::builders::StartAssistantContactFluentBuilder::set_instance_id):<br>required: **true**<br><p>The identifier of the Connect Customer instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p><br>
    ///   - [`ai_agent(AiAgentInput)`](crate::operation::start_assistant_contact::builders::StartAssistantContactFluentBuilder::ai_agent) / [`set_ai_agent(Option<AiAgentInput>)`](crate::operation::start_assistant_contact::builders::StartAssistantContactFluentBuilder::set_ai_agent):<br>required: **true**<br><p>The AI agent configuration for this contact.</p><br>
    ///   - [`participant_details(ParticipantDetails)`](crate::operation::start_assistant_contact::builders::StartAssistantContactFluentBuilder::participant_details) / [`set_participant_details(Option<ParticipantDetails>)`](crate::operation::start_assistant_contact::builders::StartAssistantContactFluentBuilder::set_participant_details):<br>required: **true**<br><p>The display name and other details that identify the chat participant.</p><br>
    ///   - [`initial_message(ChatMessage)`](crate::operation::start_assistant_contact::builders::StartAssistantContactFluentBuilder::initial_message) / [`set_initial_message(Option<ChatMessage>)`](crate::operation::start_assistant_contact::builders::StartAssistantContactFluentBuilder::set_initial_message):<br>required: **false**<br><p>The initial message to send to the newly created chat.</p><br>
    ///   - [`attributes(impl Into<String>, impl Into<String>)`](crate::operation::start_assistant_contact::builders::StartAssistantContactFluentBuilder::attributes) / [`set_attributes(Option<HashMap::<String, String>>)`](crate::operation::start_assistant_contact::builders::StartAssistantContactFluentBuilder::set_attributes):<br>required: **false**<br><p>A map of key-value pairs to associate with the contact. We make these attributes available to flows as standard contact attributes.</p> <p>You can provide up to 32,768 UTF-8 bytes across all key-value pairs for each contact.</p><br>
    ///   - [`client_token(impl Into<String>)`](crate::operation::start_assistant_contact::builders::StartAssistantContactFluentBuilder::client_token) / [`set_client_token(Option<String>)`](crate::operation::start_assistant_contact::builders::StartAssistantContactFluentBuilder::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 Amazon Web Services SDK populates this field. For more information about idempotency, see <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p><br>
    ///   - [`persistent_chat(PersistentChat)`](crate::operation::start_assistant_contact::builders::StartAssistantContactFluentBuilder::persistent_chat) / [`set_persistent_chat(Option<PersistentChat>)`](crate::operation::start_assistant_contact::builders::StartAssistantContactFluentBuilder::set_persistent_chat):<br>required: **false**<br><p>The configuration that enables persistent chat. For more information about persistent chat and its use cases, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/chat-persistence.html">Enable persistent chat</a>.</p><br>
    ///   - [`related_contact_id(impl Into<String>)`](crate::operation::start_assistant_contact::builders::StartAssistantContactFluentBuilder::related_contact_id) / [`set_related_contact_id(Option<String>)`](crate::operation::start_assistant_contact::builders::StartAssistantContactFluentBuilder::set_related_contact_id):<br>required: **false**<br><p>The identifier of an Connect Customer contact related to the new assistant contact.</p><note>  <p>You cannot provide both <code>RelatedContactId</code> and <code>PersistentChat</code>.</p> </note><br>
    /// - On success, responds with [`StartAssistantContactOutput`](crate::operation::start_assistant_contact::StartAssistantContactOutput) with field(s):
    ///   - [`contact_id(Option<String>)`](crate::operation::start_assistant_contact::StartAssistantContactOutput::contact_id): <p>The identifier of the contact within the Connect Customer instance.</p>
    ///   - [`participant_id(Option<String>)`](crate::operation::start_assistant_contact::StartAssistantContactOutput::participant_id): <p>The identifier of the chat participant. The participant identifier remains the same throughout the chat lifecycle.</p>
    ///   - [`participant_token(Option<String>)`](crate::operation::start_assistant_contact::StartAssistantContactOutput::participant_token): <p>The token that the chat participant uses with the <a href="https://docs.aws.amazon.com/connect-participant/latest/APIReference/API_CreateParticipantConnection.html">CreateParticipantConnection</a> operation. The token remains valid for the lifetime of the chat participant.</p>
    ///   - [`continued_from_contact_id(Option<String>)`](crate::operation::start_assistant_contact::StartAssistantContactOutput::continued_from_contact_id): <p>The identifier of the contact from which the chat continues, returned only for persistent chats.</p>
    /// - On failure, responds with [`SdkError<StartAssistantContactError>`](crate::operation::start_assistant_contact::StartAssistantContactError)
    pub fn start_assistant_contact(&self) -> crate::operation::start_assistant_contact::builders::StartAssistantContactFluentBuilder {
        crate::operation::start_assistant_contact::builders::StartAssistantContactFluentBuilder::new(self.handle.clone())
    }
}