| 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.Chime.UpdateChannel
Description
Update a channel's attributes.
Restriction: You can't change a channel's privacy.
The x-amz-chime-bearer request header is mandatory. Use the
AppInstanceUserArn of the user that makes the API call as the value in
the header.
Synopsis
- data UpdateChannel = UpdateChannel' {
- chimeBearer :: Maybe Text
- metadata :: Maybe (Sensitive Text)
- channelArn :: Text
- name :: Sensitive Text
- mode :: ChannelMode
- newUpdateChannel :: Text -> Text -> ChannelMode -> UpdateChannel
- updateChannel_chimeBearer :: Lens' UpdateChannel (Maybe Text)
- updateChannel_metadata :: Lens' UpdateChannel (Maybe Text)
- updateChannel_channelArn :: Lens' UpdateChannel Text
- updateChannel_name :: Lens' UpdateChannel Text
- updateChannel_mode :: Lens' UpdateChannel ChannelMode
- data UpdateChannelResponse = UpdateChannelResponse' {
- channelArn :: Maybe Text
- httpStatus :: Int
- newUpdateChannelResponse :: Int -> UpdateChannelResponse
- updateChannelResponse_channelArn :: Lens' UpdateChannelResponse (Maybe Text)
- updateChannelResponse_httpStatus :: Lens' UpdateChannelResponse Int
Creating a Request
data UpdateChannel Source #
See: newUpdateChannel smart constructor.
Constructors
| UpdateChannel' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> ChannelMode | |
| -> 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:chimeBearer:UpdateChannel', updateChannel_chimeBearer - The AppInstanceUserArn of the user that makes the API call.
$sel:metadata:UpdateChannel', updateChannel_metadata - The metadata for the update request.
$sel:channelArn:UpdateChannel', updateChannel_channelArn - The ARN of the channel.
$sel:name:UpdateChannel', updateChannel_name - The name of the channel.
$sel:mode:UpdateChannel', updateChannel_mode - The mode of the update request.
Request Lenses
updateChannel_chimeBearer :: Lens' UpdateChannel (Maybe Text) Source #
The AppInstanceUserArn of the user that makes the API call.
updateChannel_metadata :: Lens' UpdateChannel (Maybe Text) Source #
The metadata for the update request.
updateChannel_channelArn :: Lens' UpdateChannel Text Source #
The ARN of the channel.
updateChannel_name :: Lens' UpdateChannel Text Source #
The name of the channel.
updateChannel_mode :: Lens' UpdateChannel ChannelMode Source #
The mode of the update request.
Destructuring the Response
data UpdateChannelResponse Source #
See: newUpdateChannelResponse smart constructor.
Constructors
| UpdateChannelResponse' | |
Fields
| |
Instances
newUpdateChannelResponse Source #
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:channelArn:UpdateChannel', updateChannelResponse_channelArn - The ARN of the channel.
$sel:httpStatus:UpdateChannelResponse', updateChannelResponse_httpStatus - The response's http status code.
Response Lenses
updateChannelResponse_channelArn :: Lens' UpdateChannelResponse (Maybe Text) Source #
The ARN of the channel.
updateChannelResponse_httpStatus :: Lens' UpdateChannelResponse Int Source #
The response's http status code.