Skip to content

ListChannelsRequest

Source code in docs_src/capo_kafka/types/list_channels_request.py 
12
13
14
15
16
17
18
19
20
class ListChannelsRequest(TypedDict, closed=True):
    cluster_arn: "capo_kafka.types.__string.__string"
    """<p>The Amazon Resource Name (ARN) that uniquely identifies the cluster.</p>"""
    max_results: NotRequired["capo_kafka.types.max_results.MaxResults"]
    """<p>Maximum number of channels to return in a single response.</p>"""
    next_token: NotRequired["capo_kafka.types.__string.__string"]
    """<p>If the response of ListChannels is truncated, it returns a nextToken in the response. This nextToken should be sent in the subsequent request to ListChannels.</p>"""
    topic_name_filter: NotRequired["capo_kafka.types.__string.__string"]
    """<p>Filters results to channels whose topic name matches the specified value.</p>"""

cluster_arn instance-attribute 

cluster_arn: __string

The Amazon Resource Name (ARN) that uniquely identifies the cluster.

max_results instance-attribute 

max_results: NotRequired[MaxResults]

Maximum number of channels to return in a single response.

next_token instance-attribute 

next_token: NotRequired[__string]

If the response of ListChannels is truncated, it returns a nextToken in the response. This nextToken should be sent in the subsequent request to ListChannels.

topic_name_filter instance-attribute 

topic_name_filter: NotRequired[__string]

Filters results to channels whose topic name matches the specified value.