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

Description

Updates a channel's configuration. This does not affect an ongoing stream of this channel. You must stop and restart the stream for the changes to take effect.

Synopsis

Creating a Request

data UpdateChannel Source #

See: newUpdateChannel smart constructor.

Constructors

UpdateChannel' 

Fields

  • authorized :: Maybe Bool

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

  • 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. (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. If this is set to an empty string, recording is disabled. A value other than an empty string indicates that recording is enabled

  • type' :: Maybe ChannelType

    Channel type, which determines the allowable resolution and bitrate. /If you exceed the allowable resolution or bitrate, the stream probably will disconnect immediately/. Valid values:

    • STANDARD: Multiple qualities are generated from the original input, to automatically give viewers the best experience for their devices and network conditions. Resolution can be up to 1080p and bitrate can be up to 8.5 Mbps. Audio is transcoded only for renditions 360p and below; above that, audio is passed through.
    • BASIC: Amazon IVS delivers the original input to viewers. The viewer’s video-quality choice is limited to the original input. Resolution can be up to 480p and bitrate can be up to 1.5 Mbps.
  • arn :: Text

    ARN of the channel to be updated.

Instances

Instances details
Eq UpdateChannel Source # 
Instance details

Defined in Amazonka.IVS.UpdateChannel

Methods

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

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

Read UpdateChannel Source # 
Instance details

Defined in Amazonka.IVS.UpdateChannel

Methods

readsPrec :: Int -> ReadS UpdateChannel #

readList :: ReadS [UpdateChannel] #

readPrec :: ReadPrec UpdateChannel #

readListPrec :: ReadPrec [UpdateChannel] #

Show UpdateChannel Source # 
Instance details

Defined in Amazonka.IVS.UpdateChannel

Methods

showsPrec :: Int -> UpdateChannel -> ShowS #

show :: UpdateChannel -> String #

showList :: [UpdateChannel] -> ShowS #

Generic UpdateChannel Source # 
Instance details

Defined in Amazonka.IVS.UpdateChannel

Associated Types

type Rep UpdateChannel :: Type -> Type #

Methods

from :: UpdateChannel -> Rep UpdateChannel x #

to :: Rep UpdateChannel x -> UpdateChannel #

NFData UpdateChannel Source # 
Instance details

Defined in Amazonka.IVS.UpdateChannel

Methods

rnf :: UpdateChannel -> () #

Hashable UpdateChannel Source # 
Instance details

Defined in Amazonka.IVS.UpdateChannel

Methods

hashWithSalt :: Int -> UpdateChannel -> Int #

hash :: UpdateChannel -> Int #

ToJSON UpdateChannel Source # 
Instance details

Defined in Amazonka.IVS.UpdateChannel

Methods

toJSON :: UpdateChannel -> Value #

toEncoding :: UpdateChannel -> Encoding #

toJSONList :: [UpdateChannel] -> Value #

toEncodingList :: [UpdateChannel] -> Encoding #

AWSRequest UpdateChannel Source # 
Instance details

Defined in Amazonka.IVS.UpdateChannel

Associated Types

type AWSResponse UpdateChannel #

Methods

request :: UpdateChannel -> Request UpdateChannel #

response :: MonadResource m => Logger -> Service -> Proxy UpdateChannel -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateChannel))) #

ToHeaders UpdateChannel Source # 
Instance details

Defined in Amazonka.IVS.UpdateChannel

Methods

toHeaders :: UpdateChannel -> [Header] #

ToPath UpdateChannel Source # 
Instance details

Defined in Amazonka.IVS.UpdateChannel

Methods

toPath :: UpdateChannel -> ByteString #

ToQuery UpdateChannel Source # 
Instance details

Defined in Amazonka.IVS.UpdateChannel

Methods

toQuery :: UpdateChannel -> QueryString #

type Rep UpdateChannel Source # 
Instance details

Defined in Amazonka.IVS.UpdateChannel

type Rep UpdateChannel = D1 ('MetaData "UpdateChannel" "Amazonka.IVS.UpdateChannel" "libZSservicesZSamazonka-ivsZSamazonka-ivs" 'False) (C1 ('MetaCons "UpdateChannel'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "authorized") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: (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 "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ChannelType)) :*: S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))
type AWSResponse UpdateChannel Source # 
Instance details

Defined in Amazonka.IVS.UpdateChannel

type AWSResponse UpdateChannel = UpdateChannelResponse

newUpdateChannel Source #

Arguments

:: Text

$sel:arn:UpdateChannel'

-> UpdateChannel 

Create a value of UpdateChannel 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:UpdateChannel', updateChannel_authorized - Whether the channel is private (enabled for playback authorization).

$sel:latencyMode:UpdateChannel', updateChannel_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. (Note: In the Amazon IVS console, LOW and NORMAL correspond to Ultra-low and Standard, respectively.)

$sel:name:UpdateChannel', updateChannel_name - Channel name.

$sel:recordingConfigurationArn:UpdateChannel', updateChannel_recordingConfigurationArn - Recording-configuration ARN. If this is set to an empty string, recording is disabled. A value other than an empty string indicates that recording is enabled

$sel:type':UpdateChannel', updateChannel_type - Channel type, which determines the allowable resolution and bitrate. /If you exceed the allowable resolution or bitrate, the stream probably will disconnect immediately/. Valid values:

  • STANDARD: Multiple qualities are generated from the original input, to automatically give viewers the best experience for their devices and network conditions. Resolution can be up to 1080p and bitrate can be up to 8.5 Mbps. Audio is transcoded only for renditions 360p and below; above that, audio is passed through.
  • BASIC: Amazon IVS delivers the original input to viewers. The viewer’s video-quality choice is limited to the original input. Resolution can be up to 480p and bitrate can be up to 1.5 Mbps.

$sel:arn:UpdateChannel', updateChannel_arn - ARN of the channel to be updated.

Request Lenses

updateChannel_authorized :: Lens' UpdateChannel (Maybe Bool) Source #

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

updateChannel_latencyMode :: Lens' UpdateChannel (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. (Note: In the Amazon IVS console, LOW and NORMAL correspond to Ultra-low and Standard, respectively.)

updateChannel_name :: Lens' UpdateChannel (Maybe Text) Source #

Channel name.

updateChannel_recordingConfigurationArn :: Lens' UpdateChannel (Maybe Text) Source #

Recording-configuration ARN. If this is set to an empty string, recording is disabled. A value other than an empty string indicates that recording is enabled

updateChannel_type :: Lens' UpdateChannel (Maybe ChannelType) Source #

Channel type, which determines the allowable resolution and bitrate. /If you exceed the allowable resolution or bitrate, the stream probably will disconnect immediately/. Valid values:

  • STANDARD: Multiple qualities are generated from the original input, to automatically give viewers the best experience for their devices and network conditions. Resolution can be up to 1080p and bitrate can be up to 8.5 Mbps. Audio is transcoded only for renditions 360p and below; above that, audio is passed through.
  • BASIC: Amazon IVS delivers the original input to viewers. The viewer’s video-quality choice is limited to the original input. Resolution can be up to 480p and bitrate can be up to 1.5 Mbps.

updateChannel_arn :: Lens' UpdateChannel Text Source #

ARN of the channel to be updated.

Destructuring the Response

data UpdateChannelResponse Source #

See: newUpdateChannelResponse smart constructor.

Constructors

UpdateChannelResponse' 

Fields

Instances

Instances details
Eq UpdateChannelResponse Source # 
Instance details

Defined in Amazonka.IVS.UpdateChannel

Methods

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

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

Read UpdateChannelResponse Source # 
Instance details

Defined in Amazonka.IVS.UpdateChannel

Methods

readsPrec :: Int -> ReadS UpdateChannelResponse #

readList :: ReadS [UpdateChannelResponse] #

readPrec :: ReadPrec UpdateChannelResponse #

readListPrec :: ReadPrec [UpdateChannelResponse] #

Show UpdateChannelResponse Source # 
Instance details

Defined in Amazonka.IVS.UpdateChannel

Methods

showsPrec :: Int -> UpdateChannelResponse -> ShowS #

show :: UpdateChannelResponse -> String #

showList :: [UpdateChannelResponse] -> ShowS #

Generic UpdateChannelResponse Source # 
Instance details

Defined in Amazonka.IVS.UpdateChannel

Associated Types

type Rep UpdateChannelResponse :: Type -> Type #

Methods

from :: UpdateChannelResponse -> Rep UpdateChannelResponse x #

to :: Rep UpdateChannelResponse x -> UpdateChannelResponse #

NFData UpdateChannelResponse Source # 
Instance details

Defined in Amazonka.IVS.UpdateChannel

Methods

rnf :: UpdateChannelResponse -> () #

type Rep UpdateChannelResponse Source # 
Instance details

Defined in Amazonka.IVS.UpdateChannel

type Rep UpdateChannelResponse = D1 ('MetaData "UpdateChannelResponse" "Amazonka.IVS.UpdateChannel" "libZSservicesZSamazonka-ivsZSamazonka-ivs" 'False) (C1 ('MetaCons "UpdateChannelResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "channel") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Channel)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newUpdateChannelResponse Source #

Arguments

:: Int

$sel:httpStatus:UpdateChannelResponse'

-> UpdateChannelResponse 

Create a value of UpdateChannelResponse 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:UpdateChannelResponse', updateChannelResponse_channel - Undocumented member.

$sel:httpStatus:UpdateChannelResponse', updateChannelResponse_httpStatus - The response's http status code.

Response Lenses

updateChannelResponse_channel :: Lens' UpdateChannelResponse (Maybe Channel) Source #

Undocumented member.

updateChannelResponse_httpStatus :: Lens' UpdateChannelResponse Int Source #

The response's http status code.