Chime / Client / create_channel_membership

create_channel_membership#

Chime.Client.create_channel_membership(**kwargs)#

Adds a user to a channel. The InvitedBy response field is derived from the request header. A channel member can:

Privacy settings impact this action as follows:

Public Channels: You do not need to be a member to list messages, but you must be a member to send messages.
Private Channels: You must be a member to list or send messages.

The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

response = client.create_channel_membership(
    ChannelArn='string',
    MemberArn='string',
    Type='DEFAULT'|'HIDDEN',
    ChimeBearer='string'
)

Parameters:

ChannelArn (string) –
[REQUIRED]

The ARN of the channel to which you’re adding users.
MemberArn (string) –
[REQUIRED]

The ARN of the member you want to add to the channel.
Type (string) –
[REQUIRED]

The membership type of a user, DEFAULT or HIDDEN. Default members are always returned as part of ListChannelMemberships. Hidden members are only returned if the type filter in ListChannelMemberships equals HIDDEN. Otherwise hidden members are not returned. This is only supported by moderators.
ChimeBearer (string) – The AppInstanceUserArn of the user that makes the API call.

Return type:

dict

Returns:

{
    'ChannelArn': 'string',
    'Member': {
        'Arn': 'string',
        'Name': 'string'
    }
}