EKS / Client / describe_cluster_versions

describe_cluster_versions#

EKS.Client.describe_cluster_versions(**kwargs)#

Lists available Kubernetes versions for Amazon EKS clusters.

See also: AWS API Documentation

Request Syntax

response = client.describe_cluster_versions(
    clusterType='string',
    maxResults=123,
    nextToken='string',
    defaultOnly=True|False,
    includeAll=True|False,
    clusterVersions=[
        'string',
    ],
    status='unsupported'|'standard-support'|'extended-support'
)
Parameters:

  • clusterType (string) – The type of cluster to filter versions by.

  • maxResults (integer) – Maximum number of results to return.

  • nextToken (string) – Pagination token for the next set of results.

  • defaultOnly (boolean) – Filter to show only default versions.

  • includeAll (boolean) – Include all available versions in the response.

  • clusterVersions (list) –

    List of specific cluster versions to describe.

    • (string) –

  • status (string) – Filter versions by their current status.

Return type:

dict

Returns:

Response Syntax

{
    'nextToken': 'string',
    'clusterVersions': [
        {
            'clusterVersion': 'string',
            'clusterType': 'string',
            'defaultPlatformVersion': 'string',
            'defaultVersion': True|False,
            'releaseDate': datetime(2015, 1, 1),
            'endOfStandardSupportDate': datetime(2015, 1, 1),
            'endOfExtendedSupportDate': datetime(2015, 1, 1),
            'status': 'unsupported'|'standard-support'|'extended-support',
            'kubernetesPatchVersion': 'string'
        },
    ]
}

Response Structure

  • (dict) –

    • nextToken (string) –

      Pagination token for the next set of results.

    • clusterVersions (list) –

      List of cluster version information objects.

      • (dict) –

        Contains details about a specific EKS cluster version.

        • clusterVersion (string) –

          The Kubernetes version for the cluster.

        • clusterType (string) –

          The type of cluster this version is for.

        • defaultPlatformVersion (string) –

          Default platform version for this Kubernetes version.

        • defaultVersion (boolean) –

          Indicates if this is a default version.

        • releaseDate (datetime) –

          The release date of this cluster version.

        • endOfStandardSupportDate (datetime) –

          Date when standard support ends for this version.

        • endOfExtendedSupportDate (datetime) –

          Date when extended support ends for this version.

        • status (string) –

          Current status of this cluster version.

        • kubernetesPatchVersion (string) –

          The patch version of Kubernetes for this cluster version.

Exceptions

  • EKS.Client.exceptions.ServerException

  • EKS.Client.exceptions.InvalidParameterException

  • EKS.Client.exceptions.InvalidRequestException