Kafka / Paginator / ListReplicators

ListReplicators

class Kafka.Paginator.ListReplicators

paginator = client.get_paginator('list_replicators')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

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

Parameters:

• ReplicatorNameFilter (string) – Returns replicators 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

{
    'Replicators': [
        {
            'CreationTime': datetime(2015, 1, 1),
            'CurrentVersion': 'string',
            'IsReplicatorReference': True|False,
            'KafkaClustersSummary': [
                {
                    'AmazonMskCluster': {
                        'MskClusterArn': 'string'
                    },
                    'KafkaClusterAlias': 'string'
                },
            ],
            'ReplicationInfoSummaryList': [
                {
                    'SourceKafkaClusterAlias': 'string',
                    'TargetKafkaClusterAlias': 'string'
                },
            ],
            'ReplicatorArn': 'string',
            'ReplicatorName': 'string',
            'ReplicatorResourceArn': 'string',
            'ReplicatorState': 'RUNNING'|'CREATING'|'UPDATING'|'DELETING'|'FAILED'
        },
    ]
}

Response Structure

• (dict) – HTTP Status Code 200: OK.

  • Replicators (list) –

    List containing information of each of the replicators in the account.

    • (dict) –

      Information about a replicator.

      • CreationTime (datetime) –

        The time the replicator was created.

      • CurrentVersion (string) –

        The current version of the replicator.

      • IsReplicatorReference (boolean) –

        Whether this resource is a replicator reference.

      • KafkaClustersSummary (list) –

        Kafka Clusters used in setting up sources / targets for replication.

        • (dict) –

          Summarized information about Kafka Cluster used as source / target for replication.

          • AmazonMskCluster (dict) –

            Details of an Amazon MSK Cluster.

            • MskClusterArn (string) –

              The Amazon Resource Name (ARN) of an Amazon MSK cluster.

          • KafkaClusterAlias (string) –

            The alias of the Kafka cluster. Used to prefix names of replicated topics.

      • ReplicationInfoSummaryList (list) –

        A list of summarized information of replications between clusters.

        • (dict) –

          Summarized information of replication between clusters.

          • SourceKafkaClusterAlias (string) –

            The alias of the source Kafka cluster.

          • TargetKafkaClusterAlias (string) –

            The alias of the target Kafka cluster.

      • ReplicatorArn (string) –

        The Amazon Resource Name (ARN) of the replicator.

      • ReplicatorName (string) –

        The name of the replicator.

      • ReplicatorResourceArn (string) –

        The Amazon Resource Name (ARN) of the replicator resource in the region where the replicator was created.

      • ReplicatorState (string) –

        State of the replicator.