| 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.GetChannelMembershipPreferences
Description
Gets 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 retrieve
preferences. Users in the AppInstanceAdmin and channel moderator roles
can't retrieve preferences for other users. Banned users can't
retrieve membership preferences for the channel from which they are
banned.
Synopsis
- data GetChannelMembershipPreferences = GetChannelMembershipPreferences' {
- channelArn :: Text
- memberArn :: Text
- chimeBearer :: Text
- newGetChannelMembershipPreferences :: Text -> Text -> Text -> GetChannelMembershipPreferences
- getChannelMembershipPreferences_channelArn :: Lens' GetChannelMembershipPreferences Text
- getChannelMembershipPreferences_memberArn :: Lens' GetChannelMembershipPreferences Text
- getChannelMembershipPreferences_chimeBearer :: Lens' GetChannelMembershipPreferences Text
- data GetChannelMembershipPreferencesResponse = GetChannelMembershipPreferencesResponse' {}
- newGetChannelMembershipPreferencesResponse :: Int -> GetChannelMembershipPreferencesResponse
- getChannelMembershipPreferencesResponse_channelArn :: Lens' GetChannelMembershipPreferencesResponse (Maybe Text)
- getChannelMembershipPreferencesResponse_member :: Lens' GetChannelMembershipPreferencesResponse (Maybe Identity)
- getChannelMembershipPreferencesResponse_preferences :: Lens' GetChannelMembershipPreferencesResponse (Maybe ChannelMembershipPreferences)
- getChannelMembershipPreferencesResponse_httpStatus :: Lens' GetChannelMembershipPreferencesResponse Int
Creating a Request
data GetChannelMembershipPreferences Source #
See: newGetChannelMembershipPreferences smart constructor.
Constructors
| GetChannelMembershipPreferences' | |
Fields
| |
Instances
newGetChannelMembershipPreferences Source #
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> GetChannelMembershipPreferences |
Create a value of GetChannelMembershipPreferences 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:
GetChannelMembershipPreferences, getChannelMembershipPreferences_channelArn - The ARN of the channel.
GetChannelMembershipPreferences, getChannelMembershipPreferences_memberArn - The AppInstanceUserArn of the member retrieving the preferences.
$sel:chimeBearer:GetChannelMembershipPreferences', getChannelMembershipPreferences_chimeBearer - The AppInstanceUserARN of the user making the API call.
Request Lenses
getChannelMembershipPreferences_channelArn :: Lens' GetChannelMembershipPreferences Text Source #
The ARN of the channel.
getChannelMembershipPreferences_memberArn :: Lens' GetChannelMembershipPreferences Text Source #
The AppInstanceUserArn of the member retrieving the preferences.
getChannelMembershipPreferences_chimeBearer :: Lens' GetChannelMembershipPreferences Text Source #
The AppInstanceUserARN of the user making the API call.
Destructuring the Response
data GetChannelMembershipPreferencesResponse Source #
See: newGetChannelMembershipPreferencesResponse smart constructor.
Constructors
| GetChannelMembershipPreferencesResponse' | |
Fields
| |
Instances
newGetChannelMembershipPreferencesResponse Source #
Arguments
| :: Int | |
| -> GetChannelMembershipPreferencesResponse |
Create a value of GetChannelMembershipPreferencesResponse 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:
GetChannelMembershipPreferences, getChannelMembershipPreferencesResponse_channelArn - The ARN of the channel.
GetChannelMembershipPreferencesResponse, getChannelMembershipPreferencesResponse_member - The details of a user.
$sel:preferences:GetChannelMembershipPreferencesResponse', getChannelMembershipPreferencesResponse_preferences - The channel membership preferences for an AppInstanceUser .
$sel:httpStatus:GetChannelMembershipPreferencesResponse', getChannelMembershipPreferencesResponse_httpStatus - The response's http status code.
Response Lenses
getChannelMembershipPreferencesResponse_channelArn :: Lens' GetChannelMembershipPreferencesResponse (Maybe Text) Source #
The ARN of the channel.
getChannelMembershipPreferencesResponse_member :: Lens' GetChannelMembershipPreferencesResponse (Maybe Identity) Source #
The details of a user.
getChannelMembershipPreferencesResponse_preferences :: Lens' GetChannelMembershipPreferencesResponse (Maybe ChannelMembershipPreferences) Source #
The channel membership preferences for an AppInstanceUser .
getChannelMembershipPreferencesResponse_httpStatus :: Lens' GetChannelMembershipPreferencesResponse Int Source #
The response's http status code.