libZSservicesZSamazonka-ivsZSamazonka-ivs
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.IVS.Types.StreamSummary

Description

 
Synopsis

Documentation

data StreamSummary Source #

Summary information about a stream.

See: newStreamSummary smart constructor.

Constructors

StreamSummary' 

Fields

  • state :: Maybe StreamState

    The stream’s state.

  • startTime :: Maybe POSIX

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

  • channelArn :: Maybe Text

    Channel ARN for the stream.

  • viewerCount :: Maybe Integer

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

  • health :: Maybe StreamHealth

    The stream’s health.

Instances

Instances details
Eq StreamSummary Source # 
Instance details

Defined in Amazonka.IVS.Types.StreamSummary

Methods

(==) :: StreamSummary -> StreamSummary -> Bool #

(/=) :: StreamSummary -> StreamSummary -> Bool #

Read StreamSummary Source # 
Instance details

Defined in Amazonka.IVS.Types.StreamSummary

Methods

readsPrec :: Int -> ReadS StreamSummary #

readList :: ReadS [StreamSummary] #

readPrec :: ReadPrec StreamSummary #

readListPrec :: ReadPrec [StreamSummary] #

Show StreamSummary Source # 
Instance details

Defined in Amazonka.IVS.Types.StreamSummary

Methods

showsPrec :: Int -> StreamSummary -> ShowS #

show :: StreamSummary -> String #

showList :: [StreamSummary] -> ShowS #

Generic StreamSummary Source # 
Instance details

Defined in Amazonka.IVS.Types.StreamSummary

Associated Types

type Rep StreamSummary :: Type -> Type #

Methods

from :: StreamSummary -> Rep StreamSummary x #

to :: Rep StreamSummary x -> StreamSummary #

NFData StreamSummary Source # 
Instance details

Defined in Amazonka.IVS.Types.StreamSummary

Methods

rnf :: StreamSummary -> () #

Hashable StreamSummary Source # 
Instance details

Defined in Amazonka.IVS.Types.StreamSummary

Methods

hashWithSalt :: Int -> StreamSummary -> Int #

hash :: StreamSummary -> Int #

FromJSON StreamSummary Source # 
Instance details

Defined in Amazonka.IVS.Types.StreamSummary

Methods

parseJSON :: Value -> Parser StreamSummary #

parseJSONList :: Value -> Parser [StreamSummary] #

type Rep StreamSummary Source # 
Instance details

Defined in Amazonka.IVS.Types.StreamSummary

type Rep StreamSummary = D1 ('MetaData "StreamSummary" "Amazonka.IVS.Types.StreamSummary" "libZSservicesZSamazonka-ivsZSamazonka-ivs" 'False) (C1 ('MetaCons "StreamSummary'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "state") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe StreamState)) :*: S1 ('MetaSel ('Just "startTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :*: (S1 ('MetaSel ('Just "channelArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "viewerCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :*: S1 ('MetaSel ('Just "health") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe StreamHealth))))))

newStreamSummary :: StreamSummary Source #

Create a value of StreamSummary with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

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

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

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

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

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

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

The stream’s state.

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

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

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

Channel ARN for the stream.

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

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

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

The stream’s health.