create_channel
(**kwargs)¶Creates a channel to which you can add users and send messages.
Restriction : You can't change a channel's privacy.
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(
AppInstanceArn='string',
Name='string',
Mode='UNRESTRICTED'|'RESTRICTED',
Privacy='PUBLIC'|'PRIVATE',
Metadata='string',
ClientRequestToken='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
ChimeBearer='string',
ChannelId='string',
MemberArns=[
'string',
],
ModeratorArns=[
'string',
],
ElasticChannelConfiguration={
'MaximumSubChannels': 123,
'TargetMembershipsPerSubChannel': 123,
'MinimumMembershipPercentage': 123
}
)
[REQUIRED]
The ARN of the channel request.
[REQUIRED]
The name of the channel.
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
or PRIVATE
. Private channels aren't discoverable by users outside the channel. Public channels are discoverable by anyone in the AppInstance
.[REQUIRED]
The client token for the request. An Idempotency
token.
This field is autopopulated if not provided.
The tags for the creation request.
A tag object containing a key-value pair.
The key in a tag.
The value in a tag.
[REQUIRED]
The AppInstanceUserArn
of the user that makes the API call.
The ARNs of the channel members in the request.
The ARNs of the channel moderators in the request.
The attributes required to configure and create an elastic channel. An elastic channel can support a maximum of 1-million users, excluding moderators.
The maximum number of SubChannels that you want to allow in the elastic channel.
The maximum number of members allowed in a SubChannel.
The minimum allowed percentage of TargetMembershipsPerSubChannel users. Ceil of the calculated value is used in balancing members among SubChannels of the elastic channel.
dict
Response Syntax
{
'ChannelArn': 'string'
}
Response Structure
(dict) --
ChannelArn (string) --
The ARN of the channel.
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