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 AppInstanceUserArn of the user that makes the API call as the value in the header.

This API is is no longer supported and will not be updated. We recommend using the latest version, CreateChannel, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.Chime.AmazonChimeRequest
      Amazon.Chime.Model.CreateChannelRequest

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

Syntax

C# 
public class CreateChannelRequest : AmazonChimeRequest
         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 ChimeBearer System.String

Gets and sets the property ChimeBearer.

The AppInstanceUserArn of the user 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 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.Chime.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 Name System.String

Gets and sets the property Name.

The name of the channel.

Public Property Privacy Amazon.Chime.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.Chime.Model.Tag>

Gets and sets the property Tags.

The tags for the creation request.

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