describe_cluster_versions ¶

def describe_cluster_versions(
    self,
    *,
    config_overrides: Optional[EKSClientConfig] = None,
    cluster_type: Optional["capo_eks.types.string.String"] = None,
    max_results: Optional[
        "capo_eks.types.describe_cluster_version_max_results.DescribeClusterVersionMaxResults"
    ] = None,
    next_token: Optional["capo_eks.types.string.String"] = None,
    default_only: Optional["capo_eks.types.boxed_boolean.BoxedBoolean"] = None,
    include_all: Optional["capo_eks.types.boxed_boolean.BoxedBoolean"] = None,
    cluster_versions: Optional["capo_eks.types.string_list.StringList"] = None,
    status: Optional[
        "capo_eks.types.cluster_version_status.ClusterVersionStatus"
    ] = None,
    version_status: Optional["capo_eks.types.version_status.VersionStatus"] = None,
) -> "capo_eks.types.describe_cluster_versions_response.DescribeClusterVersionsResponse":
    """<p>Lists available Kubernetes versions for Amazon EKS clusters.</p>

    Args:
        cluster_type: <p>The type of cluster to filter versions by.</p>
        max_results: <p>Maximum number of results to return.</p>
        next_token: <p>Pagination token for the next set of results.</p>
        default_only: <p>Filter to show only default versions.</p>
        include_all: <p>Include all available versions in the response.</p>
        cluster_versions: <p>List of specific cluster versions to describe.</p>
        status: <important> <p>This field is deprecated. Use <code>versionStatus</code> instead, as that field matches for input and output of this action.</p> </important> <p>Filter versions by their current status.</p>
        version_status: <p>Filter versions by their current status.</p>

    Raises:
        capo_eks.errors.invalid_parameter_exception.InvalidParameterException: <p>The specified parameter is invalid. Review the available parameters for the API request.</p>
        capo_eks.errors.invalid_request_exception.InvalidRequestException: <p>The request is invalid given the state of the cluster. Check the state of the cluster and the associated operations.</p>
        capo_eks.errors.server_exception.ServerException: <p>These errors are usually caused by a server-side issue.</p>
        capo_eks.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_eks.types.describe_cluster_versions_request.DescribeClusterVersionsRequest]",
    ) -> OperationResponse[
        "capo_eks.types.describe_cluster_versions_response.DescribeClusterVersionsResponse"
    ]:
        import capo_eks._operations.aws_wesley_frontend.describe_cluster_versions

        output, http_response = (
            capo_eks._operations.aws_wesley_frontend.describe_cluster_versions.describe_cluster_versions(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeClusterVersions")
    )
    input_: capo_eks.types.describe_cluster_versions_request.DescribeClusterVersionsRequest = {}
    if cluster_type is not None:
        input_["cluster_type"] = cluster_type
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token
    if default_only is not None:
        input_["default_only"] = default_only
    if include_all is not None:
        input_["include_all"] = include_all
    if cluster_versions is not None:
        input_["cluster_versions"] = cluster_versions
    if status is not None:
        input_["status"] = status
    if version_status is not None:
        input_["version_status"] = version_status

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