Struct aws_sdk_connectparticipant::client::fluent_builders::CreateParticipantConnection

pub struct CreateParticipantConnection<C = DynConnector, M = AwsMiddleware, R = Standard> { /* fields omitted */ }

Fluent builder constructing a request to CreateParticipantConnection.

Creates the participant's connection. Note that ParticipantToken is used for invoking this API instead of ConnectionToken.

The participant token is valid for the lifetime of the participant – until they are part of a contact.

The response URL for WEBSOCKET Type has a connect expiry timeout of 100s. Clients must manually connect to the returned websocket URL and subscribe to the desired topic.

For chat, you need to publish the following on the established websocket connection:

{"topic":"aws/subscribe","content":{"topics":["aws/chat"]}}

Upon websocket URL expiry, as specified in the response ConnectionExpiry parameter, clients need to call this API again to obtain a new websocket URL and perform the same steps as before.

The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication.

Implementations

impl<C, M, R> CreateParticipantConnection<C, M, R> where
    C: SmithyConnector,
    M: SmithyMiddleware<C>,
    R: NewRequestPolicy, 

pub async fn send(
    self
) -> Result<CreateParticipantConnectionOutput, SdkError<CreateParticipantConnectionError>> where
    R::Policy: SmithyRetryPolicy<CreateParticipantConnectionInputOperationOutputAlias, CreateParticipantConnectionOutput, CreateParticipantConnectionError, CreateParticipantConnectionInputOperationRetryAlias>, 

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 type(self, inp: impl Into<ConnectionType>) -> Self

Appends an item to Type.

To override the contents of this collection use set_type.

Type of connection information required.

pub fn set_type(self, input: Option<Vec<ConnectionType>>) -> Self

Type of connection information required.

pub fn participant_token(self, inp: impl Into<String>) -> Self

This is a header parameter.

The Participant Token as obtained from StartChatContact API response.

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

This is a header parameter.

The Participant Token as obtained from StartChatContact API response.

Trait Implementations

impl<C: Debug, M: Debug, R: Debug> Debug for CreateParticipantConnection<C, M, R>

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

Formats the value using the given formatter.