Skip to content

ListClustersRequest

Source code in docs_src/capo_kafka/types/list_clusters_request.py 
12
13
14
15
16
17
18
class ListClustersRequest(TypedDict, closed=True):
    cluster_name_filter: NotRequired["capo_kafka.types.__string.__string"]
    """<p>Specify a prefix of the name of the clusters that you want to list. The service lists all the clusters whose names start with this prefix.</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>"""

cluster_name_filter instance-attribute 

cluster_name_filter: NotRequired[__string]

Specify a prefix of the name of the clusters that you want to list. The service lists all the clusters whose names start with this prefix.

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.