ChimeSDKMessaging / Client / get_channel_membership_preferences

get_channel_membership_preferences#

ChimeSDKMessaging.Client.get_channel_membership_preferences(**kwargs)#

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.

See also: AWS API Documentation

Request Syntax

response = client.get_channel_membership_preferences(
    ChannelArn='string',
    MemberArn='string',
    ChimeBearer='string'
)

Parameters:

ChannelArn (string) –
[REQUIRED]

The ARN of the channel.
MemberArn (string) –
[REQUIRED]

The AppInstanceUserArn of the member retrieving the preferences.
ChimeBearer (string) –
[REQUIRED]

The AppInstanceUserARN of the user making the API call.

Return type:

dict

Returns:

Response Syntax

{
    'ChannelArn': 'string',
    'Member': {
        'Arn': 'string',
        'Name': 'string'
    },
    'Preferences': {
        'PushNotifications': {
            'AllowNotifications': 'ALL'|'NONE'|'FILTERED',
            'FilterRule': 'string'
        }
    }
}

Response Structure

(dict) –
- ChannelArn (string) –
  
  The ARN of the channel.
- Member (dict) –
  
  The details of a user.
  - Arn (string) –
    
    The ARN in an Identity.
  - Name (string) –
    
    The name in an Identity.
- Preferences (dict) –
  
  The channel membership preferences for an AppInstanceUser .
  - PushNotifications (dict) –
    
    The push notification configuration of a message.
    - AllowNotifications (string) –
      
      Enum value that indicates which push notifications to send to the requested member of a channel. ALL sends all push notifications, NONE sends no push notifications, FILTERED sends only filtered push notifications.
    - FilterRule (string) –
      
      The simple JSON object used to send a subset of a push notification to the requested member.

Exceptions

ChimeSDKMessaging.Client.exceptions.BadRequestException
ChimeSDKMessaging.Client.exceptions.UnauthorizedClientException
ChimeSDKMessaging.Client.exceptions.ForbiddenException
ChimeSDKMessaging.Client.exceptions.ThrottledClientException
ChimeSDKMessaging.Client.exceptions.ServiceUnavailableException
ChimeSDKMessaging.Client.exceptions.ServiceFailureException