Skip to content

List Replicators

kafka_list_replicators R Documentation

Lists the replicators

Description

Lists the replicators.

Usage

kafka_list_replicators(MaxResults, NextToken, ReplicatorNameFilter)

Arguments

MaxResults

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

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.

ReplicatorNameFilter

Returns replicators starting with given name.

Value

A list with the following syntax:

list(
  NextToken = "string",
  Replicators = list(
    list(
      CreationTime = as.POSIXct(
        "2015-01-01"
      ),
      CurrentVersion = "string",
      IsReplicatorReference = TRUE|FALSE,
      KafkaClustersSummary = list(
        list(
          AmazonMskCluster = list(
            MskClusterArn = "string"
          ),
          KafkaClusterAlias = "string"
        )
      ),
      ReplicationInfoSummaryList = list(
        list(
          SourceKafkaClusterAlias = "string",
          TargetKafkaClusterAlias = "string"
        )
      ),
      ReplicatorArn = "string",
      ReplicatorName = "string",
      ReplicatorResourceArn = "string",
      ReplicatorState = "RUNNING"|"CREATING"|"UPDATING"|"DELETING"|"FAILED"
    )
  )
)

Request syntax

svc$list_replicators(
  MaxResults = 123,
  NextToken = "string",
  ReplicatorNameFilter = "string"
)