--- title: "GET /v1/connectors" method: GET path: "/v1/connectors" --- # GET /v1/connectors `GET /v1/connectors` 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. ## Query parameters - `connectorNamePrefix` string - `maxResults` integer - `nextToken` string ## Response `200` Success - ListConnectorsResponse - `connectors` ConnectorSummary[] — An array of connector descriptions. - `capacity` object — The connector's compute capacity settings. - `autoScaling` object — Describes the connector's auto scaling capacity. - `maxWorkerCount` integer — The maximum number of workers allocated to the connector. - `mcuCount` integer — The number of microcontroller units (MCUs) allocated to each connector worker. The valid values are 1,2,4,8. - `minWorkerCount` integer — The minimum number of workers allocated to the connector. - `scaleInPolicy` object — The scale-in policy for the connector. - `cpuUtilizationPercentage` integer — Specifies the CPU utilization percentage threshold at which you want connector scale in to be triggered. - `scaleOutPolicy` object — The scale-out policy for the connector. - `cpuUtilizationPercentage` integer — The CPU utilization percentage threshold at which you want connector scale out to be triggered. - `maxAutoscalingTaskCount` integer — The maximum number of tasks allocated to the connector during autoscaling operations. Must be at least equal to maxWorkerCount. - `provisionedCapacity` object — Describes a connector's provisioned capacity. - `mcuCount` integer — The number of microcontroller units (MCUs) allocated to each connector worker. The valid values are 1,2,4,8. - `workerCount` integer — The number of workers that are allocated to the connector. - `connectorArn` string — The Amazon Resource Name (ARN) of the connector. - `connectorDescription` string — The description of the connector. - `connectorName` string — The name of the connector. - `connectorState` 'RUNNING' | 'CREATING' | 'UPDATING' | 'DELETING' | 'FAILED' — The state of the connector. - `creationTime` string, date-time — The time that the connector was created. - `currentVersion` string — The current version of the connector. - `kafkaCluster` object — The details of the Apache Kafka cluster to which the connector is connected. - `apacheKafkaCluster` object — The Apache Kafka cluster to which the connector is connected. - `bootstrapServers` string — The bootstrap servers of the cluster. - `vpc` object — Details of an Amazon VPC which has network connectivity to the Apache Kafka cluster. - `securityGroups` String[] — The security groups for the connector. - `subnets` String[] — The subnets for the connector. - `kafkaClusterClientAuthentication` object — The type of client authentication used to connect to the Apache Kafka cluster. The value is NONE when no client authentication is used. - `authenticationType` 'NONE' | 'IAM' — The type of client authentication used to connect to the Apache Kafka cluster. Value NONE means that no client authentication is used. - `kafkaClusterEncryptionInTransit` object — Details of encryption in transit to the Apache Kafka cluster. - `encryptionType` 'PLAINTEXT' | 'TLS' — The type of encryption in transit to the Apache Kafka cluster. - `kafkaConnectVersion` string — The version of Kafka Connect. It has to be compatible with both the Apache Kafka cluster's version and the plugins. - `logDelivery` object — The settings for delivering connector logs to Amazon CloudWatch Logs. - `workerLogDelivery` object — The workers can send worker logs to different destination types. This configuration specifies the details of these destinations. - `cloudWatchLogs` object — Details about delivering logs to Amazon CloudWatch Logs. - `enabled` boolean — Whether log delivery to Amazon CloudWatch Logs is enabled. - `logGroup` string — The name of the CloudWatch log group that is the destination for log delivery. - `firehose` object — Details about delivering logs to Amazon Kinesis Data Firehose. - `deliveryStream` string — The name of the Kinesis Data Firehose delivery stream that is the destination for log delivery. - `enabled` boolean — Specifies whether connector logs get delivered to Amazon Kinesis Data Firehose. - `s3` object — Details about delivering logs to Amazon S3. - `bucket` string — The name of the S3 bucket that is the destination for log delivery. - `enabled` boolean — Specifies whether connector logs get sent to the specified Amazon S3 destination. - `prefix` string — The S3 prefix that is the destination for log delivery. - `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. - `plugins` PluginDescription[] — Specifies which plugins were used for this connector. - `customPlugin` object — Details about a custom plugin. - `customPluginArn` string — The Amazon Resource Name (ARN) of the custom plugin. - `revision` integer — The revision of the custom plugin. - `serviceExecutionRoleArn` string — The Amazon Resource Name (ARN) of the IAM role used by the connector to access Amazon Web Services resources. - `workerConfiguration` object — The worker configurations that are in use with the connector. - `revision` integer — The revision of the worker configuration. - `workerConfigurationArn` string — The Amazon Resource Name (ARN) of the worker configuration. - `nextToken` string — 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 it left off. ## Other responses - `480` — NotFoundException - `481` — BadRequestException - `482` — ForbiddenException - `483` — ServiceUnavailableException - `484` — TooManyRequestsException - `485` — UnauthorizedException - `486` — InternalServerErrorException --- [API](https://skmtc.net/aws/apis/kafkaconnect.md) · [All operations](https://skmtc.net/aws/apis/kafkaconnect/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/kafkaconnect/versions/bf394e0acb7e/schema)