# V1 Replicators replicatorArn Replication-info


## URI


`/replication/v1/replicators/replicatorArn/replication-info`

## HTTP methods


### PUT


**Operation ID:** `UpdateReplicationInfo`

Updates replication info of a replicator.


**Path parameters**  

| Name | Type | Required | Description | 
| --- |--- |--- |--- |
| replicatorArn | String | True | The Amazon Resource Name (ARN) of the replicator to be described. | 


**Responses**  

| Status code | Response model | Description | 
| --- |--- |--- |
| 200 |  UpdateReplicationInfoResponse | HTTP Status Code 200: OK. | 
| 400 | None | HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it. | 
| 401 | None | HTTP Status Code 401: Unauthorized request. The provided credentials couldn't be validated. | 
| 403 | None | HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request. | 
| 404 | None | HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it. | 
| 429 | None | HTTP Status Code 429: Limit exceeded. Resource limit reached. | 
| 500 | None | HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue. | 
| 503 | None | HTTP Status Code 503: Service Unavailable. Retrying your request in some time might resolve the issue. | 

### OPTIONS


Enable CORS by returning correct headers 


**Path parameters**  

| Name | Type | Required | Description | 
| --- |--- |--- |--- |
| replicatorArn | String | True | The Amazon Resource Name (ARN) of the replicator to be described. | 


**Responses**  

| Status code | Response model | Description | 
| --- |--- |--- |
| 200 | None | Default response for CORS method | 

## Schemas


### Request bodies


#### PUT schema
PUT

```
{
  "consumerGroupReplication": {
    "consumerGroupsToExclude": [
      "string"
    ],
    "detectAndCopyNewConsumerGroups": boolean,
    "consumerGroupsToReplicate": [
      "string"
    ],
    "synchroniseConsumerGroupOffsets": boolean
  },
  "topicReplication": {
    "copyAccessControlListsForTopics": boolean,
    "detectAndCopyNewTopics": boolean,
    "copyTopicConfigurations": boolean,
    "topicsToReplicate": [
      "string"
    ],
    "topicsToExclude": [
      "string"
    ]
  },
  "sourceKafkaClusterArn": "string",
  "targetKafkaClusterArn": "string",
  "currentVersion": "string"
}
```

### Response bodies


#### UpdateReplicationInfoResponse schema
UpdateReplicationInfoResponse

```
{
  "replicatorArn": "string",
  "replicatorState": enum
}
```

## Properties


### ConsumerGroupReplicationUpdate


Details about consumer group replication.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| consumerGroupsToExclude | Array of type stringMaxLength: 256 | True | List of regular expression patterns indicating the consumer groups that should not be replicated. | 
| consumerGroupsToReplicate | Array of type stringMaxLength: 256 | True | List of regular expression patterns indicating the consumer groups to copy. | 
| detectAndCopyNewConsumerGroups | boolean | True | Enables synchronization of consumer groups to target cluster. | 
| synchroniseConsumerGroupOffsets | boolean | True | Enables synchronization of consumer group offsets to target cluster. The translated offsets will be written to topic \$1\$1consumer\$1offsets. | 

### ReplicatorState


State of a replicator.
+ `RUNNING`
+ `CREATING`
+ `UPDATING`
+ `DELETING`
+ `FAILED`

### TopicReplicationUpdate


Details for updating the topic replication of a replicator.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| copyAccessControlListsForTopics | boolean | True | Whether to periodically configure remote topic ACLs to match their corresponding upstream topics. | 
| copyTopicConfigurations | boolean | True | Whether to periodically configure remote topics to match their corresponding upstream topics. | 
| detectAndCopyNewTopics | boolean | True | Whether to periodically check for new topics and partitions. | 
| topicsToExclude | Array of type stringMaxLength: 249 | True | List of regular expression patterns indicating the topics that should not be replicated. | 
| topicsToReplicate | Array of type stringMaxLength: 249 | True | List of regular expression patterns indicating the topics to copy. | 

### UpdateReplicationInfoRequest


Parameters for updating replication information between source and target Kafka clusters of a replicator.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| consumerGroupReplication | [ConsumerGroupReplicationUpdate](#v1-replicators-replicatorarn-replication-info-model-consumergroupreplicationupdate) | False | Updated consumer group replication information. | 
| currentVersion | string | True | Current replicator version. | 
| sourceKafkaClusterArn | string | True | The ARN of the source Kafka cluster. | 
| targetKafkaClusterArn | string | True | The ARN of the target Kafka cluster. | 
| topicReplication | [TopicReplicationUpdate](#v1-replicators-replicatorarn-replication-info-model-topicreplicationupdate) | False | Updated topic replication information. | 

### UpdateReplicationInfoResponse


Updated Replication information of a replicator.


| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| replicatorArn | string | False | The Amazon Resource Name (ARN) of the replicator. | 
| replicatorState | [ReplicatorState](#v1-replicators-replicatorarn-replication-info-model-replicatorstate) | False | State of the replicator. | 

## See also


For more information about using this API in one of the language-specific AWS SDKs and references, see the following:

### UpdateReplicationInfo

+ [AWS Command Line Interface V2](/goto/cli2/kafka-2018-11-14/UpdateReplicationInfo)
+ [AWS SDK for .NET V4](/goto/DotNetSDKV4/kafka-2018-11-14/UpdateReplicationInfo)
+ [AWS SDK for C\$1\$1](/goto/SdkForCpp/kafka-2018-11-14/UpdateReplicationInfo)
+ [AWS SDK for Go v2](/goto/SdkForGoV2/kafka-2018-11-14/UpdateReplicationInfo)
+ [AWS SDK for Java V2](/goto/SdkForJavaV2/kafka-2018-11-14/UpdateReplicationInfo)
+ [AWS SDK for JavaScript V3](/goto/SdkForJavaScriptV3/kafka-2018-11-14/UpdateReplicationInfo)
+ [AWS SDK for Kotlin](/goto/SdkForKotlin/kafka-2018-11-14/UpdateReplicationInfo)
+ [AWS SDK for PHP V3](/goto/SdkForPHPV3/kafka-2018-11-14/UpdateReplicationInfo)
+ [AWS SDK for Python](/goto/boto3/kafka-2018-11-14/UpdateReplicationInfo)
+ [AWS SDK for Ruby V3](/goto/SdkForRubyV3/kafka-2018-11-14/UpdateReplicationInfo)