create_channel_ban

ChimeSDKMessaging.Client.create_channel_ban(**kwargs)

Permanently bans a member from a channel. Moderators can't add banned members to a channel. To undo a ban, you first have to DeleteChannelBan , and then CreateChannelMembership . Bans are cleaned up when you delete users or channels.

If you ban a user who is already part of a channel, that user is automatically kicked from the 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.

See also: AWS API Documentation

Request Syntax

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

Parameters

• ChannelArn (string) --

  [REQUIRED]

  The ARN of the ban request.

• MemberArn (string) --

  [REQUIRED]

  The AppInstanceUserArn of the member being banned.

• ChimeBearer (string) --

  [REQUIRED]

  The AppInstanceUserArn of the user that makes the API call.

Return type

dict

Returns

Response Syntax

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

Response Structure

• (dict) --

  • ChannelArn (string) --

    The ARN of the response to the ban request.

  • Member (dict) --

    The ChannelArn and BannedIdentity of the member in the ban response.

    • Arn (string) --

      The ARN in an Identity.

    • Name (string) --

      The name in an Identity.

Exceptions

• ChimeSDKMessaging.Client.exceptions.BadRequestException
• ChimeSDKMessaging.Client.exceptions.ForbiddenException
• ChimeSDKMessaging.Client.exceptions.UnauthorizedClientException
• ChimeSDKMessaging.Client.exceptions.ConflictException
• ChimeSDKMessaging.Client.exceptions.ResourceLimitExceededException
• ChimeSDKMessaging.Client.exceptions.ThrottledClientException
• ChimeSDKMessaging.Client.exceptions.ServiceUnavailableException
• ChimeSDKMessaging.Client.exceptions.ServiceFailureException