libZSservicesZSamazonka-chime-sdk-messagingZSamazonka-chime-sdk-messaging
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.ChimeSDKMessaging.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

Creating a Request

data UpdateChannel Source #

See: newUpdateChannel smart constructor.

Constructors

UpdateChannel' 

Fields

Instances

Instances details
Eq UpdateChannel Source # 
Instance details

Defined in Amazonka.ChimeSDKMessaging.UpdateChannel

Show UpdateChannel Source # 
Instance details

Defined in Amazonka.ChimeSDKMessaging.UpdateChannel

Generic UpdateChannel Source # 
Instance details

Defined in Amazonka.ChimeSDKMessaging.UpdateChannel

Associated Types

type Rep UpdateChannel :: Type -> Type #

NFData UpdateChannel Source # 
Instance details

Defined in Amazonka.ChimeSDKMessaging.UpdateChannel

Methods

rnf :: UpdateChannel -> () #

Hashable UpdateChannel Source # 
Instance details

Defined in Amazonka.ChimeSDKMessaging.UpdateChannel

ToJSON UpdateChannel Source # 
Instance details

Defined in Amazonka.ChimeSDKMessaging.UpdateChannel

AWSRequest UpdateChannel Source # 
Instance details

Defined in Amazonka.ChimeSDKMessaging.UpdateChannel

Associated Types

type AWSResponse UpdateChannel #

ToHeaders UpdateChannel Source # 
Instance details

Defined in Amazonka.ChimeSDKMessaging.UpdateChannel

ToPath UpdateChannel Source # 
Instance details

Defined in Amazonka.ChimeSDKMessaging.UpdateChannel

ToQuery UpdateChannel Source # 
Instance details

Defined in Amazonka.ChimeSDKMessaging.UpdateChannel

type Rep UpdateChannel Source # 
Instance details

Defined in Amazonka.ChimeSDKMessaging.UpdateChannel

type Rep UpdateChannel = D1 ('MetaData "UpdateChannel" "Amazonka.ChimeSDKMessaging.UpdateChannel" "libZSservicesZSamazonka-chime-sdk-messagingZSamazonka-chime-sdk-messaging" 'False) (C1 ('MetaCons "UpdateChannel'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "metadata") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :*: S1 ('MetaSel ('Just "channelArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive Text)) :*: (S1 ('MetaSel ('Just "mode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ChannelMode) :*: S1 ('MetaSel ('Just "chimeBearer") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))
type AWSResponse UpdateChannel Source # 
Instance details

Defined in Amazonka.ChimeSDKMessaging.UpdateChannel

newUpdateChannel Source #

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

$sel:chimeBearer:UpdateChannel', updateChannel_chimeBearer - The AppInstanceUserArn of the user that makes the API call.

Request Lenses

updateChannel_metadata :: Lens' UpdateChannel (Maybe Text) Source #

The metadata for the update request.

updateChannel_name :: Lens' UpdateChannel Text Source #

The name of the channel.

updateChannel_mode :: Lens' UpdateChannel ChannelMode Source #

The mode of the update request.

updateChannel_chimeBearer :: Lens' UpdateChannel Text Source #

The AppInstanceUserArn of the user that makes the API call.

Destructuring the Response

data UpdateChannelResponse Source #

See: newUpdateChannelResponse smart constructor.

Constructors

UpdateChannelResponse' 

Fields

Instances

Instances details
Eq UpdateChannelResponse Source # 
Instance details

Defined in Amazonka.ChimeSDKMessaging.UpdateChannel

Read UpdateChannelResponse Source # 
Instance details

Defined in Amazonka.ChimeSDKMessaging.UpdateChannel

Show UpdateChannelResponse Source # 
Instance details

Defined in Amazonka.ChimeSDKMessaging.UpdateChannel

Generic UpdateChannelResponse Source # 
Instance details

Defined in Amazonka.ChimeSDKMessaging.UpdateChannel

Associated Types

type Rep UpdateChannelResponse :: Type -> Type #

NFData UpdateChannelResponse Source # 
Instance details

Defined in Amazonka.ChimeSDKMessaging.UpdateChannel

Methods

rnf :: UpdateChannelResponse -> () #

type Rep UpdateChannelResponse Source # 
Instance details

Defined in Amazonka.ChimeSDKMessaging.UpdateChannel

type Rep UpdateChannelResponse = D1 ('MetaData "UpdateChannelResponse" "Amazonka.ChimeSDKMessaging.UpdateChannel" "libZSservicesZSamazonka-chime-sdk-messagingZSamazonka-chime-sdk-messaging" 'False) (C1 ('MetaCons "UpdateChannelResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "channelArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

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