Skip to content

ListChannelsRequest

Source code in docs_src/capo_chime_sdk_messaging/types/list_channels_request.py 
14
15
16
17
18
19
20
21
22
23
24
25
26
class ListChannelsRequest(TypedDict, closed=True):
    app_instance_arn: "capo_chime_sdk_messaging.types.chime_arn.ChimeArn"
    """<p>The ARN of the <code>AppInstance</code>.</p>"""
    privacy: NotRequired[
        "capo_chime_sdk_messaging.types.channel_privacy.ChannelPrivacy"
    ]
    """<p>The privacy setting. <code>PUBLIC</code> retrieves all the public channels. <code>PRIVATE</code> retrieves private channels. Only an <code>AppInstanceAdmin</code> can retrieve private channels. </p>"""
    max_results: NotRequired["capo_chime_sdk_messaging.types.max_results.MaxResults"]
    """<p>The maximum number of channels that you want to return.</p>"""
    next_token: NotRequired["capo_chime_sdk_messaging.types.next_token.NextToken"]
    """<p>The token passed by previous API calls until all requested channels are returned.</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>"""

app_instance_arn instance-attribute 

app_instance_arn: ChimeArn

The ARN of the AppInstance.

chime_bearer instance-attribute 

chime_bearer: ChimeArn

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

max_results instance-attribute 

max_results: NotRequired[MaxResults]

The maximum number of channels that you want to return.

next_token instance-attribute 

next_token: NotRequired[NextToken]

The token passed by previous API calls until all requested channels are returned.

privacy instance-attribute 

privacy: NotRequired[ChannelPrivacy]

The privacy setting. PUBLIC retrieves all the public channels. PRIVATE retrieves private channels. Only an AppInstanceAdmin can retrieve private channels.