Skip to content

SearchChannelsRequest

Source code in docs_src/capo_chime_sdk_messaging/types/search_channels_request.py 
16
17
18
19
20
21
22
23
24
class SearchChannelsRequest(TypedDict, closed=True):
    chime_bearer: NotRequired["capo_chime_sdk_messaging.types.chime_arn.ChimeArn"]
    """<p>The <code>AppInstanceUserArn</code> of the user making the API call.</p>"""
    fields: "capo_chime_sdk_messaging.types.search_fields.SearchFields"
    """<p>A list of the <code>Field</code> objects in the channel being searched.</p>"""
    max_results: NotRequired["capo_chime_sdk_messaging.types.max_results.MaxResults"]
    """<p>The maximum number of channels that you want returned.</p>"""
    next_token: NotRequired["capo_chime_sdk_messaging.types.next_token.NextToken"]
    """<p>The token returned from previous API requests until the number of channels is reached.</p>"""

chime_bearer instance-attribute 

chime_bearer: NotRequired[ChimeArn]

The AppInstanceUserArn of the user making the API call.

fields instance-attribute 

fields: SearchFields

A list of the Field objects in the channel being searched.

max_results instance-attribute 

max_results: NotRequired[MaxResults]

The maximum number of channels that you want returned.

next_token instance-attribute 

next_token: NotRequired[NextToken]

The token returned from previous API requests until the number of channels is reached.