| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
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
- data UpdateSignalingChannel = UpdateSignalingChannel' {}
- newUpdateSignalingChannel :: Text -> Text -> UpdateSignalingChannel
- updateSignalingChannel_singleMasterConfiguration :: Lens' UpdateSignalingChannel (Maybe SingleMasterConfiguration)
- updateSignalingChannel_channelARN :: Lens' UpdateSignalingChannel Text
- updateSignalingChannel_currentVersion :: Lens' UpdateSignalingChannel Text
- data UpdateSignalingChannelResponse = UpdateSignalingChannelResponse' {
- httpStatus :: Int
- newUpdateSignalingChannelResponse :: Int -> UpdateSignalingChannelResponse
- updateSignalingChannelResponse_httpStatus :: Lens' UpdateSignalingChannelResponse Int
Creating a Request
data UpdateSignalingChannel Source #
See: newUpdateSignalingChannel smart constructor.
Constructors
| UpdateSignalingChannel' | |
Fields
| |
Instances
newUpdateSignalingChannel Source #
Arguments
| :: Text | |
| -> Text | |
| -> UpdateSignalingChannel |
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:
$sel:singleMasterConfiguration:UpdateSignalingChannel', updateSignalingChannel_singleMasterConfiguration - The structure containing the configuration for the SINGLE_MASTER type
of the signaling channel that you want to update.
$sel:channelARN: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
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
updateSignalingChannelResponse_httpStatus :: Lens' UpdateSignalingChannelResponse Int Source #
The response's http status code.