Skip to content

DescribeChannelMembershipRequest

Source code in docs_src/capo_chime_sdk_messaging/types/describe_channel_membership_request.py 
12
13
14
15
16
17
18
19
20
21
22
class DescribeChannelMembershipRequest(TypedDict, closed=True):
    channel_arn: "capo_chime_sdk_messaging.types.chime_arn.ChimeArn"
    """<p>The ARN of the channel.</p>"""
    member_arn: "capo_chime_sdk_messaging.types.chime_arn.ChimeArn"
    """<p>The <code>AppInstanceUserArn</code> of the member.</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. The response contains an <code>ElasticChannelConfiguration</code> object.</p> <note> <p>Only required to get a user’s SubChannel membership details.</p> </note>"""

channel_arn instance-attribute 

channel_arn: ChimeArn

The ARN of the channel.

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.

sub_channel_id instance-attribute 

sub_channel_id: NotRequired[SubChannelId]

The ID of the SubChannel in the request. The response contains an ElasticChannelConfiguration object.

Only required to get a user’s SubChannel membership details.