EKS / Paginator / DescribeClusterVersions

DescribeClusterVersions#

class EKS.Paginator.DescribeClusterVersions#
paginator = client.get_paginator('describe_cluster_versions')
paginate(**kwargs)#

Creates an iterator that will paginate through responses from EKS.Client.describe_cluster_versions().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    clusterType='string',
    defaultOnly=True|False,
    includeAll=True|False,
    clusterVersions=[
        'string',
    ],
    status='unsupported'|'standard-support'|'extended-support',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters:

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

  • 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.

  • PaginationConfig (dict) –

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) –

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) –

      The size of each page.

    • StartingToken (string) –

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    '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'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • 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.

    • NextToken (string) –

      A token to resume pagination.