ChimeSDKMessaging / Client / put_channel_membership_preferences

put_channel_membership_preferences#

ChimeSDKMessaging.Client.put_channel_membership_preferences(**kwargs)#

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

Note

The x-amz-chime-bearer request header is mandatory. Use the ARN of an AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

See also: AWS API Documentation

Request Syntax

response = client.put_channel_membership_preferences(
    ChannelArn='string',
    MemberArn='string',
    ChimeBearer='string',
    Preferences={
        'PushNotifications': {
            'AllowNotifications': 'ALL'|'NONE'|'FILTERED',
            'FilterRule': 'string'
        }
    }
)
Parameters:

  • ChannelArn (string) –

    [REQUIRED]

    The ARN of the channel.

  • MemberArn (string) –

    [REQUIRED]

    The ARN of the member setting the preferences.

  • ChimeBearer (string) –

    [REQUIRED]

    The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.

  • Preferences (dict) –

    [REQUIRED]

    The channel membership preferences of an AppInstanceUser .

    • PushNotifications (dict) –

      The push notification configuration of a message.

      • AllowNotifications (string) – [REQUIRED]

        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.

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 ARN and metadata of the member being added.

      • 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.ConflictException

  • ChimeSDKMessaging.Client.exceptions.UnauthorizedClientException

  • ChimeSDKMessaging.Client.exceptions.ForbiddenException

  • ChimeSDKMessaging.Client.exceptions.ThrottledClientException

  • ChimeSDKMessaging.Client.exceptions.ServiceUnavailableException

  • ChimeSDKMessaging.Client.exceptions.ServiceFailureException