Kafka / Client / get_compatible_kafka_versions

get_compatible_kafka_versions¶

Kafka.Client.get_compatible_kafka_versions(**kwargs)¶

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

Request Syntax

response = client.get_compatible_kafka_versions(
    ClusterArn='string'
)

Parameters:

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

Return type:

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

Kafka.Client.exceptions.BadRequestException
Kafka.Client.exceptions.UnauthorizedException
Kafka.Client.exceptions.InternalServerErrorException
Kafka.Client.exceptions.ForbiddenException
Kafka.Client.exceptions.NotFoundException
Kafka.Client.exceptions.ServiceUnavailableException
Kafka.Client.exceptions.TooManyRequestsException