Skip to content

get_compatible_kafka_versions

get_compatible_kafka_versions(
    *,
    config_overrides: Optional[KafkaClientConfig] = None,
    cluster_arn: Optional[__string] = None,
) -> GetCompatibleKafkaVersionsResponse

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

Parameters:

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

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

Raises:

Source code in docs_src/capo_kafka/_services/kafka.py
def get_compatible_kafka_versions(
    self,
    *,
    config_overrides: Optional[KafkaClientConfig] = None,
    cluster_arn: Optional["capo_kafka.types.__string.__string"] = None,
) -> "capo_kafka.types.get_compatible_kafka_versions_response.GetCompatibleKafkaVersionsResponse":
    """<p>Gets the Apache Kafka versions to which you can update the MSK cluster.</p>

    Args:
        cluster_arn: <p>The Amazon Resource Name (ARN) of the cluster check.</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.
    """

    def _handler(
        req: "OperationRequest[capo_kafka.types.get_compatible_kafka_versions_request.GetCompatibleKafkaVersionsRequest]",
    ) -> OperationResponse[
        "capo_kafka.types.get_compatible_kafka_versions_response.GetCompatibleKafkaVersionsResponse"
    ]:
        import capo_kafka._operations.kafka.get_compatible_kafka_versions

        output, http_response = (
            capo_kafka._operations.kafka.get_compatible_kafka_versions.get_compatible_kafka_versions(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetCompatibleKafkaVersions")
    )
    input_: capo_kafka.types.get_compatible_kafka_versions_request.GetCompatibleKafkaVersionsRequest = {}
    if cluster_arn is not None:
        input_["cluster_arn"] = cluster_arn

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output