Skip to content

CreateChannelMembershipRequest

Source code in docs_src/capo_chime_sdk_messaging/types/create_channel_membership_request.py 
15
16
17
18
19
20
21
22
23
24
25
26
27
class CreateChannelMembershipRequest(TypedDict, closed=True):
    channel_arn: "capo_chime_sdk_messaging.types.chime_arn.ChimeArn"
    """<p>The ARN of the channel to which you're adding users.</p>"""
    member_arn: "capo_chime_sdk_messaging.types.chime_arn.ChimeArn"
    """<p>The <code>AppInstanceUserArn</code> of the member you want to add to the channel.</p>"""
    type: "capo_chime_sdk_messaging.types.channel_membership_type.ChannelMembershipType"
    """<p>The membership type of a user, <code>DEFAULT</code> or <code>HIDDEN</code>. Default members are always returned as part of <code>ListChannelMemberships</code>. Hidden members are only returned if the type filter in <code>ListChannelMemberships</code> equals <code>HIDDEN</code>. Otherwise hidden members are not returned. This is only supported by moderators.</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>"""
    sub_channel_id: NotRequired[
        "capo_chime_sdk_messaging.types.sub_channel_id.SubChannelId"
    ]
    """<p>The ID of the SubChannel in the request.</p> <note> <p>Only required when creating membership in a SubChannel for a moderator in an elastic channel.</p> </note>"""

channel_arn instance-attribute 

channel_arn: ChimeArn

The ARN of the channel to which you're adding users.

chime_bearer instance-attribute 

chime_bearer: ChimeArn

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

member_arn instance-attribute 

member_arn: ChimeArn

The AppInstanceUserArn of the member you want to add to the channel.

sub_channel_id instance-attribute 

sub_channel_id: NotRequired[SubChannelId]

The ID of the SubChannel in the request.

Only required when creating membership in a SubChannel for a moderator in an elastic channel.

type instance-attribute 

type: ChannelMembershipType

The membership type of a user, DEFAULT or HIDDEN. Default members are always returned as part of ListChannelMemberships. Hidden members are only returned if the type filter in ListChannelMemberships equals HIDDEN. Otherwise hidden members are not returned. This is only supported by moderators.