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 CreateChannel operation. Creates a channel to which you can add users and send messages.

Restriction: You can't change a channel's privacy.

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.CreateChannelRequest

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

Syntax

C# 
public class CreateChannelRequest : AmazonChimeSDKMessagingRequest
         IAmazonWebServiceRequest

The CreateChannelRequest type exposes the following members

Constructors

NameDescription
Public Method CreateChannelRequest()

Properties

NameTypeDescription
Public Property AppInstanceArn System.String

Gets and sets the property AppInstanceArn.

The ARN of the channel request.

Public Property ChannelId System.String

Gets and sets the property ChannelId.

The ID of the channel in the 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 ClientRequestToken System.String

Gets and sets the property ClientRequestToken.

The client token for the request. An Idempotency token.

Public Property ElasticChannelConfiguration Amazon.ChimeSDKMessaging.Model.ElasticChannelConfiguration

Gets and sets the property ElasticChannelConfiguration.

The attributes required to configure and create an elastic channel. An elastic channel can support a maximum of 1-million users, excluding moderators.

Public Property ExpirationSettings Amazon.ChimeSDKMessaging.Model.ExpirationSettings

Gets and sets the property ExpirationSettings.

Settings that control the interval after which the channel is automatically deleted.

Public Property MemberArns System.Collections.Generic.List<System.String>

Gets and sets the property MemberArns.

The ARNs of the channel members in the request.

Public Property Metadata System.String

Gets and sets the property Metadata.

The metadata of the creation request. Limited to 1KB and UTF-8.

Public Property Mode Amazon.ChimeSDKMessaging.ChannelMode

Gets and sets the property Mode.

The channel mode: UNRESTRICTED or RESTRICTED. Administrators, moderators, and channel members can add themselves and other members to unrestricted channels. Only administrators and moderators can add members to restricted channels.

Public Property ModeratorArns System.Collections.Generic.List<System.String>

Gets and sets the property ModeratorArns.

The ARNs of the channel moderators in the request.

Public Property Name System.String

Gets and sets the property Name.

The name of the channel.

Public Property Privacy Amazon.ChimeSDKMessaging.ChannelPrivacy

Gets and sets the property Privacy.

The channel's privacy level: PUBLIC or PRIVATE. Private channels aren't discoverable by users outside the channel. Public channels are discoverable by anyone in the AppInstance.

Public Property Tags System.Collections.Generic.List<Amazon.ChimeSDKMessaging.Model.Tag>

Gets and sets the property Tags.

The tags for the creation request.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5