Skip to content

update_cluster_kafka_version async

update_cluster_kafka_version(
    cluster_arn: __string,
    *,
    config_overrides: Optional[AsyncKafkaClientConfig] = None,
    configuration_info: Optional[ConfigurationInfo] = None,
    current_version: Optional[__string] = None,
    target_kafka_version: Optional[__string] = None,
) -> UpdateClusterKafkaVersionResponse

Updates the Apache Kafka version for the cluster.

Parameters:

  • cluster_arn (__string) –

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

  • configuration_info (Optional[ConfigurationInfo], default: None ) –

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

  • current_version (Optional[__string], default: None ) –

    Current cluster version.

  • target_kafka_version (Optional[__string], default: None ) –

    Target Kafka version.

Raises:

Source code in docs_src/capo_kafka/_services/async_kafka.py
async def update_cluster_kafka_version(
    self,
    cluster_arn: "capo_kafka.types.__string.__string",
    *,
    config_overrides: Optional[AsyncKafkaClientConfig] = None,
    configuration_info: Optional[
        "capo_kafka.types.configuration_info.ConfigurationInfo"
    ] = None,
    current_version: Optional["capo_kafka.types.__string.__string"] = None,
    target_kafka_version: Optional["capo_kafka.types.__string.__string"] = None,
) -> "capo_kafka.types.update_cluster_kafka_version_response.UpdateClusterKafkaVersionResponse":
    """<p>Updates the Apache Kafka version for the cluster.</p>

    Args:
        cluster_arn: <p>The Amazon Resource Name (ARN) of the cluster to be updated.</p>
        configuration_info: <p>The custom configuration that should be applied on the new version of cluster.</p>
        current_version: <p>Current cluster version.</p>
        target_kafka_version: <p>Target Kafka version.</p>

    Raises:
        capo_kafka.errors.bad_request_exception.BadRequestException: <p>Returns information about an error.</p>
        capo_kafka.errors.forbidden_exception.ForbiddenException: <p>Returns information about an error.</p>
        capo_kafka.errors.internal_server_error_exception.InternalServerErrorException: <p>Returns information about an error.</p>
        capo_kafka.errors.not_found_exception.NotFoundException: <p>Returns information about an error.</p>
        capo_kafka.errors.service_unavailable_exception.ServiceUnavailableException: <p>Returns information about an error.</p>
        capo_kafka.errors.too_many_requests_exception.TooManyRequestsException: <p>Returns information about an error.</p>
        capo_kafka.errors.unauthorized_exception.UnauthorizedException: <p>Returns information about an error.</p>
        capo_kafka.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_kafka.types.update_cluster_kafka_version_request.UpdateClusterKafkaVersionRequest]",
    ) -> AsyncOperationResponse[
        "capo_kafka.types.update_cluster_kafka_version_response.UpdateClusterKafkaVersionResponse"
    ]:
        import capo_kafka._operations.kafka.update_cluster_kafka_version

        (
            output,
            http_response,
        ) = await capo_kafka._operations.kafka.update_cluster_kafka_version.async_update_cluster_kafka_version(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateClusterKafkaVersion")
    )
    input_: capo_kafka.types.update_cluster_kafka_version_request.UpdateClusterKafkaVersionRequest = {
        "cluster_arn": cluster_arn
    }
    if configuration_info is not None:
        input_["configuration_info"] = configuration_info
    if current_version is not None:
        input_["current_version"] = current_version
    if target_kafka_version is not None:
        input_["target_kafka_version"] = target_kafka_version

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output