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.Types

Contents

Service Configuration
Errors
Service
IceServer

Description

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
newtype Service where
- Service' {
  - fromService :: Text
  }
- pattern Service_TURN :: Service
data IceServer = IceServer' {
- password :: Maybe Text
- ttl :: Maybe Natural
- uris :: Maybe [Text]
- username :: Maybe Text
}
newIceServer :: IceServer
iceServer_password :: Lens' IceServer (Maybe Text)
iceServer_ttl :: Lens' IceServer (Maybe Natural)
iceServer_uris :: Lens' IceServer (Maybe [Text])
iceServer_username :: Lens' IceServer (Maybe Text)

Service Configuration

defaultService :: Service Source #

API version 2019-12-04 of the Amazon Kinesis Video Signaling Channels SDK configuration.

Errors

_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 :: AsError a => Fold a ServiceError Source #

The value for this input parameter is invalid.

_InvalidClientException :: AsError a => Fold a ServiceError Source #

The specified client is invalid.

_NotAuthorizedException :: AsError a => Fold a ServiceError Source #

The caller is not authorized to perform this operation.

_ResourceNotFoundException :: AsError a => Fold a ServiceError Source #

The specified resource is not found.

_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.

Service

newtype Service Source #

Constructors

Service'
Fields fromService :: Text

Bundled Patterns

pattern Service_TURN :: Service

Instances

Instances details

FromJSON Service Source #
Instance details Defined in Amazonka.KinesisVideoSignaling.Types.Service Methods parseJSON :: Value -> Parser Service # parseJSONList :: Value -> Parser [Service] #
FromJSONKey Service Source #
Instance details Defined in Amazonka.KinesisVideoSignaling.Types.Service Methods fromJSONKey :: FromJSONKeyFunction Service # fromJSONKeyList :: FromJSONKeyFunction [Service] #
ToJSON Service Source #
Instance details Defined in Amazonka.KinesisVideoSignaling.Types.Service Methods toJSON :: Service -> Value # toEncoding :: Service -> Encoding # toJSONList :: [Service] -> Value # toEncodingList :: [Service] -> Encoding #
ToJSONKey Service Source #
Instance details Defined in Amazonka.KinesisVideoSignaling.Types.Service Methods toJSONKey :: ToJSONKeyFunction Service # toJSONKeyList :: ToJSONKeyFunction [Service] #
ToByteString Service Source #
Instance details Defined in Amazonka.KinesisVideoSignaling.Types.Service Methods toBS :: Service -> ByteString #
ToHeader Service Source #
Instance details Defined in Amazonka.KinesisVideoSignaling.Types.Service Methods toHeader :: HeaderName -> Service -> [Header] #
ToLog Service Source #
Instance details Defined in Amazonka.KinesisVideoSignaling.Types.Service Methods build :: Service -> ByteStringBuilder #
ToQuery Service Source #
Instance details Defined in Amazonka.KinesisVideoSignaling.Types.Service Methods toQuery :: Service -> QueryString #
FromText Service Source #
Instance details Defined in Amazonka.KinesisVideoSignaling.Types.Service Methods fromText :: Text -> Either String Service #
ToText Service Source #
Instance details Defined in Amazonka.KinesisVideoSignaling.Types.Service Methods toText :: Service -> Text #
FromXML Service Source #
Instance details Defined in Amazonka.KinesisVideoSignaling.Types.Service Methods parseXML :: [Node] -> Either String Service #
ToXML Service Source #
Instance details Defined in Amazonka.KinesisVideoSignaling.Types.Service Methods toXML :: Service -> XML #
Generic Service Source #
Instance details Defined in Amazonka.KinesisVideoSignaling.Types.Service Associated Types type Rep Service :: Type -> Type # Methods from :: Service -> Rep Service x # to :: Rep Service x -> Service #
Read Service Source #
Instance details Defined in Amazonka.KinesisVideoSignaling.Types.Service Methods readsPrec :: Int -> ReadS Service # readList :: ReadS [Service] # readPrec :: ReadPrec Service # readListPrec :: ReadPrec [Service] #
Show Service Source #
Instance details Defined in Amazonka.KinesisVideoSignaling.Types.Service Methods showsPrec :: Int -> Service -> ShowS # show :: Service -> String # showList :: [Service] -> ShowS #
NFData Service Source #
Instance details Defined in Amazonka.KinesisVideoSignaling.Types.Service Methods rnf :: Service -> () #
Eq Service Source #
Instance details Defined in Amazonka.KinesisVideoSignaling.Types.Service Methods (==) :: Service -> Service -> Bool # (/=) :: Service -> Service -> Bool #
Ord Service Source #
Instance details Defined in Amazonka.KinesisVideoSignaling.Types.Service Methods compare :: Service -> Service -> Ordering # (<) :: Service -> Service -> Bool # (<=) :: Service -> Service -> Bool # (>) :: Service -> Service -> Bool # (>=) :: Service -> Service -> Bool # max :: Service -> Service -> Service # min :: Service -> Service -> Service #
Hashable Service Source #
Instance details Defined in Amazonka.KinesisVideoSignaling.Types.Service Methods hashWithSalt :: Int -> Service -> Int # hash :: Service -> Int #
type Rep Service Source #
Instance details Defined in Amazonka.KinesisVideoSignaling.Types.Service type Rep Service = D1 ('MetaData "Service" "Amazonka.KinesisVideoSignaling.Types.Service" "amazonka-kinesis-video-signaling-2.0-4XN7Yx1E1cS9Ym8RNXTClf" 'True) (C1 ('MetaCons "Service'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromService") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

IceServer

data IceServer Source #

A structure for the ICE server connection data.

See: newIceServer smart constructor.

Constructors

IceServer'

Fields

password :: Maybe Text
A password to login to the ICE server.
ttl :: Maybe Natural
The period of time, in seconds, during which the username and password are valid.
uris :: Maybe [Text]
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.
username :: Maybe Text
A username to login to the ICE server.

Instances

Instances details

FromJSON IceServer Source #
Instance details Defined in Amazonka.KinesisVideoSignaling.Types.IceServer Methods parseJSON :: Value -> Parser IceServer # parseJSONList :: Value -> Parser [IceServer] #
Generic IceServer Source #
Instance details Defined in Amazonka.KinesisVideoSignaling.Types.IceServer Associated Types type Rep IceServer :: Type -> Type # Methods from :: IceServer -> Rep IceServer x # to :: Rep IceServer x -> IceServer #
Read IceServer Source #
Instance details Defined in Amazonka.KinesisVideoSignaling.Types.IceServer Methods readsPrec :: Int -> ReadS IceServer # readList :: ReadS [IceServer] # readPrec :: ReadPrec IceServer # readListPrec :: ReadPrec [IceServer] #
Show IceServer Source #
Instance details Defined in Amazonka.KinesisVideoSignaling.Types.IceServer Methods showsPrec :: Int -> IceServer -> ShowS # show :: IceServer -> String # showList :: [IceServer] -> ShowS #
NFData IceServer Source #
Instance details Defined in Amazonka.KinesisVideoSignaling.Types.IceServer Methods rnf :: IceServer -> () #
Eq IceServer Source #
Instance details Defined in Amazonka.KinesisVideoSignaling.Types.IceServer Methods (==) :: IceServer -> IceServer -> Bool # (/=) :: IceServer -> IceServer -> Bool #
Hashable IceServer Source #
Instance details Defined in Amazonka.KinesisVideoSignaling.Types.IceServer Methods hashWithSalt :: Int -> IceServer -> Int # hash :: IceServer -> Int #
type Rep IceServer Source #
Instance details 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.

iceServer_password :: Lens' IceServer (Maybe Text) Source #

A password to login to the ICE server.

iceServer_ttl :: Lens' IceServer (Maybe Natural) Source #

The period of time, in seconds, during which the username and password are valid.

iceServer_uris :: Lens' IceServer (Maybe [Text]) Source #

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.

iceServer_username :: Lens' IceServer (Maybe Text) Source #

A username to login to the ICE server.