:doc:`Kafka <../../kafka>` / Client / list_replicators

****************
list_replicators
****************



.. py:method:: Kafka.Client.list_replicators(**kwargs)

  

  Lists the replicators.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/kafka-2018-11-14/ListReplicators>`_  


  **Request Syntax**
  ::

    response = client.list_replicators(
        MaxResults=123,
        NextToken='string',
        ReplicatorNameFilter='string'
    )
    
  :type MaxResults: integer
  :param MaxResults: 

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

    

  
  :type NextToken: string
  :param NextToken: 

    If the response of ListReplicators is truncated, it returns a NextToken in the response. This NextToken should be sent in the subsequent request to ListReplicators.

    

  
  :type ReplicatorNameFilter: string
  :param ReplicatorNameFilter: 

    Returns replicators starting with given name.

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'NextToken': 'string',
          '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.
      

      - **NextToken** *(string) --* 

        If the response of ListReplicators is truncated, it returns a NextToken in the response. This NextToken should be sent in the subsequent request to ListReplicators.

        
      

      - **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.

            
      
    
  
  **Exceptions**
  
  *   :py:class:`Kafka.Client.exceptions.BadRequestException`

  
  *   :py:class:`Kafka.Client.exceptions.UnauthorizedException`

  
  *   :py:class:`Kafka.Client.exceptions.InternalServerErrorException`

  
  *   :py:class:`Kafka.Client.exceptions.ForbiddenException`

  
  *   :py:class:`Kafka.Client.exceptions.NotFoundException`

  
  *   :py:class:`Kafka.Client.exceptions.ServiceUnavailableException`

  
  *   :py:class:`Kafka.Client.exceptions.TooManyRequestsException`

  