CreateChannelRequest ¶

class CreateChannelRequest(TypedDict, closed=True):
    app_instance_arn: "capo_chime_sdk_messaging.types.chime_arn.ChimeArn"
    """<p>The ARN of the channel request.</p>"""
    name: "capo_chime_sdk_messaging.types.non_empty_resource_name.NonEmptyResourceName"
    """<p>The name of the channel.</p>"""
    mode: NotRequired["capo_chime_sdk_messaging.types.channel_mode.ChannelMode"]
    """<p>The channel mode: <code>UNRESTRICTED</code> or <code>RESTRICTED</code>. Administrators, moderators, and channel members can add themselves and other members to unrestricted channels. Only administrators and moderators can add members to restricted channels.</p>"""
    privacy: NotRequired[
        "capo_chime_sdk_messaging.types.channel_privacy.ChannelPrivacy"
    ]
    """<p>The channel's privacy level: <code>PUBLIC</code> or <code>PRIVATE</code>. Private channels aren't discoverable by users outside the channel. Public channels are discoverable by anyone in the <code>AppInstance</code>.</p>"""
    metadata: NotRequired["capo_chime_sdk_messaging.types.metadata.Metadata"]
    """<p>The metadata of the creation request. Limited to 1KB and UTF-8.</p>"""
    client_request_token: (
        "capo_chime_sdk_messaging.types.client_request_token.ClientRequestToken"
    )
    """<p>The client token for the request. An <code>Idempotency</code> token.</p>"""
    tags: NotRequired["capo_chime_sdk_messaging.types.tag_list.TagList"]
    """<p>The tags for the creation request.</p>"""
    chime_bearer: "capo_chime_sdk_messaging.types.chime_arn.ChimeArn"
    """<p>The ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call.</p>"""
    channel_id: NotRequired["capo_chime_sdk_messaging.types.channel_id.ChannelId"]
    """<p>An ID for the channel being created. If you do not specify an ID, a UUID will be created for the channel.</p>"""
    member_arns: NotRequired[
        "capo_chime_sdk_messaging.types.channel_member_arns.ChannelMemberArns"
    ]
    """<p>The ARNs of the channel members in the request.</p>"""
    moderator_arns: NotRequired[
        "capo_chime_sdk_messaging.types.channel_moderator_arns.ChannelModeratorArns"
    ]
    """<p>The ARNs of the channel moderators in the request.</p>"""
    elastic_channel_configuration: NotRequired[
        "capo_chime_sdk_messaging.types.elastic_channel_configuration.ElasticChannelConfiguration"
    ]
    """<p>The attributes required to configure and create an elastic channel. An elastic channel can support a maximum of 1-million users, excluding moderators.</p>"""
    expiration_settings: NotRequired[
        "capo_chime_sdk_messaging.types.expiration_settings.ExpirationSettings"
    ]
    """<p>Settings that control the interval after which the channel is automatically deleted.</p>"""