Amazonka.ChimeSDKMessaging.GetChannelMembershipPreferences

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.

Creating a Request

data GetChannelMembershipPreferences

See: newGetChannelMembershipPreferences smart constructor.

Constructors

GetChannelMembershipPreferences'

Fields

• channelArn :: Text

  The ARN of the channel.

• memberArn :: Text

  The AppInstanceUserArn of the member retrieving the preferences.

• chimeBearer :: Text

  The AppInstanceUserARN of the user making the API call.

Instances

ToHeaders GetChannelMembershipPreferences

Defined in Amazonka.ChimeSDKMessaging.GetChannelMembershipPreferences

Methods

toHeaders :: GetChannelMembershipPreferences -> [Header]

ToPath GetChannelMembershipPreferences

Defined in Amazonka.ChimeSDKMessaging.GetChannelMembershipPreferences

Methods

toPath :: GetChannelMembershipPreferences -> ByteString

ToQuery GetChannelMembershipPreferences

Defined in Amazonka.ChimeSDKMessaging.GetChannelMembershipPreferences

Methods

toQuery :: GetChannelMembershipPreferences -> QueryString

AWSRequest GetChannelMembershipPreferences

Defined in Amazonka.ChimeSDKMessaging.GetChannelMembershipPreferences

Associated Types

type AWSResponse GetChannelMembershipPreferences

Methods

request :: (Service -> Service) -> GetChannelMembershipPreferences -> Request GetChannelMembershipPreferences

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetChannelMembershipPreferences -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetChannelMembershipPreferences)))

Generic GetChannelMembershipPreferences

Defined in Amazonka.ChimeSDKMessaging.GetChannelMembershipPreferences

Associated Types

type Rep GetChannelMembershipPreferences :: Type -> Type

Methods

from :: GetChannelMembershipPreferences -> Rep GetChannelMembershipPreferences x

to :: Rep GetChannelMembershipPreferences x -> GetChannelMembershipPreferences

Read GetChannelMembershipPreferences

Defined in Amazonka.ChimeSDKMessaging.GetChannelMembershipPreferences

Methods

readsPrec :: Int -> ReadS GetChannelMembershipPreferences

readList :: ReadS [GetChannelMembershipPreferences]

readPrec :: ReadPrec GetChannelMembershipPreferences

readListPrec :: ReadPrec [GetChannelMembershipPreferences]

Show GetChannelMembershipPreferences

Defined in Amazonka.ChimeSDKMessaging.GetChannelMembershipPreferences

Methods

showsPrec :: Int -> GetChannelMembershipPreferences -> ShowS

show :: GetChannelMembershipPreferences -> String

showList :: [GetChannelMembershipPreferences] -> ShowS

NFData GetChannelMembershipPreferences

Defined in Amazonka.ChimeSDKMessaging.GetChannelMembershipPreferences

Methods

rnf :: GetChannelMembershipPreferences -> ()

Eq GetChannelMembershipPreferences

Defined in Amazonka.ChimeSDKMessaging.GetChannelMembershipPreferences

Methods

(==) :: GetChannelMembershipPreferences -> GetChannelMembershipPreferences -> Bool

(/=) :: GetChannelMembershipPreferences -> GetChannelMembershipPreferences -> Bool

Hashable GetChannelMembershipPreferences

Defined in Amazonka.ChimeSDKMessaging.GetChannelMembershipPreferences

Methods

hashWithSalt :: Int -> GetChannelMembershipPreferences -> Int

hash :: GetChannelMembershipPreferences -> Int

type AWSResponse GetChannelMembershipPreferences

Defined in Amazonka.ChimeSDKMessaging.GetChannelMembershipPreferences

type AWSResponse GetChannelMembershipPreferences = GetChannelMembershipPreferencesResponse

type Rep GetChannelMembershipPreferences

Defined in Amazonka.ChimeSDKMessaging.GetChannelMembershipPreferences

type Rep GetChannelMembershipPreferences = D1 ('MetaData "GetChannelMembershipPreferences" "Amazonka.ChimeSDKMessaging.GetChannelMembershipPreferences" "amazonka-chime-sdk-messaging-2.0-BxY1AbjLoDB4AQUv82PCQZ" 'False) (C1 ('MetaCons "GetChannelMembershipPreferences'" '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))))

newGetChannelMembershipPreferences

Arguments

:: Text

GetChannelMembershipPreferences

-> Text

GetChannelMembershipPreferences

-> Text

$sel:chimeBearer:GetChannelMembershipPreferences'

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

The ARN of the channel.

getChannelMembershipPreferences_memberArn :: Lens' GetChannelMembershipPreferences Text

The AppInstanceUserArn of the member retrieving the preferences.

getChannelMembershipPreferences_chimeBearer :: Lens' GetChannelMembershipPreferences Text

The AppInstanceUserARN of the user making the API call.

Destructuring the Response

data GetChannelMembershipPreferencesResponse

See: newGetChannelMembershipPreferencesResponse smart constructor.

Constructors

GetChannelMembershipPreferencesResponse'

Fields

• channelArn :: Maybe Text

  The ARN of the channel.

• member :: Maybe Identity

  The details of a user.

• preferences :: Maybe ChannelMembershipPreferences

  The channel membership preferences for an AppInstanceUser .

• httpStatus :: Int

  The response's http status code.

Instances

Generic GetChannelMembershipPreferencesResponse

Defined in Amazonka.ChimeSDKMessaging.GetChannelMembershipPreferences

Associated Types

type Rep GetChannelMembershipPreferencesResponse :: Type -> Type

Methods

from :: GetChannelMembershipPreferencesResponse -> Rep GetChannelMembershipPreferencesResponse x

to :: Rep GetChannelMembershipPreferencesResponse x -> GetChannelMembershipPreferencesResponse

Show GetChannelMembershipPreferencesResponse

Defined in Amazonka.ChimeSDKMessaging.GetChannelMembershipPreferences

Methods

showsPrec :: Int -> GetChannelMembershipPreferencesResponse -> ShowS

show :: GetChannelMembershipPreferencesResponse -> String

showList :: [GetChannelMembershipPreferencesResponse] -> ShowS

NFData GetChannelMembershipPreferencesResponse

Defined in Amazonka.ChimeSDKMessaging.GetChannelMembershipPreferences

Methods

rnf :: GetChannelMembershipPreferencesResponse -> ()

Eq GetChannelMembershipPreferencesResponse

Defined in Amazonka.ChimeSDKMessaging.GetChannelMembershipPreferences

Methods

(==) :: GetChannelMembershipPreferencesResponse -> GetChannelMembershipPreferencesResponse -> Bool

(/=) :: GetChannelMembershipPreferencesResponse -> GetChannelMembershipPreferencesResponse -> Bool

type Rep GetChannelMembershipPreferencesResponse

Defined in Amazonka.ChimeSDKMessaging.GetChannelMembershipPreferences

type Rep GetChannelMembershipPreferencesResponse = D1 ('MetaData "GetChannelMembershipPreferencesResponse" "Amazonka.ChimeSDKMessaging.GetChannelMembershipPreferences" "amazonka-chime-sdk-messaging-2.0-BxY1AbjLoDB4AQUv82PCQZ" 'False) (C1 ('MetaCons "GetChannelMembershipPreferencesResponse'" '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))))

newGetChannelMembershipPreferencesResponse

Arguments

:: Int

$sel:httpStatus:GetChannelMembershipPreferencesResponse'

-> 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)

The ARN of the channel.

getChannelMembershipPreferencesResponse_member :: Lens' GetChannelMembershipPreferencesResponse (Maybe Identity)

The details of a user.

getChannelMembershipPreferencesResponse_preferences :: Lens' GetChannelMembershipPreferencesResponse (Maybe ChannelMembershipPreferences)

The channel membership preferences for an AppInstanceUser .

getChannelMembershipPreferencesResponse_httpStatus :: Lens' GetChannelMembershipPreferencesResponse Int

The response's http status code.