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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a new channel and an associated stream key to start streaming.

Synopsis

data CreateChannel = CreateChannel' {
- authorized :: Maybe Bool
- latencyMode :: Maybe ChannelLatencyMode
- name :: Maybe Text
- recordingConfigurationArn :: Maybe Text
- tags :: Maybe (HashMap Text Text)
- type' :: Maybe ChannelType
}
newCreateChannel :: CreateChannel
createChannel_authorized :: Lens' CreateChannel (Maybe Bool)
createChannel_latencyMode :: Lens' CreateChannel (Maybe ChannelLatencyMode)
createChannel_name :: Lens' CreateChannel (Maybe Text)
createChannel_recordingConfigurationArn :: Lens' CreateChannel (Maybe Text)
createChannel_tags :: Lens' CreateChannel (Maybe (HashMap Text Text))
createChannel_type :: Lens' CreateChannel (Maybe ChannelType)
data CreateChannelResponse = CreateChannelResponse' {
- channel :: Maybe Channel
- streamKey :: Maybe StreamKey
- httpStatus :: Int
}
newCreateChannelResponse :: Int -> CreateChannelResponse
createChannelResponse_channel :: Lens' CreateChannelResponse (Maybe Channel)
createChannelResponse_streamKey :: Lens' CreateChannelResponse (Maybe StreamKey)
createChannelResponse_httpStatus :: Lens' CreateChannelResponse Int

Creating a Request

data CreateChannel Source #

See: newCreateChannel smart constructor.

Constructors

CreateChannel'

Fields

authorized :: Maybe Bool
Whether the channel is private (enabled for playback authorization). Default: false.
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.) Default: LOW.
name :: Maybe Text
Channel name.
recordingConfigurationArn :: Maybe Text
Recording-configuration ARN. Default: "" (empty string, recording is disabled).
tags :: Maybe (HashMap Text Text)
Array of 1-50 maps, each of the form string:string (key:value). See Tagging Amazon Web Services Resources for more information, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented there.
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./ Default: STANDARD. Valid values:
- STANDARD: Video is transcoded: multiple qualities are generated from the original input, to automatically give viewers the best experience for their devices and network conditions. Transcoding allows higher playback quality across a range of download speeds. 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. This is the default.
- BASIC: Video is transmuxed: 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 1080p and bitrate can be up to 1.5 Mbps for 480p and up to 3.5 Mbps for resolutions between 480p and 1080p.

Instances

Instances details

ToJSON CreateChannel Source #
Instance details Defined in Amazonka.IVS.CreateChannel Methods toJSON :: CreateChannel -> Value # toEncoding :: CreateChannel -> Encoding # toJSONList :: [CreateChannel] -> Value # toEncodingList :: [CreateChannel] -> Encoding #
ToHeaders CreateChannel Source #
Instance details Defined in Amazonka.IVS.CreateChannel Methods toHeaders :: CreateChannel -> [Header] #
ToPath CreateChannel Source #
Instance details Defined in Amazonka.IVS.CreateChannel Methods toPath :: CreateChannel -> ByteString #
ToQuery CreateChannel Source #
Instance details Defined in Amazonka.IVS.CreateChannel Methods toQuery :: CreateChannel -> QueryString #
AWSRequest CreateChannel Source #
Instance details Defined in Amazonka.IVS.CreateChannel Associated Types type AWSResponse CreateChannel # Methods request :: (Service -> Service) -> CreateChannel -> Request CreateChannel # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateChannel -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateChannel))) #
Generic CreateChannel Source #
Instance details Defined in Amazonka.IVS.CreateChannel Associated Types type Rep CreateChannel :: Type -> Type # Methods from :: CreateChannel -> Rep CreateChannel x # to :: Rep CreateChannel x -> CreateChannel #
Read CreateChannel Source #
Instance details Defined in Amazonka.IVS.CreateChannel Methods readsPrec :: Int -> ReadS CreateChannel # readList :: ReadS [CreateChannel] # readPrec :: ReadPrec CreateChannel # readListPrec :: ReadPrec [CreateChannel] #
Show CreateChannel Source #
Instance details Defined in Amazonka.IVS.CreateChannel Methods showsPrec :: Int -> CreateChannel -> ShowS # show :: CreateChannel -> String # showList :: [CreateChannel] -> ShowS #
NFData CreateChannel Source #
Instance details Defined in Amazonka.IVS.CreateChannel Methods rnf :: CreateChannel -> () #
Eq CreateChannel Source #
Instance details Defined in Amazonka.IVS.CreateChannel Methods (==) :: CreateChannel -> CreateChannel -> Bool # (/=) :: CreateChannel -> CreateChannel -> Bool #
Hashable CreateChannel Source #
Instance details Defined in Amazonka.IVS.CreateChannel Methods hashWithSalt :: Int -> CreateChannel -> Int # hash :: CreateChannel -> Int #
type AWSResponse CreateChannel Source #
Instance details Defined in Amazonka.IVS.CreateChannel type AWSResponse CreateChannel = CreateChannelResponse
type Rep CreateChannel Source #
Instance details Defined in Amazonka.IVS.CreateChannel type Rep CreateChannel = D1 ('MetaData "CreateChannel" "Amazonka.IVS.CreateChannel" "amazonka-ivs-2.0-1XuGgGDxNXQ7UL2Yr5LhmE" 'False) (C1 ('MetaCons "CreateChannel'" '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 "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ChannelType))))))

newCreateChannel :: CreateChannel Source #

Create a value of CreateChannel 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:

CreateChannel, createChannel_authorized - Whether the channel is private (enabled for playback authorization). Default: false.

CreateChannel, createChannel_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.) Default: LOW.

CreateChannel, createChannel_name - Channel name.

CreateChannel, createChannel_recordingConfigurationArn - Recording-configuration ARN. Default: "" (empty string, recording is disabled).

CreateChannel, createChannel_tags - Array of 1-50 maps, each of the form string:string (key:value). See Tagging Amazon Web Services Resources for more information, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented there.

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

STANDARD: Video is transcoded: multiple qualities are generated from the original input, to automatically give viewers the best experience for their devices and network conditions. Transcoding allows higher playback quality across a range of download speeds. 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. This is the default.
BASIC: Video is transmuxed: 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 1080p and bitrate can be up to 1.5 Mbps for 480p and up to 3.5 Mbps for resolutions between 480p and 1080p.

Request Lenses

createChannel_authorized :: Lens' CreateChannel (Maybe Bool) Source #

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

createChannel_latencyMode :: Lens' CreateChannel (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.) Default: LOW.

createChannel_name :: Lens' CreateChannel (Maybe Text) Source #

Channel name.

createChannel_recordingConfigurationArn :: Lens' CreateChannel (Maybe Text) Source #

Recording-configuration ARN. Default: "" (empty string, recording is disabled).

createChannel_tags :: Lens' CreateChannel (Maybe (HashMap Text Text)) Source #

Array of 1-50 maps, each of the form string:string (key:value). See Tagging Amazon Web Services Resources for more information, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented there.

createChannel_type :: Lens' CreateChannel (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./ Default: STANDARD. Valid values:

STANDARD: Video is transcoded: multiple qualities are generated from the original input, to automatically give viewers the best experience for their devices and network conditions. Transcoding allows higher playback quality across a range of download speeds. 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. This is the default.
BASIC: Video is transmuxed: 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 1080p and bitrate can be up to 1.5 Mbps for 480p and up to 3.5 Mbps for resolutions between 480p and 1080p.

Destructuring the Response

data CreateChannelResponse Source #

See: newCreateChannelResponse smart constructor.

Constructors

CreateChannelResponse'
Fields channel :: Maybe Channel streamKey :: Maybe StreamKey httpStatus :: Int The response's http status code.

Instances

Instances details

Generic CreateChannelResponse Source #
Instance details Defined in Amazonka.IVS.CreateChannel Associated Types type Rep CreateChannelResponse :: Type -> Type # Methods from :: CreateChannelResponse -> Rep CreateChannelResponse x # to :: Rep CreateChannelResponse x -> CreateChannelResponse #
Show CreateChannelResponse Source #
Instance details Defined in Amazonka.IVS.CreateChannel Methods showsPrec :: Int -> CreateChannelResponse -> ShowS # show :: CreateChannelResponse -> String # showList :: [CreateChannelResponse] -> ShowS #
NFData CreateChannelResponse Source #
Instance details Defined in Amazonka.IVS.CreateChannel Methods rnf :: CreateChannelResponse -> () #
Eq CreateChannelResponse Source #
Instance details Defined in Amazonka.IVS.CreateChannel Methods (==) :: CreateChannelResponse -> CreateChannelResponse -> Bool # (/=) :: CreateChannelResponse -> CreateChannelResponse -> Bool #
type Rep CreateChannelResponse Source #
Instance details Defined in Amazonka.IVS.CreateChannel type Rep CreateChannelResponse = D1 ('MetaData "CreateChannelResponse" "Amazonka.IVS.CreateChannel" "amazonka-ivs-2.0-1XuGgGDxNXQ7UL2Yr5LhmE" 'False) (C1 ('MetaCons "CreateChannelResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "channel") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Channel)) :: (S1 ('MetaSel ('Just "streamKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe StreamKey)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newCreateChannelResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateChannelResponse'`
-> CreateChannelResponse

Create a value of CreateChannelResponse 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:

CreateChannelResponse, createChannelResponse_channel -

$sel:streamKey:CreateChannelResponse', createChannelResponse_streamKey -

$sel:httpStatus:CreateChannelResponse', createChannelResponse_httpStatus - The response's http status code.

Response Lenses

createChannelResponse_channel :: Lens' CreateChannelResponse (Maybe Channel) Source #

createChannelResponse_streamKey :: Lens' CreateChannelResponse (Maybe StreamKey) Source #

createChannelResponse_httpStatus :: Lens' CreateChannelResponse Int Source #

The response's http status code.