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

***********************
update_replication_info
***********************



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

  

  Updates replication info of a replicator.

  

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


  **Request Syntax**
  ::

    response = client.update_replication_info(
        ConsumerGroupReplication={
            'ConsumerGroupsToExclude': [
                'string',
            ],
            'ConsumerGroupsToReplicate': [
                'string',
            ],
            'DetectAndCopyNewConsumerGroups': True|False,
            'SynchroniseConsumerGroupOffsets': True|False
        },
        CurrentVersion='string',
        ReplicatorArn='string',
        SourceKafkaClusterArn='string',
        TargetKafkaClusterArn='string',
        TopicReplication={
            'CopyAccessControlListsForTopics': True|False,
            'CopyTopicConfigurations': True|False,
            'DetectAndCopyNewTopics': True|False,
            'TopicsToExclude': [
                'string',
            ],
            'TopicsToReplicate': [
                'string',
            ]
        }
    )
    
  :type ConsumerGroupReplication: dict
  :param ConsumerGroupReplication: 

    Updated consumer group replication information.

    

  
    - **ConsumerGroupsToExclude** *(list) --* **[REQUIRED]** 

      List of regular expression patterns indicating the consumer groups that should not be replicated.

      

    
      - *(string) --* 

      
  
    - **ConsumerGroupsToReplicate** *(list) --* **[REQUIRED]** 

      List of regular expression patterns indicating the consumer groups to copy.

      

    
      - *(string) --* 

      
  
    - **DetectAndCopyNewConsumerGroups** *(boolean) --* **[REQUIRED]** 

      Enables synchronization of consumer groups to target cluster.

      

    
    - **SynchroniseConsumerGroupOffsets** *(boolean) --* **[REQUIRED]** 

      Enables synchronization of consumer group offsets to target cluster. The translated offsets will be written to topic __consumer_offsets.

      

    
  
  :type CurrentVersion: string
  :param CurrentVersion: **[REQUIRED]** 

    Current replicator version.

    

  
  :type ReplicatorArn: string
  :param ReplicatorArn: **[REQUIRED]** 

    The Amazon Resource Name (ARN) of the replicator to be updated.

    

  
  :type SourceKafkaClusterArn: string
  :param SourceKafkaClusterArn: **[REQUIRED]** 

    The ARN of the source Kafka cluster.

    

  
  :type TargetKafkaClusterArn: string
  :param TargetKafkaClusterArn: **[REQUIRED]** 

    The ARN of the target Kafka cluster.

    

  
  :type TopicReplication: dict
  :param TopicReplication: 

    Updated topic replication information.

    

  
    - **CopyAccessControlListsForTopics** *(boolean) --* **[REQUIRED]** 

      Whether to periodically configure remote topic ACLs to match their corresponding upstream topics.

      

    
    - **CopyTopicConfigurations** *(boolean) --* **[REQUIRED]** 

      Whether to periodically configure remote topics to match their corresponding upstream topics.

      

    
    - **DetectAndCopyNewTopics** *(boolean) --* **[REQUIRED]** 

      Whether to periodically check for new topics and partitions.

      

    
    - **TopicsToExclude** *(list) --* **[REQUIRED]** 

      List of regular expression patterns indicating the topics that should not be replicated.

      

    
      - *(string) --* 

      
  
    - **TopicsToReplicate** *(list) --* **[REQUIRED]** 

      List of regular expression patterns indicating the topics to copy.

      

    
      - *(string) --* 

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

    
    ::

      {
          'ReplicatorArn': 'string',
          'ReplicatorState': 'RUNNING'|'CREATING'|'UPDATING'|'DELETING'|'FAILED'
      }
      
    **Response Structure**

    

    - *(dict) --* HTTP Status Code 200: OK.
      

      - **ReplicatorArn** *(string) --* 

        The Amazon Resource Name (ARN) of the replicator.

        
      

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

  