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.Chime.UpdateChannel

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

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.

Creating a Request

data UpdateChannel Source #

See: newUpdateChannel smart constructor.

Constructors

UpdateChannel'
Fields chimeBearer :: Maybe Text The `AppInstanceUserArn` of the user that makes the API call. metadata :: Maybe (Sensitive Text) The metadata for the update request. channelArn :: Text The ARN of the channel. name :: Sensitive Text The name of the channel. mode :: ChannelMode The mode of the update request.

Instances

Instances details

ToJSON UpdateChannel Source #
Instance details Defined in Amazonka.Chime.UpdateChannel Methods toJSON :: UpdateChannel -> Value # toEncoding :: UpdateChannel -> Encoding # toJSONList :: [UpdateChannel] -> Value # toEncodingList :: [UpdateChannel] -> Encoding #
ToHeaders UpdateChannel Source #
Instance details Defined in Amazonka.Chime.UpdateChannel Methods toHeaders :: UpdateChannel -> [Header] #
ToPath UpdateChannel Source #
Instance details Defined in Amazonka.Chime.UpdateChannel Methods toPath :: UpdateChannel -> ByteString #
ToQuery UpdateChannel Source #
Instance details Defined in Amazonka.Chime.UpdateChannel Methods toQuery :: UpdateChannel -> QueryString #
AWSRequest UpdateChannel Source #
Instance details Defined in Amazonka.Chime.UpdateChannel Associated Types type AWSResponse UpdateChannel # Methods request :: (Service -> Service) -> UpdateChannel -> Request UpdateChannel # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy UpdateChannel -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateChannel))) #
Generic UpdateChannel Source #
Instance details Defined in Amazonka.Chime.UpdateChannel Associated Types type Rep UpdateChannel :: Type -> Type # Methods from :: UpdateChannel -> Rep UpdateChannel x # to :: Rep UpdateChannel x -> UpdateChannel #
Show UpdateChannel Source #
Instance details Defined in Amazonka.Chime.UpdateChannel Methods showsPrec :: Int -> UpdateChannel -> ShowS # show :: UpdateChannel -> String # showList :: [UpdateChannel] -> ShowS #
NFData UpdateChannel Source #
Instance details Defined in Amazonka.Chime.UpdateChannel Methods rnf :: UpdateChannel -> () #
Eq UpdateChannel Source #
Instance details Defined in Amazonka.Chime.UpdateChannel Methods (==) :: UpdateChannel -> UpdateChannel -> Bool # (/=) :: UpdateChannel -> UpdateChannel -> Bool #
Hashable UpdateChannel Source #
Instance details Defined in Amazonka.Chime.UpdateChannel Methods hashWithSalt :: Int -> UpdateChannel -> Int # hash :: UpdateChannel -> Int #
type AWSResponse UpdateChannel Source #
Instance details Defined in Amazonka.Chime.UpdateChannel type AWSResponse UpdateChannel = UpdateChannelResponse
type Rep UpdateChannel Source #
Instance details Defined in Amazonka.Chime.UpdateChannel type Rep UpdateChannel = D1 ('MetaData "UpdateChannel" "Amazonka.Chime.UpdateChannel" "amazonka-chime-2.0-AQIuSSkHccQ9VXokPBc5Nb" 'False) (C1 ('MetaCons "UpdateChannel'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "chimeBearer") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: 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)))))

newUpdateChannel Source #

Arguments

:: Text	`UpdateChannel`
-> Text	`UpdateChannel`
-> ChannelMode	`UpdateChannel`
-> 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.

UpdateChannel, updateChannel_metadata - The metadata for the update request.

UpdateChannel, updateChannel_channelArn - The ARN of the channel.

UpdateChannel, updateChannel_name - The name of the channel.

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 channelArn :: Maybe Text The ARN of the channel. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic UpdateChannelResponse Source #
Instance details Defined in Amazonka.Chime.UpdateChannel Associated Types type Rep UpdateChannelResponse :: Type -> Type # Methods from :: UpdateChannelResponse -> Rep UpdateChannelResponse x # to :: Rep UpdateChannelResponse x -> UpdateChannelResponse #
Read UpdateChannelResponse Source #
Instance details Defined in Amazonka.Chime.UpdateChannel Methods readsPrec :: Int -> ReadS UpdateChannelResponse # readList :: ReadS [UpdateChannelResponse] # readPrec :: ReadPrec UpdateChannelResponse # readListPrec :: ReadPrec [UpdateChannelResponse] #
Show UpdateChannelResponse Source #
Instance details Defined in Amazonka.Chime.UpdateChannel Methods showsPrec :: Int -> UpdateChannelResponse -> ShowS # show :: UpdateChannelResponse -> String # showList :: [UpdateChannelResponse] -> ShowS #
NFData UpdateChannelResponse Source #
Instance details Defined in Amazonka.Chime.UpdateChannel Methods rnf :: UpdateChannelResponse -> () #
Eq UpdateChannelResponse Source #
Instance details Defined in Amazonka.Chime.UpdateChannel Methods (==) :: UpdateChannelResponse -> UpdateChannelResponse -> Bool # (/=) :: UpdateChannelResponse -> UpdateChannelResponse -> Bool #
type Rep UpdateChannelResponse Source #
Instance details Defined in Amazonka.Chime.UpdateChannel type Rep UpdateChannelResponse = D1 ('MetaData "UpdateChannelResponse" "Amazonka.Chime.UpdateChannel" "amazonka-chime-2.0-AQIuSSkHccQ9VXokPBc5Nb" '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 #

Arguments

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

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:

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.