AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the CreateChannelBan operation. 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.

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

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.ChimeSDKMessaging.AmazonChimeSDKMessagingRequest
      Amazon.ChimeSDKMessaging.Model.CreateChannelBanRequest

Namespace: Amazon.ChimeSDKMessaging.Model
Assembly: AWSSDK.ChimeSDKMessaging.dll
Version: 3.x.y.z

Syntax

C#
public class CreateChannelBanRequest : AmazonChimeSDKMessagingRequest
         IAmazonWebServiceRequest

The CreateChannelBanRequest type exposes the following members

Constructors

NameDescription
Public Method CreateChannelBanRequest()

Properties

NameTypeDescription
Public Property ChannelArn System.String

Gets and sets the property ChannelArn.

The ARN of the ban request.

Public Property ChimeBearer System.String

Gets and sets the property ChimeBearer.

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

Public Property MemberArn System.String

Gets and sets the property MemberArn.

The AppInstanceUserArn of the member being banned.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5