AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
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.
This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginGetIceServerConfig and EndGetIceServerConfig.
Namespace: Amazon.KinesisVideoSignalingChannels
Assembly: AWSSDK.KinesisVideoSignalingChannels.dll
Version: 3.x.y.z
public virtual Task<GetIceServerConfigResponse> GetIceServerConfigAsync( GetIceServerConfigRequest request, CancellationToken cancellationToken )
Container for the necessary parameters to execute the GetIceServerConfig service method.
A cancellation token that can be used by other objects or threads to receive notice of cancellation.
| Exception | Condition |
|---|---|
| ClientLimitExceededException | Your request was throttled because you have exceeded the limit of allowed client calls. Try making the call later. |
| InvalidArgumentException | The value for this input parameter is invalid. |
| InvalidClientException | The specified client is invalid. |
| NotAuthorizedException | The caller is not authorized to perform this operation. |
| ResourceNotFoundException | The specified resource is not found. |
| SessionExpiredException | If the client session is expired. Once the client is connected, the session is valid for 45 minutes. Client should reconnect to the channel to continue sending/receiving messages. |
.NET:
Supported in: 8.0 and newer, Core 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5 and newer