ChimeSDKMessaging / Client / delete_channel_membership

delete_channel_membership#

ChimeSDKMessaging.Client.delete_channel_membership(**kwargs)#

Removes a member from a channel.

Note

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.

Request Syntax

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

Parameters:

ChannelArn (string) –
[REQUIRED]

The ARN of the channel from which you want to remove the user.
MemberArn (string) –
[REQUIRED]

The AppInstanceUserArn of the member that you’re removing from the channel.
ChimeBearer (string) –
[REQUIRED]

The AppInstanceUserArn of the user that makes the API call.
SubChannelId (string) –
The ID of the SubChannel in the request.

Note

Only for use by moderators.

Returns:

None

Exceptions