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.KinesisVideo.CreateSignalingChannel

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a signaling channel.

CreateSignalingChannel is an asynchronous operation.

Synopsis

Creating a Request

data CreateSignalingChannel Source #

See: newCreateSignalingChannel smart constructor.

Constructors

CreateSignalingChannel'

Fields

channelType :: Maybe ChannelType
A type of the signaling channel that you are creating. Currently, SINGLE_MASTER is the only supported channel type.
singleMasterConfiguration :: Maybe SingleMasterConfiguration
A structure containing the configuration for the SINGLE_MASTER channel type.
tags :: Maybe [Tag]
A set of tags (key-value pairs) that you want to associate with this channel.
channelName :: Text
A name for the signaling channel that you are creating. It must be unique for each Amazon Web Services account and Amazon Web Services Region.

Instances

Instances details

ToJSON CreateSignalingChannel Source #
Instance details Defined in Amazonka.KinesisVideo.CreateSignalingChannel Methods toJSON :: CreateSignalingChannel -> Value # toEncoding :: CreateSignalingChannel -> Encoding # toJSONList :: [CreateSignalingChannel] -> Value # toEncodingList :: [CreateSignalingChannel] -> Encoding #
ToHeaders CreateSignalingChannel Source #
Instance details Defined in Amazonka.KinesisVideo.CreateSignalingChannel Methods toHeaders :: CreateSignalingChannel -> [Header] #
ToPath CreateSignalingChannel Source #
Instance details Defined in Amazonka.KinesisVideo.CreateSignalingChannel Methods toPath :: CreateSignalingChannel -> ByteString #
ToQuery CreateSignalingChannel Source #
Instance details Defined in Amazonka.KinesisVideo.CreateSignalingChannel Methods toQuery :: CreateSignalingChannel -> QueryString #
AWSRequest CreateSignalingChannel Source #
Instance details Defined in Amazonka.KinesisVideo.CreateSignalingChannel Associated Types type AWSResponse CreateSignalingChannel # Methods request :: (Service -> Service) -> CreateSignalingChannel -> Request CreateSignalingChannel # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateSignalingChannel -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateSignalingChannel))) #
Generic CreateSignalingChannel Source #
Instance details Defined in Amazonka.KinesisVideo.CreateSignalingChannel Associated Types type Rep CreateSignalingChannel :: Type -> Type # Methods from :: CreateSignalingChannel -> Rep CreateSignalingChannel x # to :: Rep CreateSignalingChannel x -> CreateSignalingChannel #
Read CreateSignalingChannel Source #
Instance details Defined in Amazonka.KinesisVideo.CreateSignalingChannel Methods readsPrec :: Int -> ReadS CreateSignalingChannel # readList :: ReadS [CreateSignalingChannel] # readPrec :: ReadPrec CreateSignalingChannel # readListPrec :: ReadPrec [CreateSignalingChannel] #
Show CreateSignalingChannel Source #
Instance details Defined in Amazonka.KinesisVideo.CreateSignalingChannel Methods showsPrec :: Int -> CreateSignalingChannel -> ShowS # show :: CreateSignalingChannel -> String # showList :: [CreateSignalingChannel] -> ShowS #
NFData CreateSignalingChannel Source #
Instance details Defined in Amazonka.KinesisVideo.CreateSignalingChannel Methods rnf :: CreateSignalingChannel -> () #
Eq CreateSignalingChannel Source #
Instance details Defined in Amazonka.KinesisVideo.CreateSignalingChannel Methods (==) :: CreateSignalingChannel -> CreateSignalingChannel -> Bool # (/=) :: CreateSignalingChannel -> CreateSignalingChannel -> Bool #
Hashable CreateSignalingChannel Source #
Instance details Defined in Amazonka.KinesisVideo.CreateSignalingChannel Methods hashWithSalt :: Int -> CreateSignalingChannel -> Int # hash :: CreateSignalingChannel -> Int #
type AWSResponse CreateSignalingChannel Source #
Instance details Defined in Amazonka.KinesisVideo.CreateSignalingChannel type AWSResponse CreateSignalingChannel = CreateSignalingChannelResponse
type Rep CreateSignalingChannel Source #
Instance details Defined in Amazonka.KinesisVideo.CreateSignalingChannel type Rep CreateSignalingChannel = D1 ('MetaData "CreateSignalingChannel" "Amazonka.KinesisVideo.CreateSignalingChannel" "amazonka-kinesis-video-2.0-5DR7d8jw2IyAvZJM3U7dwM" 'False) (C1 ('MetaCons "CreateSignalingChannel'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "channelType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ChannelType)) :: S1 ('MetaSel ('Just "singleMasterConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SingleMasterConfiguration))) :: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :*: S1 ('MetaSel ('Just "channelName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newCreateSignalingChannel Source #

Arguments

:: Text	`CreateSignalingChannel`
-> CreateSignalingChannel

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

CreateSignalingChannel, createSignalingChannel_channelType - A type of the signaling channel that you are creating. Currently, SINGLE_MASTER is the only supported channel type.

CreateSignalingChannel, createSignalingChannel_singleMasterConfiguration - A structure containing the configuration for the SINGLE_MASTER channel type.

$sel:tags:CreateSignalingChannel', createSignalingChannel_tags - A set of tags (key-value pairs) that you want to associate with this channel.

CreateSignalingChannel, createSignalingChannel_channelName - A name for the signaling channel that you are creating. It must be unique for each Amazon Web Services account and Amazon Web Services Region.

Request Lenses

createSignalingChannel_channelType :: Lens' CreateSignalingChannel (Maybe ChannelType) Source #

A type of the signaling channel that you are creating. Currently, SINGLE_MASTER is the only supported channel type.

createSignalingChannel_singleMasterConfiguration :: Lens' CreateSignalingChannel (Maybe SingleMasterConfiguration) Source #

A structure containing the configuration for the SINGLE_MASTER channel type.

createSignalingChannel_tags :: Lens' CreateSignalingChannel (Maybe [Tag]) Source #

A set of tags (key-value pairs) that you want to associate with this channel.

createSignalingChannel_channelName :: Lens' CreateSignalingChannel Text Source #

A name for the signaling channel that you are creating. It must be unique for each Amazon Web Services account and Amazon Web Services Region.

Destructuring the Response

data CreateSignalingChannelResponse Source #

See: newCreateSignalingChannelResponse smart constructor.

Constructors

CreateSignalingChannelResponse'
Fields channelARN :: Maybe Text The Amazon Resource Name (ARN) of the created channel. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic CreateSignalingChannelResponse Source #
Instance details Defined in Amazonka.KinesisVideo.CreateSignalingChannel Associated Types type Rep CreateSignalingChannelResponse :: Type -> Type # Methods from :: CreateSignalingChannelResponse -> Rep CreateSignalingChannelResponse x # to :: Rep CreateSignalingChannelResponse x -> CreateSignalingChannelResponse #
Read CreateSignalingChannelResponse Source #
Instance details Defined in Amazonka.KinesisVideo.CreateSignalingChannel Methods readsPrec :: Int -> ReadS CreateSignalingChannelResponse # readList :: ReadS [CreateSignalingChannelResponse] # readPrec :: ReadPrec CreateSignalingChannelResponse # readListPrec :: ReadPrec [CreateSignalingChannelResponse] #
Show CreateSignalingChannelResponse Source #
Instance details Defined in Amazonka.KinesisVideo.CreateSignalingChannel Methods showsPrec :: Int -> CreateSignalingChannelResponse -> ShowS # show :: CreateSignalingChannelResponse -> String # showList :: [CreateSignalingChannelResponse] -> ShowS #
NFData CreateSignalingChannelResponse Source #
Instance details Defined in Amazonka.KinesisVideo.CreateSignalingChannel Methods rnf :: CreateSignalingChannelResponse -> () #
Eq CreateSignalingChannelResponse Source #
Instance details Defined in Amazonka.KinesisVideo.CreateSignalingChannel Methods (==) :: CreateSignalingChannelResponse -> CreateSignalingChannelResponse -> Bool # (/=) :: CreateSignalingChannelResponse -> CreateSignalingChannelResponse -> Bool #
type Rep CreateSignalingChannelResponse Source #
Instance details Defined in Amazonka.KinesisVideo.CreateSignalingChannel type Rep CreateSignalingChannelResponse = D1 ('MetaData "CreateSignalingChannelResponse" "Amazonka.KinesisVideo.CreateSignalingChannel" "amazonka-kinesis-video-2.0-5DR7d8jw2IyAvZJM3U7dwM" 'False) (C1 ('MetaCons "CreateSignalingChannelResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "channelARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateSignalingChannelResponse Source #

Arguments

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

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

CreateSignalingChannelResponse, createSignalingChannelResponse_channelARN - The Amazon Resource Name (ARN) of the created channel.

$sel:httpStatus:CreateSignalingChannelResponse', createSignalingChannelResponse_httpStatus - The response's http status code.

Response Lenses

createSignalingChannelResponse_channelARN :: Lens' CreateSignalingChannelResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the created channel.

createSignalingChannelResponse_httpStatus :: Lens' CreateSignalingChannelResponse Int Source #

The response's http status code.