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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Sets the membership preferences of an AppInstanceUser for the specified channel. The AppInstanceUser must be a member of the channel. Only the AppInstanceUser who owns the membership can set preferences. Users in the AppInstanceAdmin and channel moderator roles can't set preferences for other users. Banned users can't set membership preferences for the channel from which they are banned.

Synopsis

Creating a Request

data PutChannelMembershipPreferences Source #

See: newPutChannelMembershipPreferences smart constructor.

Constructors

PutChannelMembershipPreferences'
Fields channelArn :: Text The ARN of the channel. memberArn :: Text The `AppInstanceUserArn` of the member setting the preferences. chimeBearer :: Text The `AppInstanceUserARN` of the user making the API call. preferences :: ChannelMembershipPreferences The channel membership preferences of an `AppInstanceUser` .

Instances

Instances details

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

newPutChannelMembershipPreferences Source #

Arguments

:: Text	`PutChannelMembershipPreferences`
-> Text	`PutChannelMembershipPreferences`
-> Text	`$sel:chimeBearer:PutChannelMembershipPreferences'`
-> ChannelMembershipPreferences	`PutChannelMembershipPreferences`
-> PutChannelMembershipPreferences

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

PutChannelMembershipPreferences, putChannelMembershipPreferences_channelArn - The ARN of the channel.

PutChannelMembershipPreferences, putChannelMembershipPreferences_memberArn - The AppInstanceUserArn of the member setting the preferences.

$sel:chimeBearer:PutChannelMembershipPreferences', putChannelMembershipPreferences_chimeBearer - The AppInstanceUserARN of the user making the API call.

PutChannelMembershipPreferences, putChannelMembershipPreferences_preferences - The channel membership preferences of an AppInstanceUser .

Request Lenses

putChannelMembershipPreferences_channelArn :: Lens' PutChannelMembershipPreferences Text Source #

The ARN of the channel.

putChannelMembershipPreferences_memberArn :: Lens' PutChannelMembershipPreferences Text Source #

The AppInstanceUserArn of the member setting the preferences.

putChannelMembershipPreferences_chimeBearer :: Lens' PutChannelMembershipPreferences Text Source #

The AppInstanceUserARN of the user making the API call.

putChannelMembershipPreferences_preferences :: Lens' PutChannelMembershipPreferences ChannelMembershipPreferences Source #

The channel membership preferences of an AppInstanceUser .

Destructuring the Response

data PutChannelMembershipPreferencesResponse Source #

See: newPutChannelMembershipPreferencesResponse smart constructor.

Constructors

PutChannelMembershipPreferencesResponse'
Fields channelArn :: Maybe Text The ARN of the channel. member :: Maybe Identity The details of a user. preferences :: Maybe ChannelMembershipPreferences The ARN and metadata of the member being added. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic PutChannelMembershipPreferencesResponse Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.PutChannelMembershipPreferences Associated Types type Rep PutChannelMembershipPreferencesResponse :: Type -> Type # Methods from :: PutChannelMembershipPreferencesResponse -> Rep PutChannelMembershipPreferencesResponse x # to :: Rep PutChannelMembershipPreferencesResponse x -> PutChannelMembershipPreferencesResponse #
Show PutChannelMembershipPreferencesResponse Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.PutChannelMembershipPreferences Methods showsPrec :: Int -> PutChannelMembershipPreferencesResponse -> ShowS # show :: PutChannelMembershipPreferencesResponse -> String # showList :: [PutChannelMembershipPreferencesResponse] -> ShowS #
NFData PutChannelMembershipPreferencesResponse Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.PutChannelMembershipPreferences Methods rnf :: PutChannelMembershipPreferencesResponse -> () #
Eq PutChannelMembershipPreferencesResponse Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.PutChannelMembershipPreferences Methods (==) :: PutChannelMembershipPreferencesResponse -> PutChannelMembershipPreferencesResponse -> Bool # (/=) :: PutChannelMembershipPreferencesResponse -> PutChannelMembershipPreferencesResponse -> Bool #
type Rep PutChannelMembershipPreferencesResponse Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.PutChannelMembershipPreferences type Rep PutChannelMembershipPreferencesResponse = D1 ('MetaData "PutChannelMembershipPreferencesResponse" "Amazonka.ChimeSDKMessaging.PutChannelMembershipPreferences" "amazonka-chime-sdk-messaging-2.0-BxY1AbjLoDB4AQUv82PCQZ" 'False) (C1 ('MetaCons "PutChannelMembershipPreferencesResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "channelArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "member") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Identity))) :: (S1 ('MetaSel ('Just "preferences") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ChannelMembershipPreferences)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newPutChannelMembershipPreferencesResponse Source #

Arguments

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

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

PutChannelMembershipPreferences, putChannelMembershipPreferencesResponse_channelArn - The ARN of the channel.

PutChannelMembershipPreferencesResponse, putChannelMembershipPreferencesResponse_member - The details of a user.

PutChannelMembershipPreferences, putChannelMembershipPreferencesResponse_preferences - The ARN and metadata of the member being added.

$sel:httpStatus:PutChannelMembershipPreferencesResponse', putChannelMembershipPreferencesResponse_httpStatus - The response's http status code.

Response Lenses

putChannelMembershipPreferencesResponse_channelArn :: Lens' PutChannelMembershipPreferencesResponse (Maybe Text) Source #

The ARN of the channel.

putChannelMembershipPreferencesResponse_member :: Lens' PutChannelMembershipPreferencesResponse (Maybe Identity) Source #

The details of a user.

putChannelMembershipPreferencesResponse_preferences :: Lens' PutChannelMembershipPreferencesResponse (Maybe ChannelMembershipPreferences) Source #

The ARN and metadata of the member being added.

putChannelMembershipPreferencesResponse_httpStatus :: Lens' PutChannelMembershipPreferencesResponse Int Source #

The response's http status code.