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

Description

 
Synopsis

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

Read ChannelSummary Source # 
Instance details

Defined in Amazonka.IVS.Types.ChannelSummary

Show ChannelSummary Source # 
Instance details

Defined in Amazonka.IVS.Types.ChannelSummary

Generic ChannelSummary Source # 
Instance details

Defined in Amazonka.IVS.Types.ChannelSummary

Associated Types

type Rep ChannelSummary :: Type -> Type #

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

FromJSON ChannelSummary Source # 
Instance details

Defined in Amazonka.IVS.Types.ChannelSummary

type Rep ChannelSummary Source # 
Instance details

Defined in Amazonka.IVS.Types.ChannelSummary

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_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_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).