Skip to content

Describe Connector Operation

kafkaconnect_describe_connector_operation R Documentation

Returns information about the specified connector's operations

Description

Returns information about the specified connector's operations.

Usage

kafkaconnect_describe_connector_operation(connectorOperationArn)

Arguments

connectorOperationArn

[required] ARN of the connector operation to be described.

Value

A list with the following syntax:

list(
  connectorArn = "string",
  connectorOperationArn = "string",
  connectorOperationState = "PENDING"|"UPDATE_IN_PROGRESS"|"UPDATE_COMPLETE"|"UPDATE_FAILED"|"ROLLBACK_IN_PROGRESS"|"ROLLBACK_FAILED"|"ROLLBACK_COMPLETE",
  connectorOperationType = "UPDATE_WORKER_SETTING"|"UPDATE_CONNECTOR_CONFIGURATION"|"ISOLATE_CONNECTOR"|"RESTORE_CONNECTOR",
  operationSteps = list(
    list(
      stepType = "INITIALIZE_UPDATE"|"FINALIZE_UPDATE"|"UPDATE_WORKER_SETTING"|"UPDATE_CONNECTOR_CONFIGURATION"|"VALIDATE_UPDATE",
      stepState = "PENDING"|"IN_PROGRESS"|"COMPLETED"|"FAILED"|"CANCELLED"
    )
  ),
  originWorkerSetting = 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
      )
    )
  ),
  originConnectorConfiguration = list(
    "string"
  ),
  targetWorkerSetting = 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
      )
    )
  ),
  targetConnectorConfiguration = list(
    "string"
  ),
  errorInfo = list(
    code = "string",
    message = "string"
  ),
  creationTime = as.POSIXct(
    "2015-01-01"
  ),
  endTime = as.POSIXct(
    "2015-01-01"
  )
)

Request syntax

svc$describe_connector_operation(
  connectorOperationArn = "string"
)