Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-141813797.1 KB

Returns summary information about the connector.

get/v1/connectors/{connectorArn}

Path parameters

connectorArnstring required

The Amazon Resource Name (ARN) of the connector that you want to describe.

Response

Success

connectorArnstring

The Amazon Resource Name (ARN) of the connector.

connectorConfigurationobject

A map of keys to values that represent the configuration for the connector.

connectorDescriptionstring

A summary description of the connector.

connectorNamestring

The name of the connector.

connectorState'RUNNING' | 'CREATING' | 'UPDATING' | 'DELETING' | 'FAILED'

The state of the connector.

creationTimestring date-time

The time the connector was created.

currentVersionstring

The current version of the connector.

kafkaConnectVersionstring

The version of Kafka Connect. It has to be compatible with both the Apache Kafka cluster's version and the plugins.

networkType'IPV4' | 'DUAL'

The network type of the connector. It gives connectors connectivity to either IPv4 (IPV4) or IPv4 and IPv6 (DUAL) destinations. Defaults to IPV4.

serviceExecutionRoleArnstring

The Amazon Resource Name (ARN) of the IAM role used by the connector to access Amazon Web Services resources.