| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.KinesisVideoSignaling.GetIceServerConfig
Description
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.
Synopsis
- data GetIceServerConfig = GetIceServerConfig' {}
- newGetIceServerConfig :: Text -> GetIceServerConfig
- getIceServerConfig_clientId :: Lens' GetIceServerConfig (Maybe Text)
- getIceServerConfig_service :: Lens' GetIceServerConfig (Maybe Service)
- getIceServerConfig_username :: Lens' GetIceServerConfig (Maybe Text)
- getIceServerConfig_channelARN :: Lens' GetIceServerConfig Text
- data GetIceServerConfigResponse = GetIceServerConfigResponse' {
- iceServerList :: Maybe [IceServer]
- httpStatus :: Int
- newGetIceServerConfigResponse :: Int -> GetIceServerConfigResponse
- getIceServerConfigResponse_iceServerList :: Lens' GetIceServerConfigResponse (Maybe [IceServer])
- getIceServerConfigResponse_httpStatus :: Lens' GetIceServerConfigResponse Int
Creating a Request
data GetIceServerConfig Source #
See: newGetIceServerConfig smart constructor.
Constructors
| GetIceServerConfig' | |
Fields
| |
Instances
newGetIceServerConfig Source #
Arguments
| :: Text | |
| -> GetIceServerConfig |
Create a value of GetIceServerConfig with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientId:GetIceServerConfig', getIceServerConfig_clientId - Unique identifier for the viewer. Must be unique within the signaling
channel.
$sel:service:GetIceServerConfig', getIceServerConfig_service - Specifies the desired service. Currently, TURN is the only valid
value.
$sel:username:GetIceServerConfig', getIceServerConfig_username - An optional user ID to be associated with the credentials.
$sel:channelARN:GetIceServerConfig', getIceServerConfig_channelARN - The ARN of the signaling channel to be used for the peer-to-peer
connection between configured peers.
Request Lenses
getIceServerConfig_clientId :: Lens' GetIceServerConfig (Maybe Text) Source #
Unique identifier for the viewer. Must be unique within the signaling channel.
getIceServerConfig_service :: Lens' GetIceServerConfig (Maybe Service) Source #
Specifies the desired service. Currently, TURN is the only valid
value.
getIceServerConfig_username :: Lens' GetIceServerConfig (Maybe Text) Source #
An optional user ID to be associated with the credentials.
getIceServerConfig_channelARN :: Lens' GetIceServerConfig Text Source #
The ARN of the signaling channel to be used for the peer-to-peer connection between configured peers.
Destructuring the Response
data GetIceServerConfigResponse Source #
See: newGetIceServerConfigResponse smart constructor.
Constructors
| GetIceServerConfigResponse' | |
Fields
| |
Instances
newGetIceServerConfigResponse Source #
Create a value of GetIceServerConfigResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:iceServerList:GetIceServerConfigResponse', getIceServerConfigResponse_iceServerList - The list of ICE server information objects.
$sel:httpStatus:GetIceServerConfigResponse', getIceServerConfigResponse_httpStatus - The response's http status code.
Response Lenses
getIceServerConfigResponse_iceServerList :: Lens' GetIceServerConfigResponse (Maybe [IceServer]) Source #
The list of ICE server information objects.
getIceServerConfigResponse_httpStatus :: Lens' GetIceServerConfigResponse Int Source #
The response's http status code.