Struct aws_sdk_kinesisvideosignaling::client::fluent_builders::GetIceServerConfig

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

Fluent builder constructing a request to GetIceServerConfig.

Gets the Interactive Connectivity Establishment (ICE) server configuration information, including URIs, username, and password which can be used to configure the WebRTC connection. The ICE component uses this configuration information to setup the WebRTC connection, including authenticating with the Traversal Using Relays around NAT (TURN) relay server.

TURN is a protocol that is used to improve the connectivity of peer-to-peer applications. By providing a cloud-based relay service, TURN ensures that a connection can be established even when one or more peers are incapable of a direct peer-to-peer connection. For more information, see A REST API For Access To TURN Services.

You can invoke this API to establish a fallback mechanism in case either of the peers is unable to establish a direct peer-to-peer connection over a signaling channel. You must specify either a signaling channel ARN or the client ID in order to invoke this API.

Implementations

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

pub async fn send(
    self
) -> Result<GetIceServerConfigOutput, SdkError<GetIceServerConfigError>> where
    R::Policy: SmithyRetryPolicy<GetIceServerConfigInputOperationOutputAlias, GetIceServerConfigOutput, GetIceServerConfigError, GetIceServerConfigInputOperationRetryAlias>, 

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

The ARN of the signaling channel to be used for the peer-to-peer connection between configured peers.

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

The ARN of the signaling channel to be used for the peer-to-peer connection between configured peers.

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

Unique identifier for the viewer. Must be unique within the signaling channel.

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

Unique identifier for the viewer. Must be unique within the signaling channel.

pub fn service(self, inp: Service) -> Self

Specifies the desired service. Currently, TURN is the only valid value.

pub fn set_service(self, input: Option<Service>) -> Self

Specifies the desired service. Currently, TURN is the only valid value.

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

An optional user ID to be associated with the credentials.

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

An optional user ID to be associated with the credentials.

Trait Implementations

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

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

Formats the value using the given formatter.