aws_sdk_connectparticipant/client/

create_participant_connection.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`CreateParticipantConnection`](crate::operation::create_participant_connection::builders::CreateParticipantConnectionFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`r#type(ConnectionType)`](crate::operation::create_participant_connection::builders::CreateParticipantConnectionFluentBuilder::type) / [`set_type(Option<Vec::<ConnectionType>>)`](crate::operation::create_participant_connection::builders::CreateParticipantConnectionFluentBuilder::set_type):<br>required: **false**<br><p>Type of connection information required. If you need <code>CONNECTION_CREDENTIALS</code> along with marking participant as connected, pass <code>CONNECTION_CREDENTIALS</code> in <code>Type</code>.</p><br>
    ///   - [`participant_token(impl Into<String>)`](crate::operation::create_participant_connection::builders::CreateParticipantConnectionFluentBuilder::participant_token) / [`set_participant_token(Option<String>)`](crate::operation::create_participant_connection::builders::CreateParticipantConnectionFluentBuilder::set_participant_token):<br>required: **true**<br><p>This is a header parameter.</p> <p>The ParticipantToken as obtained from <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_StartChatContact.html">StartChatContact</a> API response.</p><br>
    ///   - [`connect_participant(bool)`](crate::operation::create_participant_connection::builders::CreateParticipantConnectionFluentBuilder::connect_participant) / [`set_connect_participant(Option<bool>)`](crate::operation::create_participant_connection::builders::CreateParticipantConnectionFluentBuilder::set_connect_participant):<br>required: **false**<br><p>Amazon Connect Participant is used to mark the participant as connected for customer participant in message streaming, as well as for agent or manager participant in non-streaming chats.</p><br>
    /// - On success, responds with [`CreateParticipantConnectionOutput`](crate::operation::create_participant_connection::CreateParticipantConnectionOutput) with field(s):
    ///   - [`websocket(Option<Websocket>)`](crate::operation::create_participant_connection::CreateParticipantConnectionOutput::websocket): <p>Creates the participant's websocket connection.</p>
    ///   - [`connection_credentials(Option<ConnectionCredentials>)`](crate::operation::create_participant_connection::CreateParticipantConnectionOutput::connection_credentials): <p>Creates the participant's connection credentials. The authentication token associated with the participant's connection.</p>
    ///   - [`web_rtc_connection(Option<WebRtcConnection>)`](crate::operation::create_participant_connection::CreateParticipantConnectionOutput::web_rtc_connection): <p>Creates the participant's WebRTC connection data required for the client application (mobile application or website) to connect to the call.</p>
    /// - On failure, responds with [`SdkError<CreateParticipantConnectionError>`](crate::operation::create_participant_connection::CreateParticipantConnectionError)
    pub fn create_participant_connection(
        &self,
    ) -> crate::operation::create_participant_connection::builders::CreateParticipantConnectionFluentBuilder {
        crate::operation::create_participant_connection::builders::CreateParticipantConnectionFluentBuilder::new(self.handle.clone())
    }
}