Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.IVS.Types.ChannelSummary

Description

Documentation

data ChannelSummary Source #

Summary information about a channel.

See: newChannelSummary smart constructor.

Constructors

ChannelSummary'

Fields

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

Instances

Instances details

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

newChannelSummary :: ChannelSummary Source #

Create a value of ChannelSummary with all optional fields omitted.

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

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

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

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

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

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

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

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

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

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

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

Channel ARN.

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

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

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

Channel name.

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

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

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

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