Skip to content

ListTopicsRequest

Source code in docs_src/capo_kafka/types/list_topics_request.py 
12
13
14
15
16
17
18
19
20
class ListTopicsRequest(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>The maximum number of results to return in the response. If there are more results, the response includes a NextToken parameter.</p>"""
    next_token: NotRequired["capo_kafka.types.__string.__string"]
    """<p>The paginated results marker. When the result of the operation is truncated, the call returns NextToken in the response. To get the next batch, provide this token in your next request.</p>"""
    topic_name_filter: NotRequired["capo_kafka.types.__string.__string"]
    """<p>Returns topics starting with given name.</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]

The maximum number of results to return in the response. If there are more results, the response includes a NextToken parameter.

next_token instance-attribute 

next_token: NotRequired[__string]

The paginated results marker. When the result of the operation is truncated, the call returns NextToken in the response. To get the next batch, provide this token in your next request.

topic_name_filter instance-attribute 

topic_name_filter: NotRequired[__string]

Returns topics starting with given name.