Kafka / Paginator / ListTopics

ListTopics¶

class Kafka.Paginator.ListTopics¶

paginator = client.get_paginator('list_topics')

paginate(**kwargs)¶

Creates an iterator that will paginate through responses from Kafka.Client.list_topics().

Request Syntax

response_iterator = paginator.paginate(
    ClusterArn='string',
    TopicNameFilter='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

ClusterArn (string) –
[REQUIRED]

The Amazon Resource Name (ARN) that uniquely identifies the cluster.
TopicNameFilter (string) – Returns topics starting with given name.
PaginationConfig (dict) –
A dictionary that provides parameters to control pagination.
- MaxItems (integer) –
  
  The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
- PageSize (integer) –
  
  The size of each page.
- StartingToken (string) –
  
  A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'Topics': [
        {
            'TopicArn': 'string',
            'TopicName': 'string',
            'ReplicationFactor': 123,
            'PartitionCount': 123,
            'OutOfSyncReplicaCount': 123
        },
    ],

}

Response Structure

(dict) –

200 response
- Topics (list) –
  
  List containing topics info.
  - (dict) –
    
    Includes identification info about the topic.
    - TopicArn (string) –
      
      The Amazon Resource Name (ARN) of the topic.
    - TopicName (string) –
      
      Name for a topic.
    - ReplicationFactor (integer) –
      
      Replication factor for a topic.
    - PartitionCount (integer) –
      
      Partition count for a topic.
    - OutOfSyncReplicaCount (integer) –
      
      Number of out-of-sync replicas for a topic.