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

**********************
describe_custom_plugin
**********************



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

  

  A summary description of the custom plugin.

  

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


  **Request Syntax**
  ::

    response = client.describe_custom_plugin(
        customPluginArn='string'
    )
    
  :type customPluginArn: string
  :param customPluginArn: **[REQUIRED]** 

    Returns information about a custom plugin.

    

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

    
    ::

      {
          'creationTime': datetime(2015, 1, 1),
          'customPluginArn': 'string',
          'customPluginState': 'CREATING'|'CREATE_FAILED'|'ACTIVE'|'UPDATING'|'UPDATE_FAILED'|'DELETING',
          'description': 'string',
          'latestRevision': {
              'contentType': 'JAR'|'ZIP',
              'creationTime': datetime(2015, 1, 1),
              'description': 'string',
              'fileDescription': {
                  'fileMd5': 'string',
                  'fileSize': 123
              },
              'location': {
                  's3Location': {
                      'bucketArn': 'string',
                      'fileKey': 'string',
                      'objectVersion': 'string'
                  }
              },
              'revision': 123
          },
          'name': 'string',
          'stateDescription': {
              'code': 'string',
              'message': 'string'
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

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

        The time that the custom plugin was created.

        
      

      - **customPluginArn** *(string) --* 

        The Amazon Resource Name (ARN) of the custom plugin.

        
      

      - **customPluginState** *(string) --* 

        The state of the custom plugin.

        
      

      - **description** *(string) --* 

        The description of the custom plugin.

        
      

      - **latestRevision** *(dict) --* 

        The latest successfully created revision of the custom plugin. If there are no successfully created revisions, this field will be absent.

        
        

        - **contentType** *(string) --* 

          The format of the plugin file.

          
        

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

          The time that the custom plugin was created.

          
        

        - **description** *(string) --* 

          The description of the custom plugin.

          
        

        - **fileDescription** *(dict) --* 

          Details about the custom plugin file.

          
          

          - **fileMd5** *(string) --* 

            The hex-encoded MD5 checksum of the custom plugin file. You can use it to validate the file.

            
          

          - **fileSize** *(integer) --* 

            The size in bytes of the custom plugin file. You can use it to validate the file.

            
      
        

        - **location** *(dict) --* 

          Information about the location of the custom plugin.

          
          

          - **s3Location** *(dict) --* 

            The S3 bucket Amazon Resource Name (ARN), file key, and object version of the plugin file stored in Amazon S3.

            
            

            - **bucketArn** *(string) --* 

              The Amazon Resource Name (ARN) of an S3 bucket.

              
            

            - **fileKey** *(string) --* 

              The file key for an object in an S3 bucket.

              
            

            - **objectVersion** *(string) --* 

              The version of an object in an S3 bucket.

              
        
      
        

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

          The revision of the custom plugin.

          
    
      

      - **name** *(string) --* 

        The name of the custom plugin.

        
      

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

        Details about the state of a custom plugin.

        
        

        - **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`

  