:doc:`KafkaConnect <../../kafkaconnect>` / Client / describe_connector

******************
describe_connector
******************



.. py:method:: KafkaConnect.Client.describe_connector(**kwargs)

  

  Returns summary information about the connector.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/kafkaconnect-2021-09-14/DescribeConnector>`_  


  **Request Syntax**
  ::

    response = client.describe_connector(
        connectorArn='string'
    )
    
  :type connectorArn: string
  :param connectorArn: **[REQUIRED]** 

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

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'capacity': {
              'autoScaling': {
                  'maxWorkerCount': 123,
                  'mcuCount': 123,
                  'minWorkerCount': 123,
                  'scaleInPolicy': {
                      'cpuUtilizationPercentage': 123
                  },
                  'scaleOutPolicy': {
                      'cpuUtilizationPercentage': 123
                  },
                  'maxAutoscalingTaskCount': 123
              },
              'provisionedCapacity': {
                  'mcuCount': 123,
                  'workerCount': 123
              }
          },
          'connectorArn': 'string',
          'connectorConfiguration': {
              'string': 'string'
          },
          'connectorDescription': 'string',
          'connectorName': 'string',
          'connectorState': 'RUNNING'|'CREATING'|'UPDATING'|'DELETING'|'FAILED',
          'creationTime': datetime(2015, 1, 1),
          'currentVersion': 'string',
          'kafkaCluster': {
              'apacheKafkaCluster': {
                  'bootstrapServers': 'string',
                  'vpc': {
                      'securityGroups': [
                          'string',
                      ],
                      'subnets': [
                          'string',
                      ]
                  }
              }
          },
          'kafkaClusterClientAuthentication': {
              'authenticationType': 'NONE'|'IAM'
          },
          'kafkaClusterEncryptionInTransit': {
              'encryptionType': 'PLAINTEXT'|'TLS'
          },
          'kafkaConnectVersion': 'string',
          'logDelivery': {
              'workerLogDelivery': {
                  'cloudWatchLogs': {
                      'enabled': True|False,
                      'logGroup': 'string'
                  },
                  'firehose': {
                      'deliveryStream': 'string',
                      'enabled': True|False
                  },
                  's3': {
                      'bucket': 'string',
                      'enabled': True|False,
                      'prefix': 'string'
                  }
              }
          },
          'networkType': 'IPV4'|'DUAL',
          'plugins': [
              {
                  'customPlugin': {
                      'customPluginArn': 'string',
                      'revision': 123
                  }
              },
          ],
          'serviceExecutionRoleArn': 'string',
          'workerConfiguration': {
              'revision': 123,
              'workerConfigurationArn': 'string'
          },
          'stateDescription': {
              'code': 'string',
              'message': 'string'
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **capacity** *(dict) --* 

        Information about the capacity of the connector, whether it is auto scaled or provisioned.

        
        

        - **autoScaling** *(dict) --* 

          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** *(dict) --* 

            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** *(dict) --* 

            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** *(dict) --* 

          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.

        
      

      - **connectorConfiguration** *(dict) --* 

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

        
        

        - *(string) --* 
          

          - *(string) --* 
    
  
      

      - **connectorDescription** *(string) --* 

        A summary description of the connector.

        
      

      - **connectorName** *(string) --* 

        The name of the connector.

        
      

      - **connectorState** *(string) --* 

        The state of the connector.

        
      

      - **creationTime** *(datetime) --* 

        The time the connector was created.

        
      

      - **currentVersion** *(string) --* 

        The current version of the connector.

        
      

      - **kafkaCluster** *(dict) --* 

        The Apache Kafka cluster that the connector is connected to.

        
        

        - **apacheKafkaCluster** *(dict) --* 

          The Apache Kafka cluster to which the connector is connected.

          
          

          - **bootstrapServers** *(string) --* 

            The bootstrap servers of the cluster.

            
          

          - **vpc** *(dict) --* 

            Details of an Amazon VPC which has network connectivity to the Apache Kafka cluster.

            
            

            - **securityGroups** *(list) --* 

              The security groups for the connector.

              
              

              - *(string) --* 
          
            

            - **subnets** *(list) --* 

              The subnets for the connector.

              
              

              - *(string) --* 
          
        
      
    
      

      - **kafkaClusterClientAuthentication** *(dict) --* 

        The type of client authentication used to connect to the Apache Kafka cluster. The value is NONE when no client authentication is used.

        
        

        - **authenticationType** *(string) --* 

          The type of client authentication used to connect to the Apache Kafka cluster. Value NONE means that no client authentication is used.

          
    
      

      - **kafkaClusterEncryptionInTransit** *(dict) --* 

        Details of encryption in transit to the Apache Kafka cluster.

        
        

        - **encryptionType** *(string) --* 

          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** *(dict) --* 

        Details about delivering logs to Amazon CloudWatch Logs.

        
        

        - **workerLogDelivery** *(dict) --* 

          The workers can send worker logs to different destination types. This configuration specifies the details of these destinations.

          
          

          - **cloudWatchLogs** *(dict) --* 

            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** *(dict) --* 

            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** *(dict) --* 

            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** *(string) --* 

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

        
      

      - **plugins** *(list) --* 

        Specifies which plugins were used for this connector.

        
        

        - *(dict) --* 

          The description of the plugin.

          
          

          - **customPlugin** *(dict) --* 

            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** *(dict) --* 

        Specifies which worker configuration was used for the connector.

        
        

        - **revision** *(integer) --* 

          The revision of the worker configuration.

          
        

        - **workerConfigurationArn** *(string) --* 

          The Amazon Resource Name (ARN) of the worker configuration.

          
    
      

      - **stateDescription** *(dict) --* 

        Details about the state of a connector.

        
        

        - **code** *(string) --* 

          A code that describes the state of a resource.

          
        

        - **message** *(string) --* 

          A message that describes the state of a resource.

          
    
  
  **Exceptions**
  
  *   :py:class:`KafkaConnect.Client.exceptions.NotFoundException`

  
  *   :py:class:`KafkaConnect.Client.exceptions.BadRequestException`

  
  *   :py:class:`KafkaConnect.Client.exceptions.ForbiddenException`

  
  *   :py:class:`KafkaConnect.Client.exceptions.ServiceUnavailableException`

  
  *   :py:class:`KafkaConnect.Client.exceptions.TooManyRequestsException`

  
  *   :py:class:`KafkaConnect.Client.exceptions.UnauthorizedException`

  
  *   :py:class:`KafkaConnect.Client.exceptions.InternalServerErrorException`

  