Amazon Elastic Kubernetes Service

2024/12/23 - Amazon Elastic Kubernetes Service - 1 new api methods

Changes  This release adds support for DescribeClusterVersions API that provides important information about Kubernetes versions along with end of support dates

DescribeClusterVersions (new) Link ΒΆ

Lists available Kubernetes versions for Amazon EKS clusters.

See also: AWS API Documentation

Request Syntax

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

string

param clusterType:

The type of cluster to filter versions by.

type maxResults:

integer

param maxResults:

Maximum number of results to return.

type nextToken:

string

param nextToken:

Pagination token for the next set of results.

type defaultOnly:

boolean

param defaultOnly:

Filter to show only default versions.

type includeAll:

boolean

param includeAll:

Include all available versions in the response.

type clusterVersions:

list

param clusterVersions:

List of specific cluster versions to describe.

  • (string) --

type status:

string

param status:

Filter versions by their current status.

rtype:

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.