Kafka / Client / update_cluster_kafka_version

update_cluster_kafka_version#

Kafka.Client.update_cluster_kafka_version(**kwargs)#

Updates the Apache Kafka version for the cluster.

See also: AWS API Documentation

Request Syntax

response = client.update_cluster_kafka_version(
    ClusterArn='string',
    ConfigurationInfo={
        'Arn': 'string',
        'Revision': 123
    },
    CurrentVersion='string',
    TargetKafkaVersion='string'
)
Parameters:
  • ClusterArn (string) –

    [REQUIRED]

    The Amazon Resource Name (ARN) of the cluster to be updated.

  • ConfigurationInfo (dict) –

    The custom configuration that should be applied on the new version of cluster.

    • Arn (string) – [REQUIRED]

      ARN of the configuration to use.

    • Revision (integer) – [REQUIRED]

      The revision of the configuration to use.

  • CurrentVersion (string) –

    [REQUIRED]

    Current cluster version.

  • TargetKafkaVersion (string) –

    [REQUIRED]

    Target Kafka version.

Return type:

dict

Returns:

Response Syntax

{
    'ClusterArn': 'string',
    'ClusterOperationArn': 'string'
}

Response Structure

  • (dict) –

    Successful response.

    • ClusterArn (string) –

      The Amazon Resource Name (ARN) of the cluster.

    • ClusterOperationArn (string) –

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

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