Returns summary information about the connector.
Request Syntax
GET /v1/connectors/connectorArn HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- connectorArn
-
The Amazon Resource Name (ARN) of the connector that you want to describe.
Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"capacity": {
"autoScaling": {
"maxWorkerCount": number,
"mcuCount": number,
"minWorkerCount": number,
"scaleInPolicy": {
"cpuUtilizationPercentage": number
},
"scaleOutPolicy": {
"cpuUtilizationPercentage": number
}
},
"provisionedCapacity": {
"mcuCount": number,
"workerCount": number
}
},
"connectorArn": "string",
"connectorConfiguration": {
"string" : "string"
},
"connectorDescription": "string",
"connectorName": "string",
"connectorState": "string",
"creationTime": "string",
"currentVersion": "string",
"kafkaCluster": {
"apacheKafkaCluster": {
"bootstrapServers": "string",
"vpc": {
"securityGroups": [ "string" ],
"subnets": [ "string" ]
}
}
},
"kafkaClusterClientAuthentication": {
"authenticationType": "string"
},
"kafkaClusterEncryptionInTransit": {
"encryptionType": "string"
},
"kafkaConnectVersion": "string",
"logDelivery": {
"workerLogDelivery": {
"cloudWatchLogs": {
"enabled": boolean,
"logGroup": "string"
},
"firehose": {
"deliveryStream": "string",
"enabled": boolean
},
"s3": {
"bucket": "string",
"enabled": boolean,
"prefix": "string"
}
}
},
"plugins": [
{
"customPlugin": {
"customPluginArn": "string",
"revision": number
}
}
],
"serviceExecutionRoleArn": "string",
"stateDescription": {
"code": "string",
"message": "string"
},
"workerConfiguration": {
"revision": number,
"workerConfigurationArn": "string"
}
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- capacity
-
Information about the capacity of the connector, whether it is auto scaled or provisioned.
Type: CapacityDescription object
- connectorArn
-
The Amazon Resource Name (ARN) of the connector.
Type: String
- connectorConfiguration
-
A map of keys to values that represent the configuration for the connector.
Type: String to string map
- connectorDescription
-
A summary description of the connector.
Type: String
- connectorName
-
The name of the connector.
Type: String
- connectorState
-
The state of the connector.
Type: String
Valid Values:
RUNNING | CREATING | UPDATING | DELETING | FAILED - creationTime
-
The time the connector was created.
Type: Timestamp
- currentVersion
-
The current version of the connector.
Type: String
- kafkaCluster
-
The Apache Kafka cluster that the connector is connected to.
Type: KafkaClusterDescription object
- kafkaClusterClientAuthentication
-
The type of client authentication used to connect to the Apache Kafka cluster. The value is NONE when no client authentication is used.
Type: KafkaClusterClientAuthenticationDescription object
- kafkaClusterEncryptionInTransit
-
Details of encryption in transit to the Apache Kafka cluster.
Type: KafkaClusterEncryptionInTransitDescription object
- kafkaConnectVersion
-
The version of Kafka Connect. It has to be compatible with both the Apache Kafka cluster's version and the plugins.
Type: String
- logDelivery
-
Details about delivering logs to Amazon CloudWatch Logs.
Type: LogDeliveryDescription object
- plugins
-
Specifies which plugins were used for this connector.
Type: Array of PluginDescription objects
- serviceExecutionRoleArn
-
The Amazon Resource Name (ARN) of the IAM role used by the connector to access Amazon Web Services resources.
Type: String
- stateDescription
-
Details about the state of a connector.
Type: StateDescription object
- workerConfiguration
-
Specifies which worker configuration was used for the connector.
Type: WorkerConfigurationDescription object
Errors
For information about the errors that are common to all actions, see Common Errors.
- BadRequestException
-
HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it.
HTTP Status Code: 400
- ForbiddenException
-
HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request.
HTTP Status Code: 403
- InternalServerErrorException
-
HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.
HTTP Status Code: 500
- NotFoundException
-
HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it.
HTTP Status Code: 404
- ServiceUnavailableException
-
HTTP Status Code 503: Service Unavailable. Retrying your request in some time might resolve the issue.
HTTP Status Code: 503
- TooManyRequestsException
-
HTTP Status Code 429: Limit exceeded. Resource limit reached.
HTTP Status Code: 429
- UnauthorizedException
-
HTTP Status Code 401: Unauthorized request. The provided credentials couldn't be validated.
HTTP Status Code: 401
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
