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

Description

Documentation

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.