List Connectors

kafkaconnect_list_connectors

R Documentation

Returns a list of all the connectors in this account and Region

Description

Returns a list of all the connectors in this account and Region. The list is limited to connectors whose name starts with the specified prefix. The response also includes a description of each of the listed connectors.

Usage

kafkaconnect_list_connectors(connectorNamePrefix, maxResults, nextToken)

Arguments

connectorNamePrefix

The name prefix that you want to use to search for and list connectors.

maxResults

The maximum number of connectors to list in one response.

nextToken

If the response of a ListConnectors operation is truncated, it will include a NextToken. Send this NextToken in a subsequent request to continue listing from where the previous operation left off.

Value

A list with the following syntax:

list(
  connectors = list(
    list(
      capacity = list(
        autoScaling = list(
          maxWorkerCount = 123,
          mcuCount = 123,
          minWorkerCount = 123,
          scaleInPolicy = list(
            cpuUtilizationPercentage = 123
          ),
          scaleOutPolicy = list(
            cpuUtilizationPercentage = 123
          )
        ),
        provisionedCapacity = list(
          mcuCount = 123,
          workerCount = 123
        )
      ),
      connectorArn = "string",
      connectorDescription = "string",
      connectorName = "string",
      connectorState = "RUNNING"|"CREATING"|"UPDATING"|"DELETING"|"FAILED",
      creationTime = as.POSIXct(
        "2015-01-01"
      ),
      currentVersion = "string",
      kafkaCluster = list(
        apacheKafkaCluster = list(
          bootstrapServers = "string",
          vpc = list(
            securityGroups = list(
              "string"
            ),
            subnets = list(
              "string"
            )
          )
        )
      ),
      kafkaClusterClientAuthentication = list(
        authenticationType = "NONE"|"IAM"
      ),
      kafkaClusterEncryptionInTransit = list(
        encryptionType = "PLAINTEXT"|"TLS"
      ),
      kafkaConnectVersion = "string",
      logDelivery = list(
        workerLogDelivery = list(
          cloudWatchLogs = list(
            enabled = TRUE|FALSE,
            logGroup = "string"
          ),
          firehose = list(
            deliveryStream = "string",
            enabled = TRUE|FALSE
          ),
          s3 = list(
            bucket = "string",
            enabled = TRUE|FALSE,
            prefix = "string"
          )
        )
      ),
      plugins = list(
        list(
          customPlugin = list(
            customPluginArn = "string",
            revision = 123
          )
        )
      ),
      serviceExecutionRoleArn = "string",
      workerConfiguration = list(
        revision = 123,
        workerConfigurationArn = "string"
      )
    )
  ),
  nextToken = "string"
)

Request syntax

svc$list_connectors(
  connectorNamePrefix = "string",
  maxResults = 123,
  nextToken = "string"
)