Kafka / Paginator / DescribeTopicPartitions

DescribeTopicPartitions

class Kafka.Paginator.DescribeTopicPartitions

paginator = client.get_paginator('describe_topic_partitions')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

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

Parameters:

• ClusterArn (string) –

  [REQUIRED]

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

• TopicName (string) –

  [REQUIRED]

  The Kafka topic name that uniquely identifies the topic.

• 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

{
    'Partitions': [
        {
            'Partition': 123,
            'Leader': 123,
            'Replicas': [
                123,
            ],
            'Isr': [
                123,
            ]
        },
    ],

}

Response Structure

• (dict) –

  200 response

  • Partitions (list) –

    The list of partition information for the topic.

    • (dict) –

      Contains information about a topic partition.

      • Partition (integer) –

        The partition ID.

      • Leader (integer) –

        The leader broker ID for the partition.

      • Replicas (list) –

        The list of replica broker IDs for the partition.

        • (integer) –

      • Isr (list) –

        The list of in-sync replica broker IDs for the partition.

        • (integer) –