Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.IVS.Types

Contents

Service Configuration
Errors
ChannelLatencyMode
ChannelType
RecordingConfigurationState
RecordingMode
StreamHealth
StreamState
AudioConfiguration
BatchError
Channel
ChannelSummary
DestinationConfiguration
IngestConfiguration
PlaybackKeyPair
PlaybackKeyPairSummary
RecordingConfiguration
RecordingConfigurationSummary
S3DestinationConfiguration
Stream
StreamEvent
StreamFilters
StreamKey
StreamKeySummary
StreamSession
StreamSessionSummary
StreamSummary
ThumbnailConfiguration
VideoConfiguration

Description

Synopsis

defaultService :: Service
_AccessDeniedException :: AsError a => Fold a ServiceError
_ChannelNotBroadcasting :: AsError a => Fold a ServiceError
_ConflictException :: AsError a => Fold a ServiceError
_InternalServerException :: AsError a => Fold a ServiceError
_PendingVerification :: AsError a => Fold a ServiceError
_ResourceNotFoundException :: AsError a => Fold a ServiceError
_ServiceQuotaExceededException :: AsError a => Fold a ServiceError
_StreamUnavailable :: AsError a => Fold a ServiceError
_ThrottlingException :: AsError a => Fold a ServiceError
_ValidationException :: AsError a => Fold 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 RecordingMode where
- RecordingMode' {
  - fromRecordingMode :: Text
  }
- pattern RecordingMode_DISABLED :: RecordingMode
- pattern RecordingMode_INTERVAL :: RecordingMode
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 AudioConfiguration = AudioConfiguration' {
- channels :: Maybe Integer
- codec :: Maybe Text
- sampleRate :: Maybe Integer
- targetBitrate :: Maybe Integer
}
newAudioConfiguration :: AudioConfiguration
audioConfiguration_channels :: Lens' AudioConfiguration (Maybe Integer)
audioConfiguration_codec :: Lens' AudioConfiguration (Maybe Text)
audioConfiguration_sampleRate :: Lens' AudioConfiguration (Maybe Integer)
audioConfiguration_targetBitrate :: Lens' AudioConfiguration (Maybe Integer)
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' {
- arn :: Maybe Text
- authorized :: Maybe Bool
- ingestEndpoint :: Maybe Text
- latencyMode :: Maybe ChannelLatencyMode
- name :: Maybe Text
- playbackUrl :: Maybe Text
- recordingConfigurationArn :: Maybe Text
- tags :: Maybe (HashMap Text Text)
- type' :: Maybe ChannelType
}
newChannel :: Channel
channel_arn :: Lens' Channel (Maybe Text)
channel_authorized :: Lens' Channel (Maybe Bool)
channel_ingestEndpoint :: Lens' Channel (Maybe Text)
channel_latencyMode :: Lens' Channel (Maybe ChannelLatencyMode)
channel_name :: Lens' Channel (Maybe Text)
channel_playbackUrl :: Lens' Channel (Maybe Text)
channel_recordingConfigurationArn :: Lens' Channel (Maybe Text)
channel_tags :: Lens' Channel (Maybe (HashMap Text Text))
channel_type :: Lens' Channel (Maybe ChannelType)
data ChannelSummary = ChannelSummary' {
- arn :: Maybe Text
- authorized :: Maybe Bool
- latencyMode :: Maybe ChannelLatencyMode
- name :: Maybe Text
- recordingConfigurationArn :: Maybe Text
- tags :: Maybe (HashMap Text Text)
}
newChannelSummary :: ChannelSummary
channelSummary_arn :: Lens' ChannelSummary (Maybe Text)
channelSummary_authorized :: Lens' ChannelSummary (Maybe Bool)
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 IngestConfiguration = IngestConfiguration' {
- audio :: Maybe AudioConfiguration
- video :: Maybe VideoConfiguration
}
newIngestConfiguration :: IngestConfiguration
ingestConfiguration_audio :: Lens' IngestConfiguration (Maybe AudioConfiguration)
ingestConfiguration_video :: Lens' IngestConfiguration (Maybe VideoConfiguration)
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
- recordingReconnectWindowSeconds :: Maybe Natural
- tags :: Maybe (HashMap Text Text)
- thumbnailConfiguration :: Maybe ThumbnailConfiguration
- arn :: Text
- destinationConfiguration :: DestinationConfiguration
- state :: RecordingConfigurationState
}
newRecordingConfiguration :: Text -> DestinationConfiguration -> RecordingConfigurationState -> RecordingConfiguration
recordingConfiguration_name :: Lens' RecordingConfiguration (Maybe Text)
recordingConfiguration_recordingReconnectWindowSeconds :: Lens' RecordingConfiguration (Maybe Natural)
recordingConfiguration_tags :: Lens' RecordingConfiguration (Maybe (HashMap Text Text))
recordingConfiguration_thumbnailConfiguration :: Lens' RecordingConfiguration (Maybe ThumbnailConfiguration)
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' {
- channelArn :: Maybe Text
- health :: Maybe StreamHealth
- playbackUrl :: Maybe Text
- startTime :: Maybe ISO8601
- state :: Maybe StreamState
- streamId :: Maybe Text
- viewerCount :: Maybe Integer
}
newStream :: Stream
stream_channelArn :: Lens' Stream (Maybe Text)
stream_health :: Lens' Stream (Maybe StreamHealth)
stream_playbackUrl :: Lens' Stream (Maybe Text)
stream_startTime :: Lens' Stream (Maybe UTCTime)
stream_state :: Lens' Stream (Maybe StreamState)
stream_streamId :: Lens' Stream (Maybe Text)
stream_viewerCount :: Lens' Stream (Maybe Integer)
data StreamEvent = StreamEvent' {
- eventTime :: Maybe ISO8601
- name :: Maybe Text
- type' :: Maybe Text
}
newStreamEvent :: StreamEvent
streamEvent_eventTime :: Lens' StreamEvent (Maybe UTCTime)
streamEvent_name :: Lens' StreamEvent (Maybe Text)
streamEvent_type :: Lens' StreamEvent (Maybe Text)
data StreamFilters = StreamFilters' {
- health :: Maybe StreamHealth
}
newStreamFilters :: StreamFilters
streamFilters_health :: Lens' StreamFilters (Maybe StreamHealth)
data StreamKey = StreamKey' {
- arn :: Maybe Text
- channelArn :: Maybe Text
- tags :: Maybe (HashMap Text Text)
- value :: Maybe (Sensitive Text)
}
newStreamKey :: StreamKey
streamKey_arn :: Lens' StreamKey (Maybe Text)
streamKey_channelArn :: Lens' StreamKey (Maybe Text)
streamKey_tags :: Lens' StreamKey (Maybe (HashMap Text Text))
streamKey_value :: Lens' StreamKey (Maybe 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 StreamSession = StreamSession' {
- channel :: Maybe Channel
- endTime :: Maybe ISO8601
- ingestConfiguration :: Maybe IngestConfiguration
- recordingConfiguration :: Maybe RecordingConfiguration
- startTime :: Maybe ISO8601
- streamId :: Maybe Text
- truncatedEvents :: Maybe [StreamEvent]
}
newStreamSession :: StreamSession
streamSession_channel :: Lens' StreamSession (Maybe Channel)
streamSession_endTime :: Lens' StreamSession (Maybe UTCTime)
streamSession_ingestConfiguration :: Lens' StreamSession (Maybe IngestConfiguration)
streamSession_recordingConfiguration :: Lens' StreamSession (Maybe RecordingConfiguration)
streamSession_startTime :: Lens' StreamSession (Maybe UTCTime)
streamSession_streamId :: Lens' StreamSession (Maybe Text)
streamSession_truncatedEvents :: Lens' StreamSession (Maybe [StreamEvent])
data StreamSessionSummary = StreamSessionSummary' {
- endTime :: Maybe ISO8601
- hasErrorEvent :: Maybe Bool
- startTime :: Maybe ISO8601
- streamId :: Maybe Text
}
newStreamSessionSummary :: StreamSessionSummary
streamSessionSummary_endTime :: Lens' StreamSessionSummary (Maybe UTCTime)
streamSessionSummary_hasErrorEvent :: Lens' StreamSessionSummary (Maybe Bool)
streamSessionSummary_startTime :: Lens' StreamSessionSummary (Maybe UTCTime)
streamSessionSummary_streamId :: Lens' StreamSessionSummary (Maybe Text)
data StreamSummary = StreamSummary' {
- channelArn :: Maybe Text
- health :: Maybe StreamHealth
- startTime :: Maybe ISO8601
- state :: Maybe StreamState
- streamId :: Maybe Text
- viewerCount :: Maybe Integer
}
newStreamSummary :: StreamSummary
streamSummary_channelArn :: Lens' StreamSummary (Maybe Text)
streamSummary_health :: Lens' StreamSummary (Maybe StreamHealth)
streamSummary_startTime :: Lens' StreamSummary (Maybe UTCTime)
streamSummary_state :: Lens' StreamSummary (Maybe StreamState)
streamSummary_streamId :: Lens' StreamSummary (Maybe Text)
streamSummary_viewerCount :: Lens' StreamSummary (Maybe Integer)
data ThumbnailConfiguration = ThumbnailConfiguration' {
- recordingMode :: Maybe RecordingMode
- targetIntervalSeconds :: Maybe Natural
}
newThumbnailConfiguration :: ThumbnailConfiguration
thumbnailConfiguration_recordingMode :: Lens' ThumbnailConfiguration (Maybe RecordingMode)
thumbnailConfiguration_targetIntervalSeconds :: Lens' ThumbnailConfiguration (Maybe Natural)
data VideoConfiguration = VideoConfiguration' {
- avcLevel :: Maybe Text
- avcProfile :: Maybe Text
- codec :: Maybe Text
- encoder :: Maybe Text
- targetBitrate :: Maybe Integer
- targetFramerate :: Maybe Integer
- videoHeight :: Maybe Integer
- videoWidth :: Maybe Integer
}
newVideoConfiguration :: VideoConfiguration
videoConfiguration_avcLevel :: Lens' VideoConfiguration (Maybe Text)
videoConfiguration_avcProfile :: Lens' VideoConfiguration (Maybe Text)
videoConfiguration_codec :: Lens' VideoConfiguration (Maybe Text)
videoConfiguration_encoder :: Lens' VideoConfiguration (Maybe Text)
videoConfiguration_targetBitrate :: Lens' VideoConfiguration (Maybe Integer)
videoConfiguration_targetFramerate :: Lens' VideoConfiguration (Maybe Integer)
videoConfiguration_videoHeight :: Lens' VideoConfiguration (Maybe Integer)
videoConfiguration_videoWidth :: Lens' VideoConfiguration (Maybe Integer)

Service Configuration

defaultService :: Service Source #

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

Errors

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

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

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

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

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

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

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

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

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

_ValidationException :: AsError a => Fold 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

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] #
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] #
ToByteString ChannelLatencyMode Source #
Instance details Defined in Amazonka.IVS.Types.ChannelLatencyMode Methods toBS :: ChannelLatencyMode -> ByteString #
ToHeader ChannelLatencyMode Source #
Instance details Defined in Amazonka.IVS.Types.ChannelLatencyMode Methods toHeader :: HeaderName -> ChannelLatencyMode -> [Header] #
ToLog ChannelLatencyMode Source #
Instance details Defined in Amazonka.IVS.Types.ChannelLatencyMode Methods build :: ChannelLatencyMode -> ByteStringBuilder #
ToQuery ChannelLatencyMode Source #
Instance details Defined in Amazonka.IVS.Types.ChannelLatencyMode Methods toQuery :: ChannelLatencyMode -> QueryString #
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 #
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 #
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 #
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 #
NFData ChannelLatencyMode Source #
Instance details Defined in Amazonka.IVS.Types.ChannelLatencyMode Methods rnf :: ChannelLatencyMode -> () #
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 #
Hashable ChannelLatencyMode Source #
Instance details Defined in Amazonka.IVS.Types.ChannelLatencyMode Methods hashWithSalt :: Int -> ChannelLatencyMode -> Int # hash :: ChannelLatencyMode -> Int #
type Rep ChannelLatencyMode Source #
Instance details Defined in Amazonka.IVS.Types.ChannelLatencyMode type Rep ChannelLatencyMode = D1 ('MetaData "ChannelLatencyMode" "Amazonka.IVS.Types.ChannelLatencyMode" "amazonka-ivs-2.0-1XuGgGDxNXQ7UL2Yr5LhmE" '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

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] #
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] #
ToByteString ChannelType Source #
Instance details Defined in Amazonka.IVS.Types.ChannelType Methods toBS :: ChannelType -> ByteString #
ToHeader ChannelType Source #
Instance details Defined in Amazonka.IVS.Types.ChannelType Methods toHeader :: HeaderName -> ChannelType -> [Header] #
ToLog ChannelType Source #
Instance details Defined in Amazonka.IVS.Types.ChannelType Methods build :: ChannelType -> ByteStringBuilder #
ToQuery ChannelType Source #
Instance details Defined in Amazonka.IVS.Types.ChannelType Methods toQuery :: ChannelType -> QueryString #
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 #
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 #
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 #
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 #
NFData ChannelType Source #
Instance details Defined in Amazonka.IVS.Types.ChannelType Methods rnf :: ChannelType -> () #
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 #
Hashable ChannelType Source #
Instance details Defined in Amazonka.IVS.Types.ChannelType Methods hashWithSalt :: Int -> ChannelType -> Int # hash :: ChannelType -> Int #
type Rep ChannelType Source #
Instance details Defined in Amazonka.IVS.Types.ChannelType type Rep ChannelType = D1 ('MetaData "ChannelType" "Amazonka.IVS.Types.ChannelType" "amazonka-ivs-2.0-1XuGgGDxNXQ7UL2Yr5LhmE" '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

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] #
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] #
ToByteString RecordingConfigurationState Source #
Instance details Defined in Amazonka.IVS.Types.RecordingConfigurationState Methods toBS :: RecordingConfigurationState -> ByteString #
ToHeader RecordingConfigurationState Source #
Instance details Defined in Amazonka.IVS.Types.RecordingConfigurationState Methods toHeader :: HeaderName -> RecordingConfigurationState -> [Header] #
ToLog RecordingConfigurationState Source #
Instance details Defined in Amazonka.IVS.Types.RecordingConfigurationState Methods build :: RecordingConfigurationState -> ByteStringBuilder #
ToQuery RecordingConfigurationState Source #
Instance details Defined in Amazonka.IVS.Types.RecordingConfigurationState Methods toQuery :: RecordingConfigurationState -> QueryString #
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 #
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 #
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 #
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 #
NFData RecordingConfigurationState Source #
Instance details Defined in Amazonka.IVS.Types.RecordingConfigurationState Methods rnf :: RecordingConfigurationState -> () #
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 #
Hashable RecordingConfigurationState Source #
Instance details Defined in Amazonka.IVS.Types.RecordingConfigurationState Methods hashWithSalt :: Int -> RecordingConfigurationState -> Int # hash :: RecordingConfigurationState -> Int #
type Rep RecordingConfigurationState Source #
Instance details Defined in Amazonka.IVS.Types.RecordingConfigurationState type Rep RecordingConfigurationState = D1 ('MetaData "RecordingConfigurationState" "Amazonka.IVS.Types.RecordingConfigurationState" "amazonka-ivs-2.0-1XuGgGDxNXQ7UL2Yr5LhmE" 'True) (C1 ('MetaCons "RecordingConfigurationState'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromRecordingConfigurationState") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

RecordingMode

newtype RecordingMode Source #

Constructors

RecordingMode'
Fields fromRecordingMode :: Text

Bundled Patterns

pattern RecordingMode_DISABLED :: RecordingMode
pattern RecordingMode_INTERVAL :: RecordingMode

Instances

Instances details

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

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] #
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] #
ToByteString StreamHealth Source #
Instance details Defined in Amazonka.IVS.Types.StreamHealth Methods toBS :: StreamHealth -> ByteString #
ToHeader StreamHealth Source #
Instance details Defined in Amazonka.IVS.Types.StreamHealth Methods toHeader :: HeaderName -> StreamHealth -> [Header] #
ToLog StreamHealth Source #
Instance details Defined in Amazonka.IVS.Types.StreamHealth Methods build :: StreamHealth -> ByteStringBuilder #
ToQuery StreamHealth Source #
Instance details Defined in Amazonka.IVS.Types.StreamHealth Methods toQuery :: StreamHealth -> QueryString #
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 #
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 #
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 #
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 #
NFData StreamHealth Source #
Instance details Defined in Amazonka.IVS.Types.StreamHealth Methods rnf :: StreamHealth -> () #
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 #
Hashable StreamHealth Source #
Instance details Defined in Amazonka.IVS.Types.StreamHealth Methods hashWithSalt :: Int -> StreamHealth -> Int # hash :: StreamHealth -> Int #
type Rep StreamHealth Source #
Instance details Defined in Amazonka.IVS.Types.StreamHealth type Rep StreamHealth = D1 ('MetaData "StreamHealth" "Amazonka.IVS.Types.StreamHealth" "amazonka-ivs-2.0-1XuGgGDxNXQ7UL2Yr5LhmE" '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

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] #
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] #
ToByteString StreamState Source #
Instance details Defined in Amazonka.IVS.Types.StreamState Methods toBS :: StreamState -> ByteString #
ToHeader StreamState Source #
Instance details Defined in Amazonka.IVS.Types.StreamState Methods toHeader :: HeaderName -> StreamState -> [Header] #
ToLog StreamState Source #
Instance details Defined in Amazonka.IVS.Types.StreamState Methods build :: StreamState -> ByteStringBuilder #
ToQuery StreamState Source #
Instance details Defined in Amazonka.IVS.Types.StreamState Methods toQuery :: StreamState -> QueryString #
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 #
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 #
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 #
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 #
NFData StreamState Source #
Instance details Defined in Amazonka.IVS.Types.StreamState Methods rnf :: StreamState -> () #
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 #
Hashable StreamState Source #
Instance details Defined in Amazonka.IVS.Types.StreamState Methods hashWithSalt :: Int -> StreamState -> Int # hash :: StreamState -> Int #
type Rep StreamState Source #
Instance details Defined in Amazonka.IVS.Types.StreamState type Rep StreamState = D1 ('MetaData "StreamState" "Amazonka.IVS.Types.StreamState" "amazonka-ivs-2.0-1XuGgGDxNXQ7UL2Yr5LhmE" 'True) (C1 ('MetaCons "StreamState'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromStreamState") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

AudioConfiguration

data AudioConfiguration Source #

Object specifying a stream’s audio configuration, as set up by the broadcaster (usually in an encoder). This is part of the IngestConfiguration object and used for monitoring stream health.

See: newAudioConfiguration smart constructor.

Constructors

AudioConfiguration'
Fields channels :: Maybe Integer Number of audio channels. codec :: Maybe Text Codec used for the audio encoding. sampleRate :: Maybe Integer Number of audio samples recorded per second. targetBitrate :: Maybe Integer The expected ingest bitrate (bits per second). This is configured in the encoder.

Instances

Instances details

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

newAudioConfiguration :: AudioConfiguration Source #

Create a value of AudioConfiguration 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:channels:AudioConfiguration', audioConfiguration_channels - Number of audio channels.

$sel:codec:AudioConfiguration', audioConfiguration_codec - Codec used for the audio encoding.

$sel:sampleRate:AudioConfiguration', audioConfiguration_sampleRate - Number of audio samples recorded per second.

$sel:targetBitrate:AudioConfiguration', audioConfiguration_targetBitrate - The expected ingest bitrate (bits per second). This is configured in the encoder.

audioConfiguration_channels :: Lens' AudioConfiguration (Maybe Integer) Source #

Number of audio channels.

audioConfiguration_codec :: Lens' AudioConfiguration (Maybe Text) Source #

Codec used for the audio encoding.

audioConfiguration_sampleRate :: Lens' AudioConfiguration (Maybe Integer) Source #

Number of audio samples recorded per second.

audioConfiguration_targetBitrate :: Lens' AudioConfiguration (Maybe Integer) Source #

The expected ingest bitrate (bits per second). This is configured in the encoder.

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

FromJSON BatchError Source #
Instance details Defined in Amazonka.IVS.Types.BatchError Methods parseJSON :: Value -> Parser BatchError # parseJSONList :: Value -> Parser [BatchError] #
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 #
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 #
NFData BatchError Source #
Instance details Defined in Amazonka.IVS.Types.BatchError Methods rnf :: BatchError -> () #
Eq BatchError Source #
Instance details Defined in Amazonka.IVS.Types.BatchError Methods (==) :: BatchError -> BatchError -> Bool # (/=) :: BatchError -> BatchError -> Bool #
Hashable BatchError Source #
Instance details Defined in Amazonka.IVS.Types.BatchError Methods hashWithSalt :: Int -> BatchError -> Int # hash :: BatchError -> Int #
type Rep BatchError Source #
Instance details Defined in Amazonka.IVS.Types.BatchError type Rep BatchError = D1 ('MetaData "BatchError" "Amazonka.IVS.Types.BatchError" "amazonka-ivs-2.0-1XuGgGDxNXQ7UL2Yr5LhmE" '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

arn :: Maybe Text
Channel ARN.
authorized :: Maybe Bool
Whether the channel is private (enabled for playback authorization). Default: false.
ingestEndpoint :: Maybe Text
Channel ingest endpoint, part of the definition of an ingest server, used when you set up streaming software.
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.
playbackUrl :: Maybe Text
Channel playback URL.
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). See Tagging Amazon Web Services Resources for more information, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented there.
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: Video is transcoded: multiple qualities are generated from the original input, to automatically give viewers the best experience for their devices and network conditions. Transcoding allows higher playback quality across a range of download speeds. 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. This is the default.
- BASIC: Video is transmuxed: 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 1080p and bitrate can be up to 1.5 Mbps for 480p and up to 3.5 Mbps for resolutions between 480p and 1080p.

Instances

Instances details

FromJSON Channel Source #
Instance details Defined in Amazonka.IVS.Types.Channel Methods parseJSON :: Value -> Parser Channel # parseJSONList :: Value -> Parser [Channel] #
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 #
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 #
NFData Channel Source #
Instance details Defined in Amazonka.IVS.Types.Channel Methods rnf :: Channel -> () #
Eq Channel Source #
Instance details Defined in Amazonka.IVS.Types.Channel Methods (==) :: Channel -> Channel -> Bool # (/=) :: Channel -> Channel -> Bool #
Hashable Channel Source #
Instance details Defined in Amazonka.IVS.Types.Channel Methods hashWithSalt :: Int -> Channel -> Int # hash :: Channel -> Int #
type Rep Channel Source #
Instance details Defined in Amazonka.IVS.Types.Channel type Rep Channel = D1 ('MetaData "Channel" "Amazonka.IVS.Types.Channel" "amazonka-ivs-2.0-1XuGgGDxNXQ7UL2Yr5LhmE" 'False) (C1 ('MetaCons "Channel'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "authorized") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :: (S1 ('MetaSel ('Just "ingestEndpoint") '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 "playbackUrl") '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))) :: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ChannelType)))))))

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:arn:Channel', channel_arn - Channel ARN.

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

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

$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:playbackUrl:Channel', channel_playbackUrl - Channel playback URL.

$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:tags:Channel', channel_tags - Array of 1-50 maps, each of the form string:string (key:value). See Tagging Amazon Web Services Resources for more information, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented there.

$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: Video is transcoded: multiple qualities are generated from the original input, to automatically give viewers the best experience for their devices and network conditions. Transcoding allows higher playback quality across a range of download speeds. 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. This is the default.
BASIC: Video is transmuxed: 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 1080p and bitrate can be up to 1.5 Mbps for 480p and up to 3.5 Mbps for resolutions between 480p and 1080p.

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

Channel ARN.

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

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

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.

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_playbackUrl :: Lens' Channel (Maybe Text) Source #

Channel playback URL.

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_tags :: Lens' Channel (Maybe (HashMap Text Text)) Source #

Array of 1-50 maps, each of the form string:string (key:value). See Tagging Amazon Web Services Resources for more information, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented there.

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: Video is transcoded: multiple qualities are generated from the original input, to automatically give viewers the best experience for their devices and network conditions. Transcoding allows higher playback quality across a range of download speeds. 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. This is the default.
BASIC: Video is transmuxed: 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 1080p and bitrate can be up to 1.5 Mbps for 480p and up to 3.5 Mbps for resolutions between 480p and 1080p.

ChannelSummary

data ChannelSummary Source #

Summary information about a channel.

See: newChannelSummary smart constructor.

Constructors

ChannelSummary'

Fields

arn :: Maybe Text
Channel ARN.
authorized :: Maybe Bool
Whether the channel is private (enabled for playback authorization). Default: false.
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). See Tagging Amazon Web Services Resources for more information, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented there.

Instances

Instances details

FromJSON ChannelSummary Source #
Instance details Defined in Amazonka.IVS.Types.ChannelSummary Methods parseJSON :: Value -> Parser ChannelSummary # parseJSONList :: Value -> Parser [ChannelSummary] #
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 #
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 #
NFData ChannelSummary Source #
Instance details Defined in Amazonka.IVS.Types.ChannelSummary Methods rnf :: ChannelSummary -> () #
Eq ChannelSummary Source #
Instance details Defined in Amazonka.IVS.Types.ChannelSummary Methods (==) :: ChannelSummary -> ChannelSummary -> Bool # (/=) :: ChannelSummary -> ChannelSummary -> Bool #
Hashable ChannelSummary Source #
Instance details Defined in Amazonka.IVS.Types.ChannelSummary Methods hashWithSalt :: Int -> ChannelSummary -> Int # hash :: ChannelSummary -> Int #
type Rep ChannelSummary Source #
Instance details Defined in Amazonka.IVS.Types.ChannelSummary type Rep ChannelSummary = D1 ('MetaData "ChannelSummary" "Amazonka.IVS.Types.ChannelSummary" "amazonka-ivs-2.0-1XuGgGDxNXQ7UL2Yr5LhmE" 'False) (C1 ('MetaCons "ChannelSummary'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "authorized") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: 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:arn:ChannelSummary', channelSummary_arn - Channel ARN.

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

$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). See Tagging Amazon Web Services Resources for more information, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented there.

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

Channel ARN.

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

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

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). See Tagging Amazon Web Services Resources for more information, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented there.

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

FromJSON DestinationConfiguration Source #
Instance details Defined in Amazonka.IVS.Types.DestinationConfiguration Methods parseJSON :: Value -> Parser DestinationConfiguration # parseJSONList :: Value -> Parser [DestinationConfiguration] #
ToJSON DestinationConfiguration Source #
Instance details Defined in Amazonka.IVS.Types.DestinationConfiguration Methods toJSON :: DestinationConfiguration -> Value # toEncoding :: DestinationConfiguration -> Encoding # toJSONList :: [DestinationConfiguration] -> Value # toEncodingList :: [DestinationConfiguration] -> Encoding #
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 #
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 #
NFData DestinationConfiguration Source #
Instance details Defined in Amazonka.IVS.Types.DestinationConfiguration Methods rnf :: DestinationConfiguration -> () #
Eq DestinationConfiguration Source #
Instance details Defined in Amazonka.IVS.Types.DestinationConfiguration Methods (==) :: DestinationConfiguration -> DestinationConfiguration -> Bool # (/=) :: DestinationConfiguration -> DestinationConfiguration -> Bool #
Hashable DestinationConfiguration Source #
Instance details Defined in Amazonka.IVS.Types.DestinationConfiguration Methods hashWithSalt :: Int -> DestinationConfiguration -> Int # hash :: DestinationConfiguration -> Int #
type Rep DestinationConfiguration Source #
Instance details Defined in Amazonka.IVS.Types.DestinationConfiguration type Rep DestinationConfiguration = D1 ('MetaData "DestinationConfiguration" "Amazonka.IVS.Types.DestinationConfiguration" "amazonka-ivs-2.0-1XuGgGDxNXQ7UL2Yr5LhmE" '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.

IngestConfiguration

data IngestConfiguration Source #

Object specifying the ingest configuration set up by the broadcaster, usually in an encoder.

See: newIngestConfiguration smart constructor.

Constructors

IngestConfiguration'
Fields audio :: Maybe AudioConfiguration Encoder settings for audio. video :: Maybe VideoConfiguration Encoder settings for video.

Instances

Instances details

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

newIngestConfiguration :: IngestConfiguration Source #

Create a value of IngestConfiguration 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:audio:IngestConfiguration', ingestConfiguration_audio - Encoder settings for audio.

$sel:video:IngestConfiguration', ingestConfiguration_video - Encoder settings for video.

ingestConfiguration_audio :: Lens' IngestConfiguration (Maybe AudioConfiguration) Source #

Encoder settings for audio.

ingestConfiguration_video :: Lens' IngestConfiguration (Maybe VideoConfiguration) Source #

Encoder settings for video.

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). See Tagging Amazon Web Services Resources for more information, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented there.

Instances

Instances details

FromJSON PlaybackKeyPair Source #
Instance details Defined in Amazonka.IVS.Types.PlaybackKeyPair Methods parseJSON :: Value -> Parser PlaybackKeyPair # parseJSONList :: Value -> Parser [PlaybackKeyPair] #
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 #
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 #
NFData PlaybackKeyPair Source #
Instance details Defined in Amazonka.IVS.Types.PlaybackKeyPair Methods rnf :: PlaybackKeyPair -> () #
Eq PlaybackKeyPair Source #
Instance details Defined in Amazonka.IVS.Types.PlaybackKeyPair Methods (==) :: PlaybackKeyPair -> PlaybackKeyPair -> Bool # (/=) :: PlaybackKeyPair -> PlaybackKeyPair -> Bool #
Hashable PlaybackKeyPair Source #
Instance details Defined in Amazonka.IVS.Types.PlaybackKeyPair Methods hashWithSalt :: Int -> PlaybackKeyPair -> Int # hash :: PlaybackKeyPair -> Int #
type Rep PlaybackKeyPair Source #
Instance details Defined in Amazonka.IVS.Types.PlaybackKeyPair type Rep PlaybackKeyPair = D1 ('MetaData "PlaybackKeyPair" "Amazonka.IVS.Types.PlaybackKeyPair" "amazonka-ivs-2.0-1XuGgGDxNXQ7UL2Yr5LhmE" '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). See Tagging Amazon Web Services Resources for more information, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented there.

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). See Tagging Amazon Web Services Resources for more information, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented there.

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). See Tagging Amazon Web Services Resources for more information, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented there.

Instances

Instances details

FromJSON PlaybackKeyPairSummary Source #
Instance details Defined in Amazonka.IVS.Types.PlaybackKeyPairSummary Methods parseJSON :: Value -> Parser PlaybackKeyPairSummary # parseJSONList :: Value -> Parser [PlaybackKeyPairSummary] #
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 #
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 #
NFData PlaybackKeyPairSummary Source #
Instance details Defined in Amazonka.IVS.Types.PlaybackKeyPairSummary Methods rnf :: PlaybackKeyPairSummary -> () #
Eq PlaybackKeyPairSummary Source #
Instance details Defined in Amazonka.IVS.Types.PlaybackKeyPairSummary Methods (==) :: PlaybackKeyPairSummary -> PlaybackKeyPairSummary -> Bool # (/=) :: PlaybackKeyPairSummary -> PlaybackKeyPairSummary -> Bool #
Hashable PlaybackKeyPairSummary Source #
Instance details Defined in Amazonka.IVS.Types.PlaybackKeyPairSummary Methods hashWithSalt :: Int -> PlaybackKeyPairSummary -> Int # hash :: PlaybackKeyPairSummary -> Int #
type Rep PlaybackKeyPairSummary Source #
Instance details Defined in Amazonka.IVS.Types.PlaybackKeyPairSummary type Rep PlaybackKeyPairSummary = D1 ('MetaData "PlaybackKeyPairSummary" "Amazonka.IVS.Types.PlaybackKeyPairSummary" "amazonka-ivs-2.0-1XuGgGDxNXQ7UL2Yr5LhmE" '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). See Tagging Amazon Web Services Resources for more information, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented there.

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). See Tagging Amazon Web Services Resources for more information, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented there.

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.
recordingReconnectWindowSeconds :: Maybe Natural
If a broadcast disconnects and then reconnects within the specified interval, the multiple streams will be considered a single broadcast and merged together. Default: 0.
tags :: Maybe (HashMap Text Text)
Array of 1-50 maps, each of the form string:string (key:value). See Tagging Amazon Web Services Resources for more information, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented there.
thumbnailConfiguration :: Maybe ThumbnailConfiguration
A complex type that allows you to enable/disable the recording of thumbnails for a live session and modify the interval at which thumbnails are generated for the live session.
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

FromJSON RecordingConfiguration Source #
Instance details Defined in Amazonka.IVS.Types.RecordingConfiguration Methods parseJSON :: Value -> Parser RecordingConfiguration # parseJSONList :: Value -> Parser [RecordingConfiguration] #
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 #
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 #
NFData RecordingConfiguration Source #
Instance details Defined in Amazonka.IVS.Types.RecordingConfiguration Methods rnf :: RecordingConfiguration -> () #
Eq RecordingConfiguration Source #
Instance details Defined in Amazonka.IVS.Types.RecordingConfiguration Methods (==) :: RecordingConfiguration -> RecordingConfiguration -> Bool # (/=) :: RecordingConfiguration -> RecordingConfiguration -> Bool #
Hashable RecordingConfiguration Source #
Instance details Defined in Amazonka.IVS.Types.RecordingConfiguration Methods hashWithSalt :: Int -> RecordingConfiguration -> Int # hash :: RecordingConfiguration -> Int #
type Rep RecordingConfiguration Source #
Instance details Defined in Amazonka.IVS.Types.RecordingConfiguration type Rep RecordingConfiguration = D1 ('MetaData "RecordingConfiguration" "Amazonka.IVS.Types.RecordingConfiguration" "amazonka-ivs-2.0-1XuGgGDxNXQ7UL2Yr5LhmE" 'False) (C1 ('MetaCons "RecordingConfiguration'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "recordingReconnectWindowSeconds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))))) :: ((S1 ('MetaSel ('Just "thumbnailConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ThumbnailConfiguration)) :: 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:recordingReconnectWindowSeconds:RecordingConfiguration', recordingConfiguration_recordingReconnectWindowSeconds - If a broadcast disconnects and then reconnects within the specified interval, the multiple streams will be considered a single broadcast and merged together. Default: 0.

$sel:tags:RecordingConfiguration', recordingConfiguration_tags - Array of 1-50 maps, each of the form string:string (key:value). See Tagging Amazon Web Services Resources for more information, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented there.

$sel:thumbnailConfiguration:RecordingConfiguration', recordingConfiguration_thumbnailConfiguration - A complex type that allows you to enable/disable the recording of thumbnails for a live session and modify the interval at which thumbnails are generated for the live session.

$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_recordingReconnectWindowSeconds :: Lens' RecordingConfiguration (Maybe Natural) Source #

If a broadcast disconnects and then reconnects within the specified interval, the multiple streams will be considered a single broadcast and merged together. Default: 0.

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

Array of 1-50 maps, each of the form string:string (key:value). See Tagging Amazon Web Services Resources for more information, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented there.

recordingConfiguration_thumbnailConfiguration :: Lens' RecordingConfiguration (Maybe ThumbnailConfiguration) Source #

A complex type that allows you to enable/disable the recording of thumbnails for a live session and modify the interval at which thumbnails are generated for the live session.

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). See Tagging Amazon Web Services Resources for more information, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented there.
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

FromJSON RecordingConfigurationSummary Source #
Instance details Defined in Amazonka.IVS.Types.RecordingConfigurationSummary Methods parseJSON :: Value -> Parser RecordingConfigurationSummary # parseJSONList :: Value -> Parser [RecordingConfigurationSummary] #
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 #
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 #
NFData RecordingConfigurationSummary Source #
Instance details Defined in Amazonka.IVS.Types.RecordingConfigurationSummary Methods rnf :: RecordingConfigurationSummary -> () #
Eq RecordingConfigurationSummary Source #
Instance details Defined in Amazonka.IVS.Types.RecordingConfigurationSummary Methods (==) :: RecordingConfigurationSummary -> RecordingConfigurationSummary -> Bool # (/=) :: RecordingConfigurationSummary -> RecordingConfigurationSummary -> Bool #
Hashable RecordingConfigurationSummary Source #
Instance details Defined in Amazonka.IVS.Types.RecordingConfigurationSummary Methods hashWithSalt :: Int -> RecordingConfigurationSummary -> Int # hash :: RecordingConfigurationSummary -> Int #
type Rep RecordingConfigurationSummary Source #
Instance details Defined in Amazonka.IVS.Types.RecordingConfigurationSummary type Rep RecordingConfigurationSummary = D1 ('MetaData "RecordingConfigurationSummary" "Amazonka.IVS.Types.RecordingConfigurationSummary" "amazonka-ivs-2.0-1XuGgGDxNXQ7UL2Yr5LhmE" '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). See Tagging Amazon Web Services Resources for more information, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented there.

$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). See Tagging Amazon Web Services Resources for more information, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented there.

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

FromJSON S3DestinationConfiguration Source #
Instance details Defined in Amazonka.IVS.Types.S3DestinationConfiguration Methods parseJSON :: Value -> Parser S3DestinationConfiguration # parseJSONList :: Value -> Parser [S3DestinationConfiguration] #
ToJSON S3DestinationConfiguration Source #
Instance details Defined in Amazonka.IVS.Types.S3DestinationConfiguration Methods toJSON :: S3DestinationConfiguration -> Value # toEncoding :: S3DestinationConfiguration -> Encoding # toJSONList :: [S3DestinationConfiguration] -> Value # toEncodingList :: [S3DestinationConfiguration] -> Encoding #
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 #
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 #
NFData S3DestinationConfiguration Source #
Instance details Defined in Amazonka.IVS.Types.S3DestinationConfiguration Methods rnf :: S3DestinationConfiguration -> () #
Eq S3DestinationConfiguration Source #
Instance details Defined in Amazonka.IVS.Types.S3DestinationConfiguration Methods (==) :: S3DestinationConfiguration -> S3DestinationConfiguration -> Bool # (/=) :: S3DestinationConfiguration -> S3DestinationConfiguration -> Bool #
Hashable S3DestinationConfiguration Source #
Instance details Defined in Amazonka.IVS.Types.S3DestinationConfiguration Methods hashWithSalt :: Int -> S3DestinationConfiguration -> Int # hash :: S3DestinationConfiguration -> Int #
type Rep S3DestinationConfiguration Source #
Instance details Defined in Amazonka.IVS.Types.S3DestinationConfiguration type Rep S3DestinationConfiguration = D1 ('MetaData "S3DestinationConfiguration" "Amazonka.IVS.Types.S3DestinationConfiguration" "amazonka-ivs-2.0-1XuGgGDxNXQ7UL2Yr5LhmE" '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

channelArn :: Maybe Text
Channel ARN for the stream.
health :: Maybe StreamHealth
The stream’s health.
playbackUrl :: Maybe Text
URL of the master playlist, required by the video player to play the HLS stream.
startTime :: Maybe ISO8601
Time of the stream’s start. This is an ISO 8601 timestamp; /note that this is returned as a string/.
state :: Maybe StreamState
The stream’s state.
streamId :: Maybe Text
Unique identifier for a live or previously live stream in the specified channel.
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.

Instances

Instances details

FromJSON Stream Source #
Instance details Defined in Amazonka.IVS.Types.Stream Methods parseJSON :: Value -> Parser Stream # parseJSONList :: Value -> Parser [Stream] #
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 #
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 #
NFData Stream Source #
Instance details Defined in Amazonka.IVS.Types.Stream Methods rnf :: Stream -> () #
Eq Stream Source #
Instance details Defined in Amazonka.IVS.Types.Stream Methods (==) :: Stream -> Stream -> Bool # (/=) :: Stream -> Stream -> Bool #
Hashable Stream Source #
Instance details Defined in Amazonka.IVS.Types.Stream Methods hashWithSalt :: Int -> Stream -> Int # hash :: Stream -> Int #
type Rep Stream Source #
Instance details Defined in Amazonka.IVS.Types.Stream type Rep Stream = D1 ('MetaData "Stream" "Amazonka.IVS.Types.Stream" "amazonka-ivs-2.0-1XuGgGDxNXQ7UL2Yr5LhmE" 'False) (C1 ('MetaCons "Stream'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "channelArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "health") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe StreamHealth)) :: S1 ('MetaSel ('Just "playbackUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "startTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)) :: S1 ('MetaSel ('Just "state") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe StreamState))) :: (S1 ('MetaSel ('Just "streamId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "viewerCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer))))))

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:channelArn:Stream', stream_channelArn - Channel ARN for the stream.

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

$sel:playbackUrl:Stream', stream_playbackUrl - URL of the master playlist, required by the video player to play the HLS stream.

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

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

$sel:streamId:Stream', stream_streamId - Unique identifier for a live or previously live stream in the specified channel.

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

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

Channel ARN for the stream.

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

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_startTime :: Lens' Stream (Maybe UTCTime) Source #

Time of the stream’s start. This is an ISO 8601 timestamp; /note that this is returned as a string/.

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

The stream’s state.

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

Unique identifier for a live or previously live stream in the specified channel.

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.

StreamEvent

data StreamEvent Source #

Object specifying a stream’s events. For a list of events, see Using Amazon EventBridge with Amazon IVS.

See: newStreamEvent smart constructor.

Constructors

StreamEvent'
Fields eventTime :: Maybe ISO8601 Time when the event occurred. This is an ISO 8601 timestamp; /note that this is returned as a string/. name :: Maybe Text Name that identifies the stream event within a `type`. type' :: Maybe Text Logical group for certain events.

Instances

Instances details

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

newStreamEvent :: StreamEvent Source #

Create a value of StreamEvent 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:eventTime:StreamEvent', streamEvent_eventTime - Time when the event occurred. This is an ISO 8601 timestamp; /note that this is returned as a string/.

$sel:name:StreamEvent', streamEvent_name - Name that identifies the stream event within a type.

$sel:type':StreamEvent', streamEvent_type - Logical group for certain events.

streamEvent_eventTime :: Lens' StreamEvent (Maybe UTCTime) Source #

Time when the event occurred. This is an ISO 8601 timestamp; /note that this is returned as a string/.

streamEvent_name :: Lens' StreamEvent (Maybe Text) Source #

Name that identifies the stream event within a type.

streamEvent_type :: Lens' StreamEvent (Maybe Text) Source #

Logical group for certain events.

StreamFilters

data StreamFilters Source #

Object specifying the stream attribute on which to filter.

See: newStreamFilters smart constructor.

Constructors

StreamFilters'
Fields health :: Maybe StreamHealth The stream’s health.

Instances

Instances details

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

newStreamFilters :: StreamFilters Source #

Create a value of StreamFilters 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:health:StreamFilters', streamFilters_health - The stream’s health.

streamFilters_health :: Lens' StreamFilters (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.
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). See Tagging Amazon Web Services Resources for more information, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented there.
value :: Maybe (Sensitive Text)
Stream-key value.

Instances

Instances details

FromJSON StreamKey Source #
Instance details Defined in Amazonka.IVS.Types.StreamKey Methods parseJSON :: Value -> Parser StreamKey # parseJSONList :: Value -> Parser [StreamKey] #
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 #
Show StreamKey Source #
Instance details Defined in Amazonka.IVS.Types.StreamKey Methods showsPrec :: Int -> StreamKey -> ShowS # show :: StreamKey -> String # showList :: [StreamKey] -> ShowS #
NFData StreamKey Source #
Instance details Defined in Amazonka.IVS.Types.StreamKey Methods rnf :: StreamKey -> () #
Eq StreamKey Source #
Instance details Defined in Amazonka.IVS.Types.StreamKey Methods (==) :: StreamKey -> StreamKey -> Bool # (/=) :: StreamKey -> StreamKey -> Bool #
Hashable StreamKey Source #
Instance details Defined in Amazonka.IVS.Types.StreamKey Methods hashWithSalt :: Int -> StreamKey -> Int # hash :: StreamKey -> Int #
type Rep StreamKey Source #
Instance details Defined in Amazonka.IVS.Types.StreamKey type Rep StreamKey = D1 ('MetaData "StreamKey" "Amazonka.IVS.Types.StreamKey" "amazonka-ivs-2.0-1XuGgGDxNXQ7UL2Yr5LhmE" 'False) (C1 ('MetaCons "StreamKey'" '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))) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive 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: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). See Tagging Amazon Web Services Resources for more information, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented there.

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

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

Stream-key ARN.

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). See Tagging Amazon Web Services Resources for more information, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented there.

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

Stream-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). See Tagging Amazon Web Services Resources for more information, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented there.

Instances

Instances details

FromJSON StreamKeySummary Source #
Instance details Defined in Amazonka.IVS.Types.StreamKeySummary Methods parseJSON :: Value -> Parser StreamKeySummary # parseJSONList :: Value -> Parser [StreamKeySummary] #
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 #
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 #
NFData StreamKeySummary Source #
Instance details Defined in Amazonka.IVS.Types.StreamKeySummary Methods rnf :: StreamKeySummary -> () #
Eq StreamKeySummary Source #
Instance details Defined in Amazonka.IVS.Types.StreamKeySummary Methods (==) :: StreamKeySummary -> StreamKeySummary -> Bool # (/=) :: StreamKeySummary -> StreamKeySummary -> Bool #
Hashable StreamKeySummary Source #
Instance details Defined in Amazonka.IVS.Types.StreamKeySummary Methods hashWithSalt :: Int -> StreamKeySummary -> Int # hash :: StreamKeySummary -> Int #
type Rep StreamKeySummary Source #
Instance details Defined in Amazonka.IVS.Types.StreamKeySummary type Rep StreamKeySummary = D1 ('MetaData "StreamKeySummary" "Amazonka.IVS.Types.StreamKeySummary" "amazonka-ivs-2.0-1XuGgGDxNXQ7UL2Yr5LhmE" '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). See Tagging Amazon Web Services Resources for more information, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented there.

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). See Tagging Amazon Web Services Resources for more information, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented there.

StreamSession

data StreamSession Source #

Object that captures the Amazon IVS configuration that the customer provisioned, the ingest configurations that the broadcaster used, and the most recent Amazon IVS stream events it encountered.

See: newStreamSession smart constructor.

Constructors

StreamSession'

Fields

channel :: Maybe Channel
The properties of the channel at the time of going live.
endTime :: Maybe ISO8601
Time when the channel went offline. This is an ISO 8601 timestamp; /note that this is returned as a string/. For live streams, this is NULL.
ingestConfiguration :: Maybe IngestConfiguration
The properties of the incoming RTMP stream for the stream.
recordingConfiguration :: Maybe RecordingConfiguration
The properties of recording the live stream.
startTime :: Maybe ISO8601
Time when the channel went live. This is an ISO 8601 timestamp; /note that this is returned as a string/.
streamId :: Maybe Text
Unique identifier for a live or previously live stream in the specified channel.
truncatedEvents :: Maybe [StreamEvent]
List of Amazon IVS events that the stream encountered. The list is sorted by most recent events and contains up to 500 events. For Amazon IVS events, see Using Amazon EventBridge with Amazon IVS.

Instances

Instances details

FromJSON StreamSession Source #
Instance details Defined in Amazonka.IVS.Types.StreamSession Methods parseJSON :: Value -> Parser StreamSession # parseJSONList :: Value -> Parser [StreamSession] #
Generic StreamSession Source #
Instance details Defined in Amazonka.IVS.Types.StreamSession Associated Types type Rep StreamSession :: Type -> Type # Methods from :: StreamSession -> Rep StreamSession x # to :: Rep StreamSession x -> StreamSession #
Read StreamSession Source #
Instance details Defined in Amazonka.IVS.Types.StreamSession Methods readsPrec :: Int -> ReadS StreamSession # readList :: ReadS [StreamSession] # readPrec :: ReadPrec StreamSession # readListPrec :: ReadPrec [StreamSession] #
Show StreamSession Source #
Instance details Defined in Amazonka.IVS.Types.StreamSession Methods showsPrec :: Int -> StreamSession -> ShowS # show :: StreamSession -> String # showList :: [StreamSession] -> ShowS #
NFData StreamSession Source #
Instance details Defined in Amazonka.IVS.Types.StreamSession Methods rnf :: StreamSession -> () #
Eq StreamSession Source #
Instance details Defined in Amazonka.IVS.Types.StreamSession Methods (==) :: StreamSession -> StreamSession -> Bool # (/=) :: StreamSession -> StreamSession -> Bool #
Hashable StreamSession Source #
Instance details Defined in Amazonka.IVS.Types.StreamSession Methods hashWithSalt :: Int -> StreamSession -> Int # hash :: StreamSession -> Int #
type Rep StreamSession Source #
Instance details Defined in Amazonka.IVS.Types.StreamSession type Rep StreamSession = D1 ('MetaData "StreamSession" "Amazonka.IVS.Types.StreamSession" "amazonka-ivs-2.0-1XuGgGDxNXQ7UL2Yr5LhmE" 'False) (C1 ('MetaCons "StreamSession'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "channel") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Channel)) :: (S1 ('MetaSel ('Just "endTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)) :: S1 ('MetaSel ('Just "ingestConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe IngestConfiguration)))) :: ((S1 ('MetaSel ('Just "recordingConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RecordingConfiguration)) :: S1 ('MetaSel ('Just "startTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601))) :: (S1 ('MetaSel ('Just "streamId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "truncatedEvents") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [StreamEvent]))))))

newStreamSession :: StreamSession Source #

Create a value of StreamSession 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:channel:StreamSession', streamSession_channel - The properties of the channel at the time of going live.

$sel:endTime:StreamSession', streamSession_endTime - Time when the channel went offline. This is an ISO 8601 timestamp; /note that this is returned as a string/. For live streams, this is NULL.

$sel:ingestConfiguration:StreamSession', streamSession_ingestConfiguration - The properties of the incoming RTMP stream for the stream.

$sel:recordingConfiguration:StreamSession', streamSession_recordingConfiguration - The properties of recording the live stream.

$sel:startTime:StreamSession', streamSession_startTime - Time when the channel went live. This is an ISO 8601 timestamp; /note that this is returned as a string/.

$sel:streamId:StreamSession', streamSession_streamId - Unique identifier for a live or previously live stream in the specified channel.

$sel:truncatedEvents:StreamSession', streamSession_truncatedEvents - List of Amazon IVS events that the stream encountered. The list is sorted by most recent events and contains up to 500 events. For Amazon IVS events, see Using Amazon EventBridge with Amazon IVS.

streamSession_channel :: Lens' StreamSession (Maybe Channel) Source #

The properties of the channel at the time of going live.

streamSession_endTime :: Lens' StreamSession (Maybe UTCTime) Source #

Time when the channel went offline. This is an ISO 8601 timestamp; /note that this is returned as a string/. For live streams, this is NULL.

streamSession_ingestConfiguration :: Lens' StreamSession (Maybe IngestConfiguration) Source #

The properties of the incoming RTMP stream for the stream.

streamSession_recordingConfiguration :: Lens' StreamSession (Maybe RecordingConfiguration) Source #

The properties of recording the live stream.

streamSession_startTime :: Lens' StreamSession (Maybe UTCTime) Source #

Time when the channel went live. This is an ISO 8601 timestamp; /note that this is returned as a string/.

streamSession_streamId :: Lens' StreamSession (Maybe Text) Source #

Unique identifier for a live or previously live stream in the specified channel.

streamSession_truncatedEvents :: Lens' StreamSession (Maybe [StreamEvent]) Source #

List of Amazon IVS events that the stream encountered. The list is sorted by most recent events and contains up to 500 events. For Amazon IVS events, see Using Amazon EventBridge with Amazon IVS.

StreamSessionSummary

data StreamSessionSummary Source #

Summary information about a stream session.

See: newStreamSessionSummary smart constructor.

Constructors

StreamSessionSummary'

Fields

endTime :: Maybe ISO8601
Time when the channel went offline. This is an ISO 8601 timestamp; /note that this is returned as a string/. For live streams, this is NULL.
hasErrorEvent :: Maybe Bool
If true, this stream encountered a quota breach or failure.
startTime :: Maybe ISO8601
Time when the channel went live. This is an ISO 8601 timestamp; /note that this is returned as a string/.
streamId :: Maybe Text
Unique identifier for a live or previously live stream in the specified channel.

Instances

Instances details

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

newStreamSessionSummary :: StreamSessionSummary Source #

Create a value of StreamSessionSummary 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:endTime:StreamSessionSummary', streamSessionSummary_endTime - Time when the channel went offline. This is an ISO 8601 timestamp; /note that this is returned as a string/. For live streams, this is NULL.

$sel:hasErrorEvent:StreamSessionSummary', streamSessionSummary_hasErrorEvent - If true, this stream encountered a quota breach or failure.

$sel:startTime:StreamSessionSummary', streamSessionSummary_startTime - Time when the channel went live. This is an ISO 8601 timestamp; /note that this is returned as a string/.

$sel:streamId:StreamSessionSummary', streamSessionSummary_streamId - Unique identifier for a live or previously live stream in the specified channel.

streamSessionSummary_endTime :: Lens' StreamSessionSummary (Maybe UTCTime) Source #

Time when the channel went offline. This is an ISO 8601 timestamp; /note that this is returned as a string/. For live streams, this is NULL.

streamSessionSummary_hasErrorEvent :: Lens' StreamSessionSummary (Maybe Bool) Source #

If true, this stream encountered a quota breach or failure.

streamSessionSummary_startTime :: Lens' StreamSessionSummary (Maybe UTCTime) Source #

Time when the channel went live. This is an ISO 8601 timestamp; /note that this is returned as a string/.

streamSessionSummary_streamId :: Lens' StreamSessionSummary (Maybe Text) Source #

Unique identifier for a live or previously live stream in the specified channel.

StreamSummary

data StreamSummary Source #

Summary information about a stream.

See: newStreamSummary smart constructor.

Constructors

StreamSummary'

Fields

channelArn :: Maybe Text
Channel ARN for the stream.
health :: Maybe StreamHealth
The stream’s health.
startTime :: Maybe ISO8601
Time of the stream’s start. This is an ISO 8601 timestamp; /note that this is returned as a string/.
state :: Maybe StreamState
The stream’s state.
streamId :: Maybe Text
Unique identifier for a live or previously live stream in the specified channel.
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.

Instances

Instances details

FromJSON StreamSummary Source #
Instance details Defined in Amazonka.IVS.Types.StreamSummary Methods parseJSON :: Value -> Parser StreamSummary # parseJSONList :: Value -> Parser [StreamSummary] #
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 #
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 #
NFData StreamSummary Source #
Instance details Defined in Amazonka.IVS.Types.StreamSummary Methods rnf :: StreamSummary -> () #
Eq StreamSummary Source #
Instance details Defined in Amazonka.IVS.Types.StreamSummary Methods (==) :: StreamSummary -> StreamSummary -> Bool # (/=) :: StreamSummary -> StreamSummary -> Bool #
Hashable StreamSummary Source #
Instance details Defined in Amazonka.IVS.Types.StreamSummary Methods hashWithSalt :: Int -> StreamSummary -> Int # hash :: StreamSummary -> Int #
type Rep StreamSummary Source #
Instance details Defined in Amazonka.IVS.Types.StreamSummary type Rep StreamSummary = D1 ('MetaData "StreamSummary" "Amazonka.IVS.Types.StreamSummary" "amazonka-ivs-2.0-1XuGgGDxNXQ7UL2Yr5LhmE" 'False) (C1 ('MetaCons "StreamSummary'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "channelArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "health") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe StreamHealth)) :: S1 ('MetaSel ('Just "startTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)))) :: (S1 ('MetaSel ('Just "state") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe StreamState)) :: (S1 ('MetaSel ('Just "streamId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "viewerCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer))))))

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:channelArn:StreamSummary', streamSummary_channelArn - Channel ARN for the stream.

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

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

$sel:state:StreamSummary', streamSummary_state - The stream’s state.

$sel:streamId:StreamSummary', streamSummary_streamId - Unique identifier for a live or previously live stream in the specified channel.

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

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

Channel ARN for the stream.

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

The stream’s health.

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

Time of the stream’s start. This is an ISO 8601 timestamp; /note that this is returned as a string/.

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

The stream’s state.

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

Unique identifier for a live or previously live stream in the specified channel.

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.

ThumbnailConfiguration

data ThumbnailConfiguration Source #

An object representing a configuration of thumbnails for recorded video.

See: newThumbnailConfiguration smart constructor.

Constructors

ThumbnailConfiguration'

Fields

recordingMode :: Maybe RecordingMode
Thumbnail recording mode. Default: INTERVAL.
targetIntervalSeconds :: Maybe Natural
The targeted thumbnail-generation interval in seconds. This is configurable (and required) only if recordingMode is INTERVAL. Default: 60.
Important: Setting a value for targetIntervalSeconds does not guarantee that thumbnails are generated at the specified interval. For thumbnails to be generated at the targetIntervalSeconds interval, the IDR/Keyframe value for the input video must be less than the targetIntervalSeconds value. See Amazon IVS Streaming Configuration for information on setting IDR/Keyframe to the recommended value in video-encoder settings.

Instances

Instances details

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

newThumbnailConfiguration :: ThumbnailConfiguration Source #

Create a value of ThumbnailConfiguration 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:recordingMode:ThumbnailConfiguration', thumbnailConfiguration_recordingMode - Thumbnail recording mode. Default: INTERVAL.

$sel:targetIntervalSeconds:ThumbnailConfiguration', thumbnailConfiguration_targetIntervalSeconds - The targeted thumbnail-generation interval in seconds. This is configurable (and required) only if recordingMode is INTERVAL. Default: 60.

Important: Setting a value for targetIntervalSeconds does not guarantee that thumbnails are generated at the specified interval. For thumbnails to be generated at the targetIntervalSeconds interval, the IDR/Keyframe value for the input video must be less than the targetIntervalSeconds value. See Amazon IVS Streaming Configuration for information on setting IDR/Keyframe to the recommended value in video-encoder settings.

thumbnailConfiguration_recordingMode :: Lens' ThumbnailConfiguration (Maybe RecordingMode) Source #

Thumbnail recording mode. Default: INTERVAL.

thumbnailConfiguration_targetIntervalSeconds :: Lens' ThumbnailConfiguration (Maybe Natural) Source #

The targeted thumbnail-generation interval in seconds. This is configurable (and required) only if recordingMode is INTERVAL. Default: 60.

Important: Setting a value for targetIntervalSeconds does not guarantee that thumbnails are generated at the specified interval. For thumbnails to be generated at the targetIntervalSeconds interval, the IDR/Keyframe value for the input video must be less than the targetIntervalSeconds value. See Amazon IVS Streaming Configuration for information on setting IDR/Keyframe to the recommended value in video-encoder settings.

VideoConfiguration

data VideoConfiguration Source #

Object specifying a stream’s video configuration, as set up by the broadcaster (usually in an encoder). This is part of the IngestConfiguration object and used for monitoring stream health.

See: newVideoConfiguration smart constructor.

Constructors

VideoConfiguration'

Fields

avcLevel :: Maybe Text
Indicates the degree of required decoder performance for a profile. Normally this is set automatically by the encoder. For details, see the H.264 specification.
avcProfile :: Maybe Text
Indicates to the decoder the requirements for decoding the stream. For definitions of the valid values, see the H.264 specification.
codec :: Maybe Text
Codec used for the video encoding.
encoder :: Maybe Text
Software or hardware used to encode the video.
targetBitrate :: Maybe Integer
The expected ingest bitrate (bits per second). This is configured in the encoder.
targetFramerate :: Maybe Integer
The expected ingest framerate. This is configured in the encoder.
videoHeight :: Maybe Integer
Video-resolution height in pixels.
videoWidth :: Maybe Integer
Video-resolution width in pixels.

Instances

Instances details

FromJSON VideoConfiguration Source #
Instance details Defined in Amazonka.IVS.Types.VideoConfiguration Methods parseJSON :: Value -> Parser VideoConfiguration # parseJSONList :: Value -> Parser [VideoConfiguration] #
Generic VideoConfiguration Source #
Instance details Defined in Amazonka.IVS.Types.VideoConfiguration Associated Types type Rep VideoConfiguration :: Type -> Type # Methods from :: VideoConfiguration -> Rep VideoConfiguration x # to :: Rep VideoConfiguration x -> VideoConfiguration #
Read VideoConfiguration Source #
Instance details Defined in Amazonka.IVS.Types.VideoConfiguration Methods readsPrec :: Int -> ReadS VideoConfiguration # readList :: ReadS [VideoConfiguration] # readPrec :: ReadPrec VideoConfiguration # readListPrec :: ReadPrec [VideoConfiguration] #
Show VideoConfiguration Source #
Instance details Defined in Amazonka.IVS.Types.VideoConfiguration Methods showsPrec :: Int -> VideoConfiguration -> ShowS # show :: VideoConfiguration -> String # showList :: [VideoConfiguration] -> ShowS #
NFData VideoConfiguration Source #
Instance details Defined in Amazonka.IVS.Types.VideoConfiguration Methods rnf :: VideoConfiguration -> () #
Eq VideoConfiguration Source #
Instance details Defined in Amazonka.IVS.Types.VideoConfiguration Methods (==) :: VideoConfiguration -> VideoConfiguration -> Bool # (/=) :: VideoConfiguration -> VideoConfiguration -> Bool #
Hashable VideoConfiguration Source #
Instance details Defined in Amazonka.IVS.Types.VideoConfiguration Methods hashWithSalt :: Int -> VideoConfiguration -> Int # hash :: VideoConfiguration -> Int #
type Rep VideoConfiguration Source #
Instance details Defined in Amazonka.IVS.Types.VideoConfiguration type Rep VideoConfiguration = D1 ('MetaData "VideoConfiguration" "Amazonka.IVS.Types.VideoConfiguration" "amazonka-ivs-2.0-1XuGgGDxNXQ7UL2Yr5LhmE" 'False) (C1 ('MetaCons "VideoConfiguration'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "avcLevel") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "avcProfile") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "codec") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "encoder") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "targetBitrate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :: S1 ('MetaSel ('Just "targetFramerate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer))) :: (S1 ('MetaSel ('Just "videoHeight") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :*: S1 ('MetaSel ('Just "videoWidth") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer))))))

newVideoConfiguration :: VideoConfiguration Source #

Create a value of VideoConfiguration 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:avcLevel:VideoConfiguration', videoConfiguration_avcLevel - Indicates the degree of required decoder performance for a profile. Normally this is set automatically by the encoder. For details, see the H.264 specification.

$sel:avcProfile:VideoConfiguration', videoConfiguration_avcProfile - Indicates to the decoder the requirements for decoding the stream. For definitions of the valid values, see the H.264 specification.

$sel:codec:VideoConfiguration', videoConfiguration_codec - Codec used for the video encoding.

$sel:encoder:VideoConfiguration', videoConfiguration_encoder - Software or hardware used to encode the video.

$sel:targetBitrate:VideoConfiguration', videoConfiguration_targetBitrate - The expected ingest bitrate (bits per second). This is configured in the encoder.

$sel:targetFramerate:VideoConfiguration', videoConfiguration_targetFramerate - The expected ingest framerate. This is configured in the encoder.

$sel:videoHeight:VideoConfiguration', videoConfiguration_videoHeight - Video-resolution height in pixels.

$sel:videoWidth:VideoConfiguration', videoConfiguration_videoWidth - Video-resolution width in pixels.

videoConfiguration_avcLevel :: Lens' VideoConfiguration (Maybe Text) Source #

Indicates the degree of required decoder performance for a profile. Normally this is set automatically by the encoder. For details, see the H.264 specification.

videoConfiguration_avcProfile :: Lens' VideoConfiguration (Maybe Text) Source #

Indicates to the decoder the requirements for decoding the stream. For definitions of the valid values, see the H.264 specification.

videoConfiguration_codec :: Lens' VideoConfiguration (Maybe Text) Source #

Codec used for the video encoding.

videoConfiguration_encoder :: Lens' VideoConfiguration (Maybe Text) Source #

Software or hardware used to encode the video.

videoConfiguration_targetBitrate :: Lens' VideoConfiguration (Maybe Integer) Source #

The expected ingest bitrate (bits per second). This is configured in the encoder.

videoConfiguration_targetFramerate :: Lens' VideoConfiguration (Maybe Integer) Source #

The expected ingest framerate. This is configured in the encoder.

videoConfiguration_videoHeight :: Lens' VideoConfiguration (Maybe Integer) Source #

Video-resolution height in pixels.

videoConfiguration_videoWidth :: Lens' VideoConfiguration (Maybe Integer) Source #

Video-resolution width in pixels.