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

Contents

Service Configuration
Errors
ChannelLatencyMode
ChannelType
RecordingConfigurationState
StreamHealth
StreamState
BatchError
Channel
ChannelSummary
DestinationConfiguration
PlaybackKeyPair
PlaybackKeyPairSummary
RecordingConfiguration
RecordingConfigurationSummary
S3DestinationConfiguration
Stream
StreamKey
StreamKeySummary
StreamSummary

Description

Synopsis

defaultService :: Service
_ValidationException :: AsError a => Getting (First ServiceError) a ServiceError
_AccessDeniedException :: AsError a => Getting (First ServiceError) a ServiceError
_StreamUnavailable :: AsError a => Getting (First ServiceError) a ServiceError
_PendingVerification :: AsError a => Getting (First ServiceError) a ServiceError
_ChannelNotBroadcasting :: AsError a => Getting (First ServiceError) a ServiceError
_ConflictException :: AsError a => Getting (First ServiceError) a ServiceError
_ServiceQuotaExceededException :: AsError a => Getting (First ServiceError) a ServiceError
_ThrottlingException :: AsError a => Getting (First ServiceError) a ServiceError
_InternalServerException :: AsError a => Getting (First ServiceError) a ServiceError
_ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
newtype ChannelLatencyMode where
- ChannelLatencyMode' {
  - fromChannelLatencyMode :: Text
  }
- pattern ChannelLatencyMode_LOW :: ChannelLatencyMode
- pattern ChannelLatencyMode_NORMAL :: ChannelLatencyMode
newtype ChannelType where
- ChannelType' {
  - fromChannelType :: Text
  }
- pattern ChannelType_BASIC :: ChannelType
- pattern ChannelType_STANDARD :: ChannelType
newtype RecordingConfigurationState where
- RecordingConfigurationState' {
  - fromRecordingConfigurationState :: Text
  }
- pattern RecordingConfigurationState_ACTIVE :: RecordingConfigurationState
- pattern RecordingConfigurationState_CREATE_FAILED :: RecordingConfigurationState
- pattern RecordingConfigurationState_CREATING :: RecordingConfigurationState
newtype StreamHealth where
- StreamHealth' {
  - fromStreamHealth :: Text
  }
- pattern StreamHealth_HEALTHY :: StreamHealth
- pattern StreamHealth_STARVING :: StreamHealth
- pattern StreamHealth_UNKNOWN :: StreamHealth
newtype StreamState where
- StreamState' {
  - fromStreamState :: Text
  }
- pattern StreamState_LIVE :: StreamState
- pattern StreamState_OFFLINE :: StreamState
data BatchError = BatchError' {
- arn :: Maybe Text
- code :: Maybe Text
- message :: Maybe Text
}
newBatchError :: BatchError
batchError_arn :: Lens' BatchError (Maybe Text)
batchError_code :: Lens' BatchError (Maybe Text)
batchError_message :: Lens' BatchError (Maybe Text)
data Channel = Channel' {
- playbackUrl :: Maybe Text
- authorized :: Maybe Bool
- arn :: Maybe Text
- latencyMode :: Maybe ChannelLatencyMode
- name :: Maybe Text
- recordingConfigurationArn :: Maybe Text
- type' :: Maybe ChannelType
- tags :: Maybe (HashMap Text Text)
- ingestEndpoint :: Maybe Text
}
newChannel :: Channel
channel_playbackUrl :: Lens' Channel (Maybe Text)
channel_authorized :: Lens' Channel (Maybe Bool)
channel_arn :: Lens' Channel (Maybe Text)
channel_latencyMode :: Lens' Channel (Maybe ChannelLatencyMode)
channel_name :: Lens' Channel (Maybe Text)
channel_recordingConfigurationArn :: Lens' Channel (Maybe Text)
channel_type :: Lens' Channel (Maybe ChannelType)
channel_tags :: Lens' Channel (Maybe (HashMap Text Text))
channel_ingestEndpoint :: Lens' Channel (Maybe Text)
data ChannelSummary = ChannelSummary' {
- authorized :: Maybe Bool
- arn :: Maybe Text
- latencyMode :: Maybe ChannelLatencyMode
- name :: Maybe Text
- recordingConfigurationArn :: Maybe Text
- tags :: Maybe (HashMap Text Text)
}
newChannelSummary :: ChannelSummary
channelSummary_authorized :: Lens' ChannelSummary (Maybe Bool)
channelSummary_arn :: Lens' ChannelSummary (Maybe Text)
channelSummary_latencyMode :: Lens' ChannelSummary (Maybe ChannelLatencyMode)
channelSummary_name :: Lens' ChannelSummary (Maybe Text)
channelSummary_recordingConfigurationArn :: Lens' ChannelSummary (Maybe Text)
channelSummary_tags :: Lens' ChannelSummary (Maybe (HashMap Text Text))
data DestinationConfiguration = DestinationConfiguration' {
- s3 :: Maybe S3DestinationConfiguration
}
newDestinationConfiguration :: DestinationConfiguration
destinationConfiguration_s3 :: Lens' DestinationConfiguration (Maybe S3DestinationConfiguration)
data PlaybackKeyPair = PlaybackKeyPair' {
- arn :: Maybe Text
- fingerprint :: Maybe Text
- name :: Maybe Text
- tags :: Maybe (HashMap Text Text)
}
newPlaybackKeyPair :: PlaybackKeyPair
playbackKeyPair_arn :: Lens' PlaybackKeyPair (Maybe Text)
playbackKeyPair_fingerprint :: Lens' PlaybackKeyPair (Maybe Text)
playbackKeyPair_name :: Lens' PlaybackKeyPair (Maybe Text)
playbackKeyPair_tags :: Lens' PlaybackKeyPair (Maybe (HashMap Text Text))
data PlaybackKeyPairSummary = PlaybackKeyPairSummary' {
- arn :: Maybe Text
- name :: Maybe Text
- tags :: Maybe (HashMap Text Text)
}
newPlaybackKeyPairSummary :: PlaybackKeyPairSummary
playbackKeyPairSummary_arn :: Lens' PlaybackKeyPairSummary (Maybe Text)
playbackKeyPairSummary_name :: Lens' PlaybackKeyPairSummary (Maybe Text)
playbackKeyPairSummary_tags :: Lens' PlaybackKeyPairSummary (Maybe (HashMap Text Text))
data RecordingConfiguration = RecordingConfiguration' {
- name :: Maybe Text
- tags :: Maybe (HashMap Text Text)
- arn :: Text
- destinationConfiguration :: DestinationConfiguration
- state :: RecordingConfigurationState
}
newRecordingConfiguration :: Text -> DestinationConfiguration -> RecordingConfigurationState -> RecordingConfiguration
recordingConfiguration_name :: Lens' RecordingConfiguration (Maybe Text)
recordingConfiguration_tags :: Lens' RecordingConfiguration (Maybe (HashMap Text Text))
recordingConfiguration_arn :: Lens' RecordingConfiguration Text
recordingConfiguration_destinationConfiguration :: Lens' RecordingConfiguration DestinationConfiguration
recordingConfiguration_state :: Lens' RecordingConfiguration RecordingConfigurationState
data RecordingConfigurationSummary = RecordingConfigurationSummary' {
- name :: Maybe Text
- tags :: Maybe (HashMap Text Text)
- arn :: Text
- destinationConfiguration :: DestinationConfiguration
- state :: RecordingConfigurationState
}
newRecordingConfigurationSummary :: Text -> DestinationConfiguration -> RecordingConfigurationState -> RecordingConfigurationSummary
recordingConfigurationSummary_name :: Lens' RecordingConfigurationSummary (Maybe Text)
recordingConfigurationSummary_tags :: Lens' RecordingConfigurationSummary (Maybe (HashMap Text Text))
recordingConfigurationSummary_arn :: Lens' RecordingConfigurationSummary Text
recordingConfigurationSummary_destinationConfiguration :: Lens' RecordingConfigurationSummary DestinationConfiguration
recordingConfigurationSummary_state :: Lens' RecordingConfigurationSummary RecordingConfigurationState
data S3DestinationConfiguration = S3DestinationConfiguration' {
- bucketName :: Text
}
newS3DestinationConfiguration :: Text -> S3DestinationConfiguration
s3DestinationConfiguration_bucketName :: Lens' S3DestinationConfiguration Text
data Stream = Stream' {
- playbackUrl :: Maybe Text
- state :: Maybe StreamState
- startTime :: Maybe POSIX
- channelArn :: Maybe Text
- viewerCount :: Maybe Integer
- health :: Maybe StreamHealth
}
newStream :: Stream
stream_playbackUrl :: Lens' Stream (Maybe Text)
stream_state :: Lens' Stream (Maybe StreamState)
stream_startTime :: Lens' Stream (Maybe UTCTime)
stream_channelArn :: Lens' Stream (Maybe Text)
stream_viewerCount :: Lens' Stream (Maybe Integer)
stream_health :: Lens' Stream (Maybe StreamHealth)
data StreamKey = StreamKey' {
- arn :: Maybe Text
- value :: Maybe (Sensitive Text)
- channelArn :: Maybe Text
- tags :: Maybe (HashMap Text Text)
}
newStreamKey :: StreamKey
streamKey_arn :: Lens' StreamKey (Maybe Text)
streamKey_value :: Lens' StreamKey (Maybe Text)
streamKey_channelArn :: Lens' StreamKey (Maybe Text)
streamKey_tags :: Lens' StreamKey (Maybe (HashMap Text Text))
data StreamKeySummary = StreamKeySummary' {
- arn :: Maybe Text
- channelArn :: Maybe Text
- tags :: Maybe (HashMap Text Text)
}
newStreamKeySummary :: StreamKeySummary
streamKeySummary_arn :: Lens' StreamKeySummary (Maybe Text)
streamKeySummary_channelArn :: Lens' StreamKeySummary (Maybe Text)
streamKeySummary_tags :: Lens' StreamKeySummary (Maybe (HashMap Text Text))
data StreamSummary = StreamSummary' {
- state :: Maybe StreamState
- startTime :: Maybe POSIX
- channelArn :: Maybe Text
- viewerCount :: Maybe Integer
- health :: Maybe StreamHealth
}
newStreamSummary :: StreamSummary
streamSummary_state :: Lens' StreamSummary (Maybe StreamState)
streamSummary_startTime :: Lens' StreamSummary (Maybe UTCTime)
streamSummary_channelArn :: Lens' StreamSummary (Maybe Text)
streamSummary_viewerCount :: Lens' StreamSummary (Maybe Integer)
streamSummary_health :: Lens' StreamSummary (Maybe StreamHealth)

Service Configuration

defaultService :: Service Source #

API version 2020-07-14 of the Amazon Interactive Video Service SDK configuration.

Errors

_ValidationException :: AsError a => Getting (First ServiceError) a ServiceError Source #

_AccessDeniedException :: AsError a => Getting (First ServiceError) a ServiceError Source #

_StreamUnavailable :: AsError a => Getting (First ServiceError) a ServiceError Source #

_PendingVerification :: AsError a => Getting (First ServiceError) a ServiceError Source #

_ChannelNotBroadcasting :: AsError a => Getting (First ServiceError) a ServiceError Source #

_ConflictException :: AsError a => Getting (First ServiceError) a ServiceError Source #

_ServiceQuotaExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source #

_ThrottlingException :: AsError a => Getting (First ServiceError) a ServiceError Source #

_InternalServerException :: AsError a => Getting (First ServiceError) a ServiceError Source #

_ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #

ChannelLatencyMode

newtype ChannelLatencyMode Source #

Constructors

ChannelLatencyMode'
Fields fromChannelLatencyMode :: Text

Bundled Patterns

pattern ChannelLatencyMode_LOW :: ChannelLatencyMode
pattern ChannelLatencyMode_NORMAL :: ChannelLatencyMode

Instances

Instances details

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

ChannelType

newtype ChannelType Source #

Constructors

ChannelType'
Fields fromChannelType :: Text

Bundled Patterns

pattern ChannelType_BASIC :: ChannelType
pattern ChannelType_STANDARD :: ChannelType

Instances

Instances details

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

RecordingConfigurationState

newtype RecordingConfigurationState Source #

Constructors

RecordingConfigurationState'
Fields fromRecordingConfigurationState :: Text

Bundled Patterns

pattern RecordingConfigurationState_ACTIVE :: RecordingConfigurationState
pattern RecordingConfigurationState_CREATE_FAILED :: RecordingConfigurationState
pattern RecordingConfigurationState_CREATING :: RecordingConfigurationState

Instances

Instances details

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

StreamHealth

newtype StreamHealth Source #

Constructors

StreamHealth'
Fields fromStreamHealth :: Text

Bundled Patterns

pattern StreamHealth_HEALTHY :: StreamHealth
pattern StreamHealth_STARVING :: StreamHealth
pattern StreamHealth_UNKNOWN :: StreamHealth

Instances

Instances details

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

StreamState

newtype StreamState Source #

Constructors

StreamState'
Fields fromStreamState :: Text

Bundled Patterns

pattern StreamState_LIVE :: StreamState
pattern StreamState_OFFLINE :: StreamState

Instances

Instances details

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

BatchError

data BatchError Source #

Error related to a specific channel, specified by its ARN.

See: newBatchError smart constructor.

Constructors

BatchError'
Fields arn :: Maybe Text Channel ARN. code :: Maybe Text Error code. message :: Maybe Text Error message, determined by the application.

Instances

Instances details

Eq BatchError Source #
Instance details Defined in Amazonka.IVS.Types.BatchError Methods (==) :: BatchError -> BatchError -> Bool # (/=) :: BatchError -> BatchError -> Bool #
Read BatchError Source #
Instance details Defined in Amazonka.IVS.Types.BatchError Methods readsPrec :: Int -> ReadS BatchError # readList :: ReadS [BatchError] # readPrec :: ReadPrec BatchError # readListPrec :: ReadPrec [BatchError] #
Show BatchError Source #
Instance details Defined in Amazonka.IVS.Types.BatchError Methods showsPrec :: Int -> BatchError -> ShowS # show :: BatchError -> String # showList :: [BatchError] -> ShowS #
Generic BatchError Source #
Instance details Defined in Amazonka.IVS.Types.BatchError Associated Types type Rep BatchError :: Type -> Type # Methods from :: BatchError -> Rep BatchError x # to :: Rep BatchError x -> BatchError #
NFData BatchError Source #
Instance details Defined in Amazonka.IVS.Types.BatchError Methods rnf :: BatchError -> () #
Hashable BatchError Source #
Instance details Defined in Amazonka.IVS.Types.BatchError Methods hashWithSalt :: Int -> BatchError -> Int # hash :: BatchError -> Int #
FromJSON BatchError Source #
Instance details Defined in Amazonka.IVS.Types.BatchError Methods parseJSON :: Value -> Parser BatchError # parseJSONList :: Value -> Parser [BatchError] #
type Rep BatchError Source #
Instance details Defined in Amazonka.IVS.Types.BatchError type Rep BatchError = D1 ('MetaData "BatchError" "Amazonka.IVS.Types.BatchError" "libZSservicesZSamazonka-ivsZSamazonka-ivs" 'False) (C1 ('MetaCons "BatchError'" 'PrefixI 'True) (S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "code") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "message") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newBatchError :: BatchError Source #

Create a value of BatchError 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:arn:BatchError', batchError_arn - Channel ARN.

$sel:code:BatchError', batchError_code - Error code.

$sel:message:BatchError', batchError_message - Error message, determined by the application.

batchError_arn :: Lens' BatchError (Maybe Text) Source #

Channel ARN.

batchError_code :: Lens' BatchError (Maybe Text) Source #

Error code.

batchError_message :: Lens' BatchError (Maybe Text) Source #

Error message, determined by the application.

Channel

data Channel Source #

Object specifying a channel.

See: newChannel smart constructor.

Constructors

Channel'

Fields

playbackUrl :: Maybe Text
Channel playback URL.
authorized :: Maybe Bool
Whether the channel is private (enabled for playback authorization). Default: false.
arn :: Maybe Text
Channel ARN.
latencyMode :: Maybe ChannelLatencyMode
Channel latency mode. Use NORMAL to broadcast and deliver live video up to Full HD. Use LOW for near-real-time interaction with viewers. Default: LOW. (Note: In the Amazon IVS console, LOW and NORMAL correspond to Ultra-low and Standard, respectively.)
name :: Maybe Text
Channel name.
recordingConfigurationArn :: Maybe Text
Recording-configuration ARN. A value other than an empty string indicates that recording is enabled. Default: "" (empty string, recording is disabled).
type' :: Maybe ChannelType
Channel type, which determines the allowable resolution and bitrate. /If you exceed the allowable resolution or bitrate, the stream probably will disconnect immediately./ Default: STANDARD. Valid values:
- STANDARD: Multiple qualities are generated from the original input, to automatically give viewers the best experience for their devices and network conditions. Resolution can be up to 1080p and bitrate can be up to 8.5 Mbps. Audio is transcoded only for renditions 360p and below; above that, audio is passed through.
- BASIC: Amazon IVS delivers the original input to viewers. The viewer’s video-quality choice is limited to the original input. Resolution can be up to 480p and bitrate can be up to 1.5 Mbps.
tags :: Maybe (HashMap Text Text)
Array of 1-50 maps, each of the form string:string (key:value).
ingestEndpoint :: Maybe Text
Channel ingest endpoint, part of the definition of an ingest server, used when you set up streaming software.

Instances

Instances details

Eq Channel Source #
Instance details Defined in Amazonka.IVS.Types.Channel Methods (==) :: Channel -> Channel -> Bool # (/=) :: Channel -> Channel -> Bool #
Read Channel Source #
Instance details Defined in Amazonka.IVS.Types.Channel Methods readsPrec :: Int -> ReadS Channel # readList :: ReadS [Channel] # readPrec :: ReadPrec Channel # readListPrec :: ReadPrec [Channel] #
Show Channel Source #
Instance details Defined in Amazonka.IVS.Types.Channel Methods showsPrec :: Int -> Channel -> ShowS # show :: Channel -> String # showList :: [Channel] -> ShowS #
Generic Channel Source #
Instance details Defined in Amazonka.IVS.Types.Channel Associated Types type Rep Channel :: Type -> Type # Methods from :: Channel -> Rep Channel x # to :: Rep Channel x -> Channel #
NFData Channel Source #
Instance details Defined in Amazonka.IVS.Types.Channel Methods rnf :: Channel -> () #
Hashable Channel Source #
Instance details Defined in Amazonka.IVS.Types.Channel Methods hashWithSalt :: Int -> Channel -> Int # hash :: Channel -> Int #
FromJSON Channel Source #
Instance details Defined in Amazonka.IVS.Types.Channel Methods parseJSON :: Value -> Parser Channel # parseJSONList :: Value -> Parser [Channel] #
type Rep Channel Source #
Instance details Defined in Amazonka.IVS.Types.Channel type Rep Channel = D1 ('MetaData "Channel" "Amazonka.IVS.Types.Channel" "libZSservicesZSamazonka-ivsZSamazonka-ivs" 'False) (C1 ('MetaCons "Channel'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "playbackUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "authorized") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :: (S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "latencyMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ChannelLatencyMode)))) :: ((S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "recordingConfigurationArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ChannelType)) :: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: S1 ('MetaSel ('Just "ingestEndpoint") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))))

newChannel :: Channel Source #

Create a value of Channel 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:playbackUrl:Channel', channel_playbackUrl - Channel playback URL.

$sel:authorized:Channel', channel_authorized - Whether the channel is private (enabled for playback authorization). Default: false.

$sel:arn:Channel', channel_arn - Channel ARN.

$sel:latencyMode:Channel', channel_latencyMode - Channel latency mode. Use NORMAL to broadcast and deliver live video up to Full HD. Use LOW for near-real-time interaction with viewers. Default: LOW. (Note: In the Amazon IVS console, LOW and NORMAL correspond to Ultra-low and Standard, respectively.)

$sel:name:Channel', channel_name - Channel name.

$sel:recordingConfigurationArn:Channel', channel_recordingConfigurationArn - Recording-configuration ARN. A value other than an empty string indicates that recording is enabled. Default: "" (empty string, recording is disabled).

$sel:type':Channel', channel_type - Channel type, which determines the allowable resolution and bitrate. /If you exceed the allowable resolution or bitrate, the stream probably will disconnect immediately./ Default: STANDARD. Valid values:

STANDARD: Multiple qualities are generated from the original input, to automatically give viewers the best experience for their devices and network conditions. Resolution can be up to 1080p and bitrate can be up to 8.5 Mbps. Audio is transcoded only for renditions 360p and below; above that, audio is passed through.
BASIC: Amazon IVS delivers the original input to viewers. The viewer’s video-quality choice is limited to the original input. Resolution can be up to 480p and bitrate can be up to 1.5 Mbps.

$sel:tags:Channel', channel_tags - Array of 1-50 maps, each of the form string:string (key:value).

$sel:ingestEndpoint:Channel', channel_ingestEndpoint - Channel ingest endpoint, part of the definition of an ingest server, used when you set up streaming software.

channel_playbackUrl :: Lens' Channel (Maybe Text) Source #

Channel playback URL.

channel_authorized :: Lens' Channel (Maybe Bool) Source #

Whether the channel is private (enabled for playback authorization). Default: false.

channel_arn :: Lens' Channel (Maybe Text) Source #

Channel ARN.

channel_latencyMode :: Lens' Channel (Maybe ChannelLatencyMode) Source #

Channel latency mode. Use NORMAL to broadcast and deliver live video up to Full HD. Use LOW for near-real-time interaction with viewers. Default: LOW. (Note: In the Amazon IVS console, LOW and NORMAL correspond to Ultra-low and Standard, respectively.)

channel_name :: Lens' Channel (Maybe Text) Source #

Channel name.

channel_recordingConfigurationArn :: Lens' Channel (Maybe Text) Source #

Recording-configuration ARN. A value other than an empty string indicates that recording is enabled. Default: "" (empty string, recording is disabled).

channel_type :: Lens' Channel (Maybe ChannelType) Source #

Channel type, which determines the allowable resolution and bitrate. /If you exceed the allowable resolution or bitrate, the stream probably will disconnect immediately./ Default: STANDARD. Valid values:

STANDARD: Multiple qualities are generated from the original input, to automatically give viewers the best experience for their devices and network conditions. Resolution can be up to 1080p and bitrate can be up to 8.5 Mbps. Audio is transcoded only for renditions 360p and below; above that, audio is passed through.
BASIC: Amazon IVS delivers the original input to viewers. The viewer’s video-quality choice is limited to the original input. Resolution can be up to 480p and bitrate can be up to 1.5 Mbps.

channel_tags :: Lens' Channel (Maybe (HashMap Text Text)) Source #

Array of 1-50 maps, each of the form string:string (key:value).

channel_ingestEndpoint :: Lens' Channel (Maybe Text) Source #

Channel ingest endpoint, part of the definition of an ingest server, used when you set up streaming software.

ChannelSummary

data ChannelSummary Source #

Summary information about a channel.

See: newChannelSummary smart constructor.

Constructors

ChannelSummary'

Fields

authorized :: Maybe Bool
Whether the channel is private (enabled for playback authorization). Default: false.
arn :: Maybe Text
Channel ARN.
latencyMode :: Maybe ChannelLatencyMode
Channel latency mode. Use NORMAL to broadcast and deliver live video up to Full HD. Use LOW for near-real-time interaction with viewers. Default: LOW. (Note: In the Amazon IVS console, LOW and NORMAL correspond to Ultra-low and Standard, respectively.)
name :: Maybe Text
Channel name.
recordingConfigurationArn :: Maybe Text
Recording-configuration ARN. A value other than an empty string indicates that recording is enabled. Default: "" (empty string, recording is disabled).
tags :: Maybe (HashMap Text Text)
Array of 1-50 maps, each of the form string:string (key:value).

Instances

Instances details

Eq ChannelSummary Source #
Instance details Defined in Amazonka.IVS.Types.ChannelSummary Methods (==) :: ChannelSummary -> ChannelSummary -> Bool # (/=) :: ChannelSummary -> ChannelSummary -> Bool #
Read ChannelSummary Source #
Instance details Defined in Amazonka.IVS.Types.ChannelSummary Methods readsPrec :: Int -> ReadS ChannelSummary # readList :: ReadS [ChannelSummary] # readPrec :: ReadPrec ChannelSummary # readListPrec :: ReadPrec [ChannelSummary] #
Show ChannelSummary Source #
Instance details Defined in Amazonka.IVS.Types.ChannelSummary Methods showsPrec :: Int -> ChannelSummary -> ShowS # show :: ChannelSummary -> String # showList :: [ChannelSummary] -> ShowS #
Generic ChannelSummary Source #
Instance details Defined in Amazonka.IVS.Types.ChannelSummary Associated Types type Rep ChannelSummary :: Type -> Type # Methods from :: ChannelSummary -> Rep ChannelSummary x # to :: Rep ChannelSummary x -> ChannelSummary #
NFData ChannelSummary Source #
Instance details Defined in Amazonka.IVS.Types.ChannelSummary Methods rnf :: ChannelSummary -> () #
Hashable ChannelSummary Source #
Instance details Defined in Amazonka.IVS.Types.ChannelSummary Methods hashWithSalt :: Int -> ChannelSummary -> Int # hash :: ChannelSummary -> Int #
FromJSON ChannelSummary Source #
Instance details Defined in Amazonka.IVS.Types.ChannelSummary Methods parseJSON :: Value -> Parser ChannelSummary # parseJSONList :: Value -> Parser [ChannelSummary] #
type Rep ChannelSummary Source #
Instance details Defined in Amazonka.IVS.Types.ChannelSummary type Rep ChannelSummary = D1 ('MetaData "ChannelSummary" "Amazonka.IVS.Types.ChannelSummary" "libZSservicesZSamazonka-ivsZSamazonka-ivs" 'False) (C1 ('MetaCons "ChannelSummary'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "authorized") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: (S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "latencyMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ChannelLatencyMode)))) :: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "recordingConfigurationArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text)))))))

newChannelSummary :: ChannelSummary Source #

Create a value of ChannelSummary 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:authorized:ChannelSummary', channelSummary_authorized - Whether the channel is private (enabled for playback authorization). Default: false.

$sel:arn:ChannelSummary', channelSummary_arn - Channel ARN.

$sel:latencyMode:ChannelSummary', channelSummary_latencyMode - Channel latency mode. Use NORMAL to broadcast and deliver live video up to Full HD. Use LOW for near-real-time interaction with viewers. Default: LOW. (Note: In the Amazon IVS console, LOW and NORMAL correspond to Ultra-low and Standard, respectively.)

$sel:name:ChannelSummary', channelSummary_name - Channel name.

$sel:recordingConfigurationArn:ChannelSummary', channelSummary_recordingConfigurationArn - Recording-configuration ARN. A value other than an empty string indicates that recording is enabled. Default: "" (empty string, recording is disabled).

$sel:tags:ChannelSummary', channelSummary_tags - Array of 1-50 maps, each of the form string:string (key:value).

channelSummary_authorized :: Lens' ChannelSummary (Maybe Bool) Source #

Whether the channel is private (enabled for playback authorization). Default: false.

channelSummary_arn :: Lens' ChannelSummary (Maybe Text) Source #

Channel ARN.

channelSummary_latencyMode :: Lens' ChannelSummary (Maybe ChannelLatencyMode) Source #

Channel latency mode. Use NORMAL to broadcast and deliver live video up to Full HD. Use LOW for near-real-time interaction with viewers. Default: LOW. (Note: In the Amazon IVS console, LOW and NORMAL correspond to Ultra-low and Standard, respectively.)

channelSummary_name :: Lens' ChannelSummary (Maybe Text) Source #

Channel name.

channelSummary_recordingConfigurationArn :: Lens' ChannelSummary (Maybe Text) Source #

Recording-configuration ARN. A value other than an empty string indicates that recording is enabled. Default: "" (empty string, recording is disabled).

channelSummary_tags :: Lens' ChannelSummary (Maybe (HashMap Text Text)) Source #

Array of 1-50 maps, each of the form string:string (key:value).

DestinationConfiguration

data DestinationConfiguration Source #

A complex type that describes a location where recorded videos will be stored. Each member represents a type of destination configuration. For recording, you define one and only one type of destination configuration.

See: newDestinationConfiguration smart constructor.

Constructors

DestinationConfiguration'
Fields s3 :: Maybe S3DestinationConfiguration An S3 destination configuration where recorded videos will be stored.

Instances

Instances details

Eq DestinationConfiguration Source #
Instance details Defined in Amazonka.IVS.Types.DestinationConfiguration Methods (==) :: DestinationConfiguration -> DestinationConfiguration -> Bool # (/=) :: DestinationConfiguration -> DestinationConfiguration -> Bool #
Read DestinationConfiguration Source #
Instance details Defined in Amazonka.IVS.Types.DestinationConfiguration Methods readsPrec :: Int -> ReadS DestinationConfiguration # readList :: ReadS [DestinationConfiguration] # readPrec :: ReadPrec DestinationConfiguration # readListPrec :: ReadPrec [DestinationConfiguration] #
Show DestinationConfiguration Source #
Instance details Defined in Amazonka.IVS.Types.DestinationConfiguration Methods showsPrec :: Int -> DestinationConfiguration -> ShowS # show :: DestinationConfiguration -> String # showList :: [DestinationConfiguration] -> ShowS #
Generic DestinationConfiguration Source #
Instance details Defined in Amazonka.IVS.Types.DestinationConfiguration Associated Types type Rep DestinationConfiguration :: Type -> Type # Methods from :: DestinationConfiguration -> Rep DestinationConfiguration x # to :: Rep DestinationConfiguration x -> DestinationConfiguration #
NFData DestinationConfiguration Source #
Instance details Defined in Amazonka.IVS.Types.DestinationConfiguration Methods rnf :: DestinationConfiguration -> () #
Hashable DestinationConfiguration Source #
Instance details Defined in Amazonka.IVS.Types.DestinationConfiguration Methods hashWithSalt :: Int -> DestinationConfiguration -> Int # hash :: DestinationConfiguration -> Int #
ToJSON DestinationConfiguration Source #
Instance details Defined in Amazonka.IVS.Types.DestinationConfiguration Methods toJSON :: DestinationConfiguration -> Value # toEncoding :: DestinationConfiguration -> Encoding # toJSONList :: [DestinationConfiguration] -> Value # toEncodingList :: [DestinationConfiguration] -> Encoding #
FromJSON DestinationConfiguration Source #
Instance details Defined in Amazonka.IVS.Types.DestinationConfiguration Methods parseJSON :: Value -> Parser DestinationConfiguration # parseJSONList :: Value -> Parser [DestinationConfiguration] #
type Rep DestinationConfiguration Source #
Instance details Defined in Amazonka.IVS.Types.DestinationConfiguration type Rep DestinationConfiguration = D1 ('MetaData "DestinationConfiguration" "Amazonka.IVS.Types.DestinationConfiguration" "libZSservicesZSamazonka-ivsZSamazonka-ivs" 'False) (C1 ('MetaCons "DestinationConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "s3") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe S3DestinationConfiguration))))

newDestinationConfiguration :: DestinationConfiguration Source #

Create a value of DestinationConfiguration 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:s3:DestinationConfiguration', destinationConfiguration_s3 - An S3 destination configuration where recorded videos will be stored.

destinationConfiguration_s3 :: Lens' DestinationConfiguration (Maybe S3DestinationConfiguration) Source #

An S3 destination configuration where recorded videos will be stored.

PlaybackKeyPair

data PlaybackKeyPair Source #

A key pair used to sign and validate a playback authorization token.

See: newPlaybackKeyPair smart constructor.

Constructors

PlaybackKeyPair'
Fields arn :: Maybe Text Key-pair ARN. fingerprint :: Maybe Text Key-pair identifier. name :: Maybe Text Playback-key-pair name. The value does not need to be unique. tags :: Maybe (HashMap Text Text) Array of 1-50 maps, each of the form `string:string (key:value)`.

Instances

Instances details

Eq PlaybackKeyPair Source #
Instance details Defined in Amazonka.IVS.Types.PlaybackKeyPair Methods (==) :: PlaybackKeyPair -> PlaybackKeyPair -> Bool # (/=) :: PlaybackKeyPair -> PlaybackKeyPair -> Bool #
Read PlaybackKeyPair Source #
Instance details Defined in Amazonka.IVS.Types.PlaybackKeyPair Methods readsPrec :: Int -> ReadS PlaybackKeyPair # readList :: ReadS [PlaybackKeyPair] # readPrec :: ReadPrec PlaybackKeyPair # readListPrec :: ReadPrec [PlaybackKeyPair] #
Show PlaybackKeyPair Source #
Instance details Defined in Amazonka.IVS.Types.PlaybackKeyPair Methods showsPrec :: Int -> PlaybackKeyPair -> ShowS # show :: PlaybackKeyPair -> String # showList :: [PlaybackKeyPair] -> ShowS #
Generic PlaybackKeyPair Source #
Instance details Defined in Amazonka.IVS.Types.PlaybackKeyPair Associated Types type Rep PlaybackKeyPair :: Type -> Type # Methods from :: PlaybackKeyPair -> Rep PlaybackKeyPair x # to :: Rep PlaybackKeyPair x -> PlaybackKeyPair #
NFData PlaybackKeyPair Source #
Instance details Defined in Amazonka.IVS.Types.PlaybackKeyPair Methods rnf :: PlaybackKeyPair -> () #
Hashable PlaybackKeyPair Source #
Instance details Defined in Amazonka.IVS.Types.PlaybackKeyPair Methods hashWithSalt :: Int -> PlaybackKeyPair -> Int # hash :: PlaybackKeyPair -> Int #
FromJSON PlaybackKeyPair Source #
Instance details Defined in Amazonka.IVS.Types.PlaybackKeyPair Methods parseJSON :: Value -> Parser PlaybackKeyPair # parseJSONList :: Value -> Parser [PlaybackKeyPair] #
type Rep PlaybackKeyPair Source #
Instance details Defined in Amazonka.IVS.Types.PlaybackKeyPair type Rep PlaybackKeyPair = D1 ('MetaData "PlaybackKeyPair" "Amazonka.IVS.Types.PlaybackKeyPair" "libZSservicesZSamazonka-ivsZSamazonka-ivs" 'False) (C1 ('MetaCons "PlaybackKeyPair'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "fingerprint") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))))))

newPlaybackKeyPair :: PlaybackKeyPair Source #

Create a value of PlaybackKeyPair 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:arn:PlaybackKeyPair', playbackKeyPair_arn - Key-pair ARN.

$sel:fingerprint:PlaybackKeyPair', playbackKeyPair_fingerprint - Key-pair identifier.

$sel:name:PlaybackKeyPair', playbackKeyPair_name - Playback-key-pair name. The value does not need to be unique.

$sel:tags:PlaybackKeyPair', playbackKeyPair_tags - Array of 1-50 maps, each of the form string:string (key:value).

playbackKeyPair_arn :: Lens' PlaybackKeyPair (Maybe Text) Source #

Key-pair ARN.

playbackKeyPair_fingerprint :: Lens' PlaybackKeyPair (Maybe Text) Source #

Key-pair identifier.

playbackKeyPair_name :: Lens' PlaybackKeyPair (Maybe Text) Source #

Playback-key-pair name. The value does not need to be unique.

playbackKeyPair_tags :: Lens' PlaybackKeyPair (Maybe (HashMap Text Text)) Source #

Array of 1-50 maps, each of the form string:string (key:value).

PlaybackKeyPairSummary

data PlaybackKeyPairSummary Source #

Summary information about a playback key pair.

See: newPlaybackKeyPairSummary smart constructor.

Constructors

PlaybackKeyPairSummary'
Fields arn :: Maybe Text Key-pair ARN. name :: Maybe Text Playback-key-pair name. The value does not need to be unique. tags :: Maybe (HashMap Text Text) Array of 1-50 maps, each of the form `string:string (key:value)`.

Instances

Instances details

Eq PlaybackKeyPairSummary Source #
Instance details Defined in Amazonka.IVS.Types.PlaybackKeyPairSummary Methods (==) :: PlaybackKeyPairSummary -> PlaybackKeyPairSummary -> Bool # (/=) :: PlaybackKeyPairSummary -> PlaybackKeyPairSummary -> Bool #
Read PlaybackKeyPairSummary Source #
Instance details Defined in Amazonka.IVS.Types.PlaybackKeyPairSummary Methods readsPrec :: Int -> ReadS PlaybackKeyPairSummary # readList :: ReadS [PlaybackKeyPairSummary] # readPrec :: ReadPrec PlaybackKeyPairSummary # readListPrec :: ReadPrec [PlaybackKeyPairSummary] #
Show PlaybackKeyPairSummary Source #
Instance details Defined in Amazonka.IVS.Types.PlaybackKeyPairSummary Methods showsPrec :: Int -> PlaybackKeyPairSummary -> ShowS # show :: PlaybackKeyPairSummary -> String # showList :: [PlaybackKeyPairSummary] -> ShowS #
Generic PlaybackKeyPairSummary Source #
Instance details Defined in Amazonka.IVS.Types.PlaybackKeyPairSummary Associated Types type Rep PlaybackKeyPairSummary :: Type -> Type # Methods from :: PlaybackKeyPairSummary -> Rep PlaybackKeyPairSummary x # to :: Rep PlaybackKeyPairSummary x -> PlaybackKeyPairSummary #
NFData PlaybackKeyPairSummary Source #
Instance details Defined in Amazonka.IVS.Types.PlaybackKeyPairSummary Methods rnf :: PlaybackKeyPairSummary -> () #
Hashable PlaybackKeyPairSummary Source #
Instance details Defined in Amazonka.IVS.Types.PlaybackKeyPairSummary Methods hashWithSalt :: Int -> PlaybackKeyPairSummary -> Int # hash :: PlaybackKeyPairSummary -> Int #
FromJSON PlaybackKeyPairSummary Source #
Instance details Defined in Amazonka.IVS.Types.PlaybackKeyPairSummary Methods parseJSON :: Value -> Parser PlaybackKeyPairSummary # parseJSONList :: Value -> Parser [PlaybackKeyPairSummary] #
type Rep PlaybackKeyPairSummary Source #
Instance details Defined in Amazonka.IVS.Types.PlaybackKeyPairSummary type Rep PlaybackKeyPairSummary = D1 ('MetaData "PlaybackKeyPairSummary" "Amazonka.IVS.Types.PlaybackKeyPairSummary" "libZSservicesZSamazonka-ivsZSamazonka-ivs" 'False) (C1 ('MetaCons "PlaybackKeyPairSummary'" 'PrefixI 'True) (S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))))))

newPlaybackKeyPairSummary :: PlaybackKeyPairSummary Source #

Create a value of PlaybackKeyPairSummary 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:arn:PlaybackKeyPairSummary', playbackKeyPairSummary_arn - Key-pair ARN.

$sel:name:PlaybackKeyPairSummary', playbackKeyPairSummary_name - Playback-key-pair name. The value does not need to be unique.

$sel:tags:PlaybackKeyPairSummary', playbackKeyPairSummary_tags - Array of 1-50 maps, each of the form string:string (key:value).

playbackKeyPairSummary_arn :: Lens' PlaybackKeyPairSummary (Maybe Text) Source #

Key-pair ARN.

playbackKeyPairSummary_name :: Lens' PlaybackKeyPairSummary (Maybe Text) Source #

Playback-key-pair name. The value does not need to be unique.

playbackKeyPairSummary_tags :: Lens' PlaybackKeyPairSummary (Maybe (HashMap Text Text)) Source #

Array of 1-50 maps, each of the form string:string (key:value).

RecordingConfiguration

data RecordingConfiguration Source #

An object representing a configuration to record a channel stream.

See: newRecordingConfiguration smart constructor.

Constructors

RecordingConfiguration'

Fields

name :: Maybe Text
Recording-configuration name. The value does not need to be unique.
tags :: Maybe (HashMap Text Text)
Array of 1-50 maps, each of the form string:string (key:value).
arn :: Text
Recording-configuration ARN.
destinationConfiguration :: DestinationConfiguration
A complex type that contains information about where recorded video will be stored.
state :: RecordingConfigurationState
Indicates the current state of the recording configuration. When the state is ACTIVE, the configuration is ready for recording a channel stream.

Instances

Instances details

Eq RecordingConfiguration Source #
Instance details Defined in Amazonka.IVS.Types.RecordingConfiguration Methods (==) :: RecordingConfiguration -> RecordingConfiguration -> Bool # (/=) :: RecordingConfiguration -> RecordingConfiguration -> Bool #
Read RecordingConfiguration Source #
Instance details Defined in Amazonka.IVS.Types.RecordingConfiguration Methods readsPrec :: Int -> ReadS RecordingConfiguration # readList :: ReadS [RecordingConfiguration] # readPrec :: ReadPrec RecordingConfiguration # readListPrec :: ReadPrec [RecordingConfiguration] #
Show RecordingConfiguration Source #
Instance details Defined in Amazonka.IVS.Types.RecordingConfiguration Methods showsPrec :: Int -> RecordingConfiguration -> ShowS # show :: RecordingConfiguration -> String # showList :: [RecordingConfiguration] -> ShowS #
Generic RecordingConfiguration Source #
Instance details Defined in Amazonka.IVS.Types.RecordingConfiguration Associated Types type Rep RecordingConfiguration :: Type -> Type # Methods from :: RecordingConfiguration -> Rep RecordingConfiguration x # to :: Rep RecordingConfiguration x -> RecordingConfiguration #
NFData RecordingConfiguration Source #
Instance details Defined in Amazonka.IVS.Types.RecordingConfiguration Methods rnf :: RecordingConfiguration -> () #
Hashable RecordingConfiguration Source #
Instance details Defined in Amazonka.IVS.Types.RecordingConfiguration Methods hashWithSalt :: Int -> RecordingConfiguration -> Int # hash :: RecordingConfiguration -> Int #
FromJSON RecordingConfiguration Source #
Instance details Defined in Amazonka.IVS.Types.RecordingConfiguration Methods parseJSON :: Value -> Parser RecordingConfiguration # parseJSONList :: Value -> Parser [RecordingConfiguration] #
type Rep RecordingConfiguration Source #
Instance details Defined in Amazonka.IVS.Types.RecordingConfiguration type Rep RecordingConfiguration = D1 ('MetaData "RecordingConfiguration" "Amazonka.IVS.Types.RecordingConfiguration" "libZSservicesZSamazonka-ivsZSamazonka-ivs" 'False) (C1 ('MetaCons "RecordingConfiguration'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text)))) :: (S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "destinationConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DestinationConfiguration) :: S1 ('MetaSel ('Just "state") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 RecordingConfigurationState)))))

newRecordingConfiguration Source #

Arguments

:: Text	`$sel:arn:RecordingConfiguration'`
-> DestinationConfiguration	`$sel:destinationConfiguration:RecordingConfiguration'`
-> RecordingConfigurationState	`$sel:state:RecordingConfiguration'`
-> RecordingConfiguration

Create a value of RecordingConfiguration 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:name:RecordingConfiguration', recordingConfiguration_name - Recording-configuration name. The value does not need to be unique.

$sel:tags:RecordingConfiguration', recordingConfiguration_tags - Array of 1-50 maps, each of the form string:string (key:value).

$sel:arn:RecordingConfiguration', recordingConfiguration_arn - Recording-configuration ARN.

$sel:destinationConfiguration:RecordingConfiguration', recordingConfiguration_destinationConfiguration - A complex type that contains information about where recorded video will be stored.

$sel:state:RecordingConfiguration', recordingConfiguration_state - Indicates the current state of the recording configuration. When the state is ACTIVE, the configuration is ready for recording a channel stream.

recordingConfiguration_name :: Lens' RecordingConfiguration (Maybe Text) Source #

Recording-configuration name. The value does not need to be unique.

recordingConfiguration_tags :: Lens' RecordingConfiguration (Maybe (HashMap Text Text)) Source #

Array of 1-50 maps, each of the form string:string (key:value).

recordingConfiguration_arn :: Lens' RecordingConfiguration Text Source #

Recording-configuration ARN.

recordingConfiguration_destinationConfiguration :: Lens' RecordingConfiguration DestinationConfiguration Source #

A complex type that contains information about where recorded video will be stored.

recordingConfiguration_state :: Lens' RecordingConfiguration RecordingConfigurationState Source #

Indicates the current state of the recording configuration. When the state is ACTIVE, the configuration is ready for recording a channel stream.

RecordingConfigurationSummary

data RecordingConfigurationSummary Source #

Summary information about a RecordingConfiguration.

See: newRecordingConfigurationSummary smart constructor.

Constructors

RecordingConfigurationSummary'

Fields

name :: Maybe Text
Recording-configuration name. The value does not need to be unique.
tags :: Maybe (HashMap Text Text)
Array of 1-50 maps, each of the form string:string (key:value).
arn :: Text
Recording-configuration ARN.
destinationConfiguration :: DestinationConfiguration
A complex type that contains information about where recorded video will be stored.
state :: RecordingConfigurationState
Indicates the current state of the recording configuration. When the state is ACTIVE, the configuration is ready for recording a channel stream.

Instances

Instances details

Eq RecordingConfigurationSummary Source #
Instance details Defined in Amazonka.IVS.Types.RecordingConfigurationSummary Methods (==) :: RecordingConfigurationSummary -> RecordingConfigurationSummary -> Bool # (/=) :: RecordingConfigurationSummary -> RecordingConfigurationSummary -> Bool #
Read RecordingConfigurationSummary Source #
Instance details Defined in Amazonka.IVS.Types.RecordingConfigurationSummary Methods readsPrec :: Int -> ReadS RecordingConfigurationSummary # readList :: ReadS [RecordingConfigurationSummary] # readPrec :: ReadPrec RecordingConfigurationSummary # readListPrec :: ReadPrec [RecordingConfigurationSummary] #
Show RecordingConfigurationSummary Source #
Instance details Defined in Amazonka.IVS.Types.RecordingConfigurationSummary Methods showsPrec :: Int -> RecordingConfigurationSummary -> ShowS # show :: RecordingConfigurationSummary -> String # showList :: [RecordingConfigurationSummary] -> ShowS #
Generic RecordingConfigurationSummary Source #
Instance details Defined in Amazonka.IVS.Types.RecordingConfigurationSummary Associated Types type Rep RecordingConfigurationSummary :: Type -> Type # Methods from :: RecordingConfigurationSummary -> Rep RecordingConfigurationSummary x # to :: Rep RecordingConfigurationSummary x -> RecordingConfigurationSummary #
NFData RecordingConfigurationSummary Source #
Instance details Defined in Amazonka.IVS.Types.RecordingConfigurationSummary Methods rnf :: RecordingConfigurationSummary -> () #
Hashable RecordingConfigurationSummary Source #
Instance details Defined in Amazonka.IVS.Types.RecordingConfigurationSummary Methods hashWithSalt :: Int -> RecordingConfigurationSummary -> Int # hash :: RecordingConfigurationSummary -> Int #
FromJSON RecordingConfigurationSummary Source #
Instance details Defined in Amazonka.IVS.Types.RecordingConfigurationSummary Methods parseJSON :: Value -> Parser RecordingConfigurationSummary # parseJSONList :: Value -> Parser [RecordingConfigurationSummary] #
type Rep RecordingConfigurationSummary Source #
Instance details Defined in Amazonka.IVS.Types.RecordingConfigurationSummary type Rep RecordingConfigurationSummary = D1 ('MetaData "RecordingConfigurationSummary" "Amazonka.IVS.Types.RecordingConfigurationSummary" "libZSservicesZSamazonka-ivsZSamazonka-ivs" 'False) (C1 ('MetaCons "RecordingConfigurationSummary'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text)))) :: (S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "destinationConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DestinationConfiguration) :: S1 ('MetaSel ('Just "state") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 RecordingConfigurationState)))))

newRecordingConfigurationSummary Source #

Arguments

:: Text	`$sel:arn:RecordingConfigurationSummary'`
-> DestinationConfiguration	`$sel:destinationConfiguration:RecordingConfigurationSummary'`
-> RecordingConfigurationState	`$sel:state:RecordingConfigurationSummary'`
-> RecordingConfigurationSummary

Create a value of RecordingConfigurationSummary 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:name:RecordingConfigurationSummary', recordingConfigurationSummary_name - Recording-configuration name. The value does not need to be unique.

$sel:tags:RecordingConfigurationSummary', recordingConfigurationSummary_tags - Array of 1-50 maps, each of the form string:string (key:value).

$sel:arn:RecordingConfigurationSummary', recordingConfigurationSummary_arn - Recording-configuration ARN.

$sel:destinationConfiguration:RecordingConfigurationSummary', recordingConfigurationSummary_destinationConfiguration - A complex type that contains information about where recorded video will be stored.

$sel:state:RecordingConfigurationSummary', recordingConfigurationSummary_state - Indicates the current state of the recording configuration. When the state is ACTIVE, the configuration is ready for recording a channel stream.

recordingConfigurationSummary_name :: Lens' RecordingConfigurationSummary (Maybe Text) Source #

Recording-configuration name. The value does not need to be unique.

recordingConfigurationSummary_tags :: Lens' RecordingConfigurationSummary (Maybe (HashMap Text Text)) Source #

Array of 1-50 maps, each of the form string:string (key:value).

recordingConfigurationSummary_arn :: Lens' RecordingConfigurationSummary Text Source #

Recording-configuration ARN.

recordingConfigurationSummary_destinationConfiguration :: Lens' RecordingConfigurationSummary DestinationConfiguration Source #

A complex type that contains information about where recorded video will be stored.

recordingConfigurationSummary_state :: Lens' RecordingConfigurationSummary RecordingConfigurationState Source #

Indicates the current state of the recording configuration. When the state is ACTIVE, the configuration is ready for recording a channel stream.

S3DestinationConfiguration

data S3DestinationConfiguration Source #

A complex type that describes an S3 location where recorded videos will be stored.

See: newS3DestinationConfiguration smart constructor.

Constructors

S3DestinationConfiguration'
Fields bucketName :: Text Location (S3 bucket name) where recorded videos will be stored.

Instances

Instances details

Eq S3DestinationConfiguration Source #
Instance details Defined in Amazonka.IVS.Types.S3DestinationConfiguration Methods (==) :: S3DestinationConfiguration -> S3DestinationConfiguration -> Bool # (/=) :: S3DestinationConfiguration -> S3DestinationConfiguration -> Bool #
Read S3DestinationConfiguration Source #
Instance details Defined in Amazonka.IVS.Types.S3DestinationConfiguration Methods readsPrec :: Int -> ReadS S3DestinationConfiguration # readList :: ReadS [S3DestinationConfiguration] # readPrec :: ReadPrec S3DestinationConfiguration # readListPrec :: ReadPrec [S3DestinationConfiguration] #
Show S3DestinationConfiguration Source #
Instance details Defined in Amazonka.IVS.Types.S3DestinationConfiguration Methods showsPrec :: Int -> S3DestinationConfiguration -> ShowS # show :: S3DestinationConfiguration -> String # showList :: [S3DestinationConfiguration] -> ShowS #
Generic S3DestinationConfiguration Source #
Instance details Defined in Amazonka.IVS.Types.S3DestinationConfiguration Associated Types type Rep S3DestinationConfiguration :: Type -> Type # Methods from :: S3DestinationConfiguration -> Rep S3DestinationConfiguration x # to :: Rep S3DestinationConfiguration x -> S3DestinationConfiguration #
NFData S3DestinationConfiguration Source #
Instance details Defined in Amazonka.IVS.Types.S3DestinationConfiguration Methods rnf :: S3DestinationConfiguration -> () #
Hashable S3DestinationConfiguration Source #
Instance details Defined in Amazonka.IVS.Types.S3DestinationConfiguration Methods hashWithSalt :: Int -> S3DestinationConfiguration -> Int # hash :: S3DestinationConfiguration -> Int #
ToJSON S3DestinationConfiguration Source #
Instance details Defined in Amazonka.IVS.Types.S3DestinationConfiguration Methods toJSON :: S3DestinationConfiguration -> Value # toEncoding :: S3DestinationConfiguration -> Encoding # toJSONList :: [S3DestinationConfiguration] -> Value # toEncodingList :: [S3DestinationConfiguration] -> Encoding #
FromJSON S3DestinationConfiguration Source #
Instance details Defined in Amazonka.IVS.Types.S3DestinationConfiguration Methods parseJSON :: Value -> Parser S3DestinationConfiguration # parseJSONList :: Value -> Parser [S3DestinationConfiguration] #
type Rep S3DestinationConfiguration Source #
Instance details Defined in Amazonka.IVS.Types.S3DestinationConfiguration type Rep S3DestinationConfiguration = D1 ('MetaData "S3DestinationConfiguration" "Amazonka.IVS.Types.S3DestinationConfiguration" "libZSservicesZSamazonka-ivsZSamazonka-ivs" 'False) (C1 ('MetaCons "S3DestinationConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "bucketName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newS3DestinationConfiguration Source #

Arguments

:: Text	`$sel:bucketName:S3DestinationConfiguration'`
-> S3DestinationConfiguration

Create a value of S3DestinationConfiguration 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:bucketName:S3DestinationConfiguration', s3DestinationConfiguration_bucketName - Location (S3 bucket name) where recorded videos will be stored.

s3DestinationConfiguration_bucketName :: Lens' S3DestinationConfiguration Text Source #

Location (S3 bucket name) where recorded videos will be stored.

Stream

data Stream Source #

Specifies a live video stream that has been ingested and distributed.

See: newStream smart constructor.

Constructors

Stream'

Fields

playbackUrl :: Maybe Text
URL of the master playlist, required by the video player to play the HLS stream.
state :: Maybe StreamState
The stream’s state.
startTime :: Maybe POSIX
Time of the stream’s start. This is an ISO 8601 timestamp returned as a string.
channelArn :: Maybe Text
Channel ARN for the stream.
viewerCount :: Maybe Integer
A count of concurrent views of the stream. Typically, a new view appears in viewerCount within 15 seconds of when video playback starts and a view is removed from viewerCount within 1 minute of when video playback ends. A value of -1 indicates that the request timed out; in this case, retry.
health :: Maybe StreamHealth
The stream’s health.

Instances

Instances details

Eq Stream Source #
Instance details Defined in Amazonka.IVS.Types.Stream Methods (==) :: Stream -> Stream -> Bool # (/=) :: Stream -> Stream -> Bool #
Read Stream Source #
Instance details Defined in Amazonka.IVS.Types.Stream Methods readsPrec :: Int -> ReadS Stream # readList :: ReadS [Stream] # readPrec :: ReadPrec Stream # readListPrec :: ReadPrec [Stream] #
Show Stream Source #
Instance details Defined in Amazonka.IVS.Types.Stream Methods showsPrec :: Int -> Stream -> ShowS # show :: Stream -> String # showList :: [Stream] -> ShowS #
Generic Stream Source #
Instance details Defined in Amazonka.IVS.Types.Stream Associated Types type Rep Stream :: Type -> Type # Methods from :: Stream -> Rep Stream x # to :: Rep Stream x -> Stream #
NFData Stream Source #
Instance details Defined in Amazonka.IVS.Types.Stream Methods rnf :: Stream -> () #
Hashable Stream Source #
Instance details Defined in Amazonka.IVS.Types.Stream Methods hashWithSalt :: Int -> Stream -> Int # hash :: Stream -> Int #
FromJSON Stream Source #
Instance details Defined in Amazonka.IVS.Types.Stream Methods parseJSON :: Value -> Parser Stream # parseJSONList :: Value -> Parser [Stream] #
type Rep Stream Source #
Instance details Defined in Amazonka.IVS.Types.Stream type Rep Stream = D1 ('MetaData "Stream" "Amazonka.IVS.Types.Stream" "libZSservicesZSamazonka-ivsZSamazonka-ivs" 'False) (C1 ('MetaCons "Stream'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "playbackUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "state") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe StreamState)) :: S1 ('MetaSel ('Just "startTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)))) :: (S1 ('MetaSel ('Just "channelArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "viewerCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :*: S1 ('MetaSel ('Just "health") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe StreamHealth))))))

newStream :: Stream Source #

Create a value of Stream 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:playbackUrl:Stream', stream_playbackUrl - URL of the master playlist, required by the video player to play the HLS stream.

$sel:state:Stream', stream_state - The stream’s state.

$sel:startTime:Stream', stream_startTime - Time of the stream’s start. This is an ISO 8601 timestamp returned as a string.

$sel:channelArn:Stream', stream_channelArn - Channel ARN for the stream.

$sel:viewerCount:Stream', stream_viewerCount - A count of concurrent views of the stream. Typically, a new view appears in viewerCount within 15 seconds of when video playback starts and a view is removed from viewerCount within 1 minute of when video playback ends. A value of -1 indicates that the request timed out; in this case, retry.

$sel:health:Stream', stream_health - The stream’s health.

stream_playbackUrl :: Lens' Stream (Maybe Text) Source #

URL of the master playlist, required by the video player to play the HLS stream.

stream_state :: Lens' Stream (Maybe StreamState) Source #

The stream’s state.

stream_startTime :: Lens' Stream (Maybe UTCTime) Source #

Time of the stream’s start. This is an ISO 8601 timestamp returned as a string.

stream_channelArn :: Lens' Stream (Maybe Text) Source #

Channel ARN for the stream.

stream_viewerCount :: Lens' Stream (Maybe Integer) Source #

A count of concurrent views of the stream. Typically, a new view appears in viewerCount within 15 seconds of when video playback starts and a view is removed from viewerCount within 1 minute of when video playback ends. A value of -1 indicates that the request timed out; in this case, retry.

stream_health :: Lens' Stream (Maybe StreamHealth) Source #

The stream’s health.

StreamKey

data StreamKey Source #

Object specifying a stream key.

See: newStreamKey smart constructor.

Constructors

StreamKey'
Fields arn :: Maybe Text Stream-key ARN. value :: Maybe (Sensitive Text) Stream-key value. channelArn :: Maybe Text Channel ARN for the stream. tags :: Maybe (HashMap Text Text) Array of 1-50 maps, each of the form `string:string (key:value)`.

Instances

Instances details

Eq StreamKey Source #
Instance details Defined in Amazonka.IVS.Types.StreamKey Methods (==) :: StreamKey -> StreamKey -> Bool # (/=) :: StreamKey -> StreamKey -> Bool #
Show StreamKey Source #
Instance details Defined in Amazonka.IVS.Types.StreamKey Methods showsPrec :: Int -> StreamKey -> ShowS # show :: StreamKey -> String # showList :: [StreamKey] -> ShowS #
Generic StreamKey Source #
Instance details Defined in Amazonka.IVS.Types.StreamKey Associated Types type Rep StreamKey :: Type -> Type # Methods from :: StreamKey -> Rep StreamKey x # to :: Rep StreamKey x -> StreamKey #
NFData StreamKey Source #
Instance details Defined in Amazonka.IVS.Types.StreamKey Methods rnf :: StreamKey -> () #
Hashable StreamKey Source #
Instance details Defined in Amazonka.IVS.Types.StreamKey Methods hashWithSalt :: Int -> StreamKey -> Int # hash :: StreamKey -> Int #
FromJSON StreamKey Source #
Instance details Defined in Amazonka.IVS.Types.StreamKey Methods parseJSON :: Value -> Parser StreamKey # parseJSONList :: Value -> Parser [StreamKey] #
type Rep StreamKey Source #
Instance details Defined in Amazonka.IVS.Types.StreamKey type Rep StreamKey = D1 ('MetaData "StreamKey" "Amazonka.IVS.Types.StreamKey" "libZSservicesZSamazonka-ivsZSamazonka-ivs" 'False) (C1 ('MetaCons "StreamKey'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text)))) :: (S1 ('MetaSel ('Just "channelArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))))))

newStreamKey :: StreamKey Source #

Create a value of StreamKey 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:arn:StreamKey', streamKey_arn - Stream-key ARN.

$sel:value:StreamKey', streamKey_value - Stream-key value.

$sel:channelArn:StreamKey', streamKey_channelArn - Channel ARN for the stream.

$sel:tags:StreamKey', streamKey_tags - Array of 1-50 maps, each of the form string:string (key:value).

streamKey_arn :: Lens' StreamKey (Maybe Text) Source #

Stream-key ARN.

streamKey_value :: Lens' StreamKey (Maybe Text) Source #

Stream-key value.

streamKey_channelArn :: Lens' StreamKey (Maybe Text) Source #

Channel ARN for the stream.

streamKey_tags :: Lens' StreamKey (Maybe (HashMap Text Text)) Source #

Array of 1-50 maps, each of the form string:string (key:value).

StreamKeySummary

data StreamKeySummary Source #

Summary information about a stream key.

See: newStreamKeySummary smart constructor.

Constructors

StreamKeySummary'
Fields arn :: Maybe Text Stream-key ARN. channelArn :: Maybe Text Channel ARN for the stream. tags :: Maybe (HashMap Text Text) Array of 1-50 maps, each of the form `string:string (key:value)`.

Instances

Instances details

Eq StreamKeySummary Source #
Instance details Defined in Amazonka.IVS.Types.StreamKeySummary Methods (==) :: StreamKeySummary -> StreamKeySummary -> Bool # (/=) :: StreamKeySummary -> StreamKeySummary -> Bool #
Read StreamKeySummary Source #
Instance details Defined in Amazonka.IVS.Types.StreamKeySummary Methods readsPrec :: Int -> ReadS StreamKeySummary # readList :: ReadS [StreamKeySummary] # readPrec :: ReadPrec StreamKeySummary # readListPrec :: ReadPrec [StreamKeySummary] #
Show StreamKeySummary Source #
Instance details Defined in Amazonka.IVS.Types.StreamKeySummary Methods showsPrec :: Int -> StreamKeySummary -> ShowS # show :: StreamKeySummary -> String # showList :: [StreamKeySummary] -> ShowS #
Generic StreamKeySummary Source #
Instance details Defined in Amazonka.IVS.Types.StreamKeySummary Associated Types type Rep StreamKeySummary :: Type -> Type # Methods from :: StreamKeySummary -> Rep StreamKeySummary x # to :: Rep StreamKeySummary x -> StreamKeySummary #
NFData StreamKeySummary Source #
Instance details Defined in Amazonka.IVS.Types.StreamKeySummary Methods rnf :: StreamKeySummary -> () #
Hashable StreamKeySummary Source #
Instance details Defined in Amazonka.IVS.Types.StreamKeySummary Methods hashWithSalt :: Int -> StreamKeySummary -> Int # hash :: StreamKeySummary -> Int #
FromJSON StreamKeySummary Source #
Instance details Defined in Amazonka.IVS.Types.StreamKeySummary Methods parseJSON :: Value -> Parser StreamKeySummary # parseJSONList :: Value -> Parser [StreamKeySummary] #
type Rep StreamKeySummary Source #
Instance details Defined in Amazonka.IVS.Types.StreamKeySummary type Rep StreamKeySummary = D1 ('MetaData "StreamKeySummary" "Amazonka.IVS.Types.StreamKeySummary" "libZSservicesZSamazonka-ivsZSamazonka-ivs" 'False) (C1 ('MetaCons "StreamKeySummary'" 'PrefixI 'True) (S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "channelArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))))))

newStreamKeySummary :: StreamKeySummary Source #

Create a value of StreamKeySummary 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:arn:StreamKeySummary', streamKeySummary_arn - Stream-key ARN.

$sel:channelArn:StreamKeySummary', streamKeySummary_channelArn - Channel ARN for the stream.

$sel:tags:StreamKeySummary', streamKeySummary_tags - Array of 1-50 maps, each of the form string:string (key:value).

streamKeySummary_arn :: Lens' StreamKeySummary (Maybe Text) Source #

Stream-key ARN.

streamKeySummary_channelArn :: Lens' StreamKeySummary (Maybe Text) Source #

Channel ARN for the stream.

streamKeySummary_tags :: Lens' StreamKeySummary (Maybe (HashMap Text Text)) Source #

Array of 1-50 maps, each of the form string:string (key:value).

StreamSummary

data StreamSummary Source #

Summary information about a stream.

See: newStreamSummary smart constructor.

Constructors

StreamSummary'

Fields

state :: Maybe StreamState
The stream’s state.
startTime :: Maybe POSIX
Time of the stream’s start. This is an ISO 8601 timestamp returned as a string.
channelArn :: Maybe Text
Channel ARN for the stream.
viewerCount :: Maybe Integer
A count of concurrent views of the stream. Typically, a new view appears in viewerCount within 15 seconds of when video playback starts and a view is removed from viewerCount within 1 minute of when video playback ends. A value of -1 indicates that the request timed out; in this case, retry.
health :: Maybe StreamHealth
The stream’s health.

Instances

Instances details

Eq StreamSummary Source #
Instance details Defined in Amazonka.IVS.Types.StreamSummary Methods (==) :: StreamSummary -> StreamSummary -> Bool # (/=) :: StreamSummary -> StreamSummary -> Bool #
Read StreamSummary Source #
Instance details Defined in Amazonka.IVS.Types.StreamSummary Methods readsPrec :: Int -> ReadS StreamSummary # readList :: ReadS [StreamSummary] # readPrec :: ReadPrec StreamSummary # readListPrec :: ReadPrec [StreamSummary] #
Show StreamSummary Source #
Instance details Defined in Amazonka.IVS.Types.StreamSummary Methods showsPrec :: Int -> StreamSummary -> ShowS # show :: StreamSummary -> String # showList :: [StreamSummary] -> ShowS #
Generic StreamSummary Source #
Instance details Defined in Amazonka.IVS.Types.StreamSummary Associated Types type Rep StreamSummary :: Type -> Type # Methods from :: StreamSummary -> Rep StreamSummary x # to :: Rep StreamSummary x -> StreamSummary #
NFData StreamSummary Source #
Instance details Defined in Amazonka.IVS.Types.StreamSummary Methods rnf :: StreamSummary -> () #
Hashable StreamSummary Source #
Instance details Defined in Amazonka.IVS.Types.StreamSummary Methods hashWithSalt :: Int -> StreamSummary -> Int # hash :: StreamSummary -> Int #
FromJSON StreamSummary Source #
Instance details Defined in Amazonka.IVS.Types.StreamSummary Methods parseJSON :: Value -> Parser StreamSummary # parseJSONList :: Value -> Parser [StreamSummary] #
type Rep StreamSummary Source #
Instance details Defined in Amazonka.IVS.Types.StreamSummary type Rep StreamSummary = D1 ('MetaData "StreamSummary" "Amazonka.IVS.Types.StreamSummary" "libZSservicesZSamazonka-ivsZSamazonka-ivs" 'False) (C1 ('MetaCons "StreamSummary'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "state") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe StreamState)) :: S1 ('MetaSel ('Just "startTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :: (S1 ('MetaSel ('Just "channelArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "viewerCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :: S1 ('MetaSel ('Just "health") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe StreamHealth))))))

newStreamSummary :: StreamSummary Source #

Create a value of StreamSummary 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:state:StreamSummary', streamSummary_state - The stream’s state.

$sel:startTime:StreamSummary', streamSummary_startTime - Time of the stream’s start. This is an ISO 8601 timestamp returned as a string.

$sel:channelArn:StreamSummary', streamSummary_channelArn - Channel ARN for the stream.

$sel:viewerCount:StreamSummary', streamSummary_viewerCount - A count of concurrent views of the stream. Typically, a new view appears in viewerCount within 15 seconds of when video playback starts and a view is removed from viewerCount within 1 minute of when video playback ends. A value of -1 indicates that the request timed out; in this case, retry.

$sel:health:StreamSummary', streamSummary_health - The stream’s health.

streamSummary_state :: Lens' StreamSummary (Maybe StreamState) Source #

The stream’s state.

streamSummary_startTime :: Lens' StreamSummary (Maybe UTCTime) Source #

Time of the stream’s start. This is an ISO 8601 timestamp returned as a string.

streamSummary_channelArn :: Lens' StreamSummary (Maybe Text) Source #

Channel ARN for the stream.

streamSummary_viewerCount :: Lens' StreamSummary (Maybe Integer) Source #

A count of concurrent views of the stream. Typically, a new view appears in viewerCount within 15 seconds of when video playback starts and a view is removed from viewerCount within 1 minute of when video playback ends. A value of -1 indicates that the request timed out; in this case, retry.

streamSummary_health :: Lens' StreamSummary (Maybe StreamHealth) Source #

The stream’s health.