| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.KinesisVideoSignaling
Description
Derived from API version 2019-12-04 of the AWS service descriptions, licensed under Apache 2.0.
Kinesis Video Streams Signaling Service is a intermediate service that establishes a communication channel for discovering peers, transmitting offers and answers in order to establish peer-to-peer connection in webRTC technology.
Synopsis
- defaultService :: Service
- _ClientLimitExceededException :: AsError a => Fold a ServiceError
- _InvalidArgumentException :: AsError a => Fold a ServiceError
- _InvalidClientException :: AsError a => Fold a ServiceError
- _NotAuthorizedException :: AsError a => Fold a ServiceError
- _ResourceNotFoundException :: AsError a => Fold a ServiceError
- _SessionExpiredException :: AsError a => Fold a ServiceError
- data GetIceServerConfig = GetIceServerConfig' (Maybe Text) (Maybe Service) (Maybe Text) Text
- newGetIceServerConfig :: Text -> GetIceServerConfig
- data GetIceServerConfigResponse = GetIceServerConfigResponse' (Maybe [IceServer]) Int
- newGetIceServerConfigResponse :: Int -> GetIceServerConfigResponse
- data SendAlexaOfferToMaster = SendAlexaOfferToMaster' Text Text Text
- newSendAlexaOfferToMaster :: Text -> Text -> Text -> SendAlexaOfferToMaster
- data SendAlexaOfferToMasterResponse = SendAlexaOfferToMasterResponse' (Maybe Text) Int
- newSendAlexaOfferToMasterResponse :: Int -> SendAlexaOfferToMasterResponse
- newtype Service where
- Service' {
- fromService :: Text
- pattern Service_TURN :: Service
- Service' {
- data IceServer = IceServer' (Maybe Text) (Maybe Natural) (Maybe [Text]) (Maybe Text)
- newIceServer :: IceServer
Service Configuration
defaultService :: Service Source #
API version 2019-12-04 of the Amazon Kinesis Video Signaling Channels SDK configuration.
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by KinesisVideoSignaling.
ClientLimitExceededException
_ClientLimitExceededException :: AsError a => Fold a ServiceError Source #
Your request was throttled because you have exceeded the limit of allowed client calls. Try making the call later.
InvalidArgumentException
_InvalidArgumentException :: AsError a => Fold a ServiceError Source #
The value for this input parameter is invalid.
InvalidClientException
_InvalidClientException :: AsError a => Fold a ServiceError Source #
The specified client is invalid.
NotAuthorizedException
_NotAuthorizedException :: AsError a => Fold a ServiceError Source #
The caller is not authorized to perform this operation.
ResourceNotFoundException
_ResourceNotFoundException :: AsError a => Fold a ServiceError Source #
The specified resource is not found.
SessionExpiredException
_SessionExpiredException :: AsError a => Fold a ServiceError Source #
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.
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait specification is fulfilled. The Wait specification
determines how many attempts should be made, in addition to delay and retry strategies.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
GetIceServerConfig
data GetIceServerConfig Source #
See: newGetIceServerConfig smart constructor.
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.
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.
data GetIceServerConfigResponse Source #
See: newGetIceServerConfigResponse smart constructor.
Constructors
| GetIceServerConfigResponse' (Maybe [IceServer]) Int |
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.
SendAlexaOfferToMaster
data SendAlexaOfferToMaster Source #
See: newSendAlexaOfferToMaster smart constructor.
Constructors
| SendAlexaOfferToMaster' Text Text Text |
Instances
newSendAlexaOfferToMaster Source #
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> SendAlexaOfferToMaster |
Create a value of SendAlexaOfferToMaster 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:channelARN:SendAlexaOfferToMaster', sendAlexaOfferToMaster_channelARN - The ARN of the signaling channel by which Alexa and the master peer
communicate.
$sel:senderClientId:SendAlexaOfferToMaster', sendAlexaOfferToMaster_senderClientId - The unique identifier for the sender client.
$sel:messagePayload:SendAlexaOfferToMaster', sendAlexaOfferToMaster_messagePayload - The base64-encoded SDP offer content.
data SendAlexaOfferToMasterResponse Source #
See: newSendAlexaOfferToMasterResponse smart constructor.
Constructors
| SendAlexaOfferToMasterResponse' (Maybe Text) Int |
Instances
newSendAlexaOfferToMasterResponse Source #
Create a value of SendAlexaOfferToMasterResponse 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:answer:SendAlexaOfferToMasterResponse', sendAlexaOfferToMasterResponse_answer - The base64-encoded SDP answer content.
$sel:httpStatus:SendAlexaOfferToMasterResponse', sendAlexaOfferToMasterResponse_httpStatus - The response's http status code.
Types
Service
Constructors
| Service' | |
Fields
| |
Bundled Patterns
| pattern Service_TURN :: Service |
Instances
IceServer
A structure for the ICE server connection data.
See: newIceServer smart constructor.
Instances
| FromJSON IceServer Source # | |
| Generic IceServer Source # | |
| Read IceServer Source # | |
| Show IceServer Source # | |
| NFData IceServer Source # | |
| Eq IceServer Source # | |
| Hashable IceServer Source # | |
| type Rep IceServer Source # | |
Defined in Amazonka.KinesisVideoSignaling.Types.IceServer type Rep IceServer = D1 ('MetaData "IceServer" "Amazonka.KinesisVideoSignaling.Types.IceServer" "amazonka-kinesis-video-signaling-2.0-4XN7Yx1E1cS9Ym8RNXTClf" 'False) (C1 ('MetaCons "IceServer'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "password") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "ttl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :*: (S1 ('MetaSel ('Just "uris") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "username") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) | |
newIceServer :: IceServer Source #
Create a value of IceServer 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:password:IceServer', iceServer_password - A password to login to the ICE server.
$sel:ttl:IceServer', iceServer_ttl - The period of time, in seconds, during which the username and password
are valid.
$sel:uris:IceServer', iceServer_uris - An array of URIs, in the form specified in the
I-D.petithuguenin-behave-turn-uris
spec. These URIs provide the different addresses and/or protocols that
can be used to reach the TURN server.
$sel:username:IceServer', iceServer_username - A username to login to the ICE server.