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

Description

Documentation

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.