Module Values.GetSignalingChannelEndpointInputSource

Provides an endpoint for the specified signaling channel to send and receive messages. This API uses the SingleMasterChannelEndpointConfiguration input parameter, which consists of the Protocols and Role properties. Protocols is used to determine the communication mechanism. For example, if you specify WSS as the protocol, this API produces a secure websocket endpoint. If you specify HTTPS as the protocol, this API generates an HTTPS endpoint. If you specify WEBRTC as the protocol, but the signaling channel isn't configured for ingestion, you will receive the error InvalidArgumentException. Role determines the messaging permissions. A MASTER role results in this API generating an endpoint that a client can use to communicate with any of the viewers on the channel. A VIEWER role results in this API generating an endpoint that a client can use to communicate only with a MASTER.

Sourcetype nonrec t = {
  1. channelARN : ResourceARN.t;
    (*

    The Amazon Resource Name (ARN) of the signalling channel for which you want to get an endpoint.

    *)
  2. singleMasterChannelEndpointConfiguration : SingleMasterChannelEndpointConfiguration.t option;
    (*

    A structure containing the endpoint configuration for the SINGLE_MASTER channel type.

    *)
}
Sourceval context_ : string
Sourceval make : ?singleMasterChannelEndpointConfiguration:??? -> channelARN:ResourceARN.t -> unit -> t
Sourceval to_value : t -> [> `Structure of (string * [> `String of ResourceARN.t | `Structure of (string * [> `Enum of string | `List of [> `Enum of string ] list ]) list ]) list ]
Sourceval to_query : t -> Awso.Client.Query.t
Sourceval of_xml : Awso.Xml.t -> t
Sourceval of_string : string -> t
Sourceval of_json : Yojson.Safe.t -> t
Sourceval to_json : t -> Yojson.Safe.t