amazonka-kinesis-video-2.0: Amazon Kinesis Video Streams SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.KinesisVideo.UpdateSignalingChannel

Description

Updates the existing signaling channel. This is an asynchronous operation and takes time to complete.

If the MessageTtlSeconds value is updated (either increased or reduced), it only applies to new messages sent via this channel after it's been updated. Existing messages are still expired as per the previous MessageTtlSeconds value.

Synopsis

Creating a Request

data UpdateSignalingChannel Source #

See: newUpdateSignalingChannel smart constructor.

Constructors

UpdateSignalingChannel' 

Fields

Instances

Instances details
ToJSON UpdateSignalingChannel Source # 
Instance details

Defined in Amazonka.KinesisVideo.UpdateSignalingChannel

ToHeaders UpdateSignalingChannel Source # 
Instance details

Defined in Amazonka.KinesisVideo.UpdateSignalingChannel

ToPath UpdateSignalingChannel Source # 
Instance details

Defined in Amazonka.KinesisVideo.UpdateSignalingChannel

ToQuery UpdateSignalingChannel Source # 
Instance details

Defined in Amazonka.KinesisVideo.UpdateSignalingChannel

AWSRequest UpdateSignalingChannel Source # 
Instance details

Defined in Amazonka.KinesisVideo.UpdateSignalingChannel

Associated Types

type AWSResponse UpdateSignalingChannel #

Generic UpdateSignalingChannel Source # 
Instance details

Defined in Amazonka.KinesisVideo.UpdateSignalingChannel

Associated Types

type Rep UpdateSignalingChannel :: Type -> Type #

Read UpdateSignalingChannel Source # 
Instance details

Defined in Amazonka.KinesisVideo.UpdateSignalingChannel

Show UpdateSignalingChannel Source # 
Instance details

Defined in Amazonka.KinesisVideo.UpdateSignalingChannel

NFData UpdateSignalingChannel Source # 
Instance details

Defined in Amazonka.KinesisVideo.UpdateSignalingChannel

Methods

rnf :: UpdateSignalingChannel -> () #

Eq UpdateSignalingChannel Source # 
Instance details

Defined in Amazonka.KinesisVideo.UpdateSignalingChannel

Hashable UpdateSignalingChannel Source # 
Instance details

Defined in Amazonka.KinesisVideo.UpdateSignalingChannel

type AWSResponse UpdateSignalingChannel Source # 
Instance details

Defined in Amazonka.KinesisVideo.UpdateSignalingChannel

type Rep UpdateSignalingChannel Source # 
Instance details

Defined in Amazonka.KinesisVideo.UpdateSignalingChannel

type Rep UpdateSignalingChannel = D1 ('MetaData "UpdateSignalingChannel" "Amazonka.KinesisVideo.UpdateSignalingChannel" "amazonka-kinesis-video-2.0-5DR7d8jw2IyAvZJM3U7dwM" 'False) (C1 ('MetaCons "UpdateSignalingChannel'" 'PrefixI 'True) (S1 ('MetaSel ('Just "singleMasterConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SingleMasterConfiguration)) :*: (S1 ('MetaSel ('Just "channelARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "currentVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newUpdateSignalingChannel Source #

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

UpdateSignalingChannel, updateSignalingChannel_singleMasterConfiguration - The structure containing the configuration for the SINGLE_MASTER type of the signaling channel that you want to update.

UpdateSignalingChannel, updateSignalingChannel_channelARN - The Amazon Resource Name (ARN) of the signaling channel that you want to update.

$sel:currentVersion:UpdateSignalingChannel', updateSignalingChannel_currentVersion - The current version of the signaling channel that you want to update.

Request Lenses

updateSignalingChannel_singleMasterConfiguration :: Lens' UpdateSignalingChannel (Maybe SingleMasterConfiguration) Source #

The structure containing the configuration for the SINGLE_MASTER type of the signaling channel that you want to update.

updateSignalingChannel_channelARN :: Lens' UpdateSignalingChannel Text Source #

The Amazon Resource Name (ARN) of the signaling channel that you want to update.

updateSignalingChannel_currentVersion :: Lens' UpdateSignalingChannel Text Source #

The current version of the signaling channel that you want to update.

Destructuring the Response

data UpdateSignalingChannelResponse Source #

See: newUpdateSignalingChannelResponse smart constructor.

Constructors

UpdateSignalingChannelResponse' 

Fields

Instances

Instances details
Generic UpdateSignalingChannelResponse Source # 
Instance details

Defined in Amazonka.KinesisVideo.UpdateSignalingChannel

Associated Types

type Rep UpdateSignalingChannelResponse :: Type -> Type #

Read UpdateSignalingChannelResponse Source # 
Instance details

Defined in Amazonka.KinesisVideo.UpdateSignalingChannel

Show UpdateSignalingChannelResponse Source # 
Instance details

Defined in Amazonka.KinesisVideo.UpdateSignalingChannel

NFData UpdateSignalingChannelResponse Source # 
Instance details

Defined in Amazonka.KinesisVideo.UpdateSignalingChannel

Eq UpdateSignalingChannelResponse Source # 
Instance details

Defined in Amazonka.KinesisVideo.UpdateSignalingChannel

type Rep UpdateSignalingChannelResponse Source # 
Instance details

Defined in Amazonka.KinesisVideo.UpdateSignalingChannel

type Rep UpdateSignalingChannelResponse = D1 ('MetaData "UpdateSignalingChannelResponse" "Amazonka.KinesisVideo.UpdateSignalingChannel" "amazonka-kinesis-video-2.0-5DR7d8jw2IyAvZJM3U7dwM" 'False) (C1 ('MetaCons "UpdateSignalingChannelResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newUpdateSignalingChannelResponse Source #

Create a value of UpdateSignalingChannelResponse 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:httpStatus:UpdateSignalingChannelResponse', updateSignalingChannelResponse_httpStatus - The response's http status code.

Response Lenses