:doc:`Kafka <../../kafka>` / Client / get_compatible_kafka_versions

*****************************
get_compatible_kafka_versions
*****************************



.. py:method:: Kafka.Client.get_compatible_kafka_versions(**kwargs)

  

  Gets the Apache Kafka versions to which you can update the MSK cluster.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/kafka-2018-11-14/GetCompatibleKafkaVersions>`_  


  **Request Syntax**
  ::

    response = client.get_compatible_kafka_versions(
        ClusterArn='string'
    )
    
  :type ClusterArn: string
  :param ClusterArn: 

    The Amazon Resource Name (ARN) of the cluster check.

    

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

    
    ::

      {
          'CompatibleKafkaVersions': [
              {
                  'SourceVersion': 'string',
                  'TargetVersions': [
                      'string',
                  ]
              },
          ]
      }
      
    **Response Structure**

    

    - *(dict) --* 

      Successful response.

      
      

      - **CompatibleKafkaVersions** *(list) --* 

        A list of CompatibleKafkaVersion objects.

        
        

        - *(dict) --* 

          Contains source Apache Kafka versions and compatible target Apache Kafka versions.

          
          

          - **SourceVersion** *(string) --* 

            An Apache Kafka version.

            
          

          - **TargetVersions** *(list) --* 

            A list of Apache Kafka versions.

            
            

            - *(string) --* 
        
      
    
  
  **Exceptions**
  
  *   :py:class:`Kafka.Client.exceptions.BadRequestException`

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

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

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

  
  *   :py:class:`Kafka.Client.exceptions.NotFoundException`

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

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

  