:doc:`EKS <../../eks>` / Paginator / DescribeClusterVersions

***********************
DescribeClusterVersions
***********************



.. py:class:: EKS.Paginator.DescribeClusterVersions

  ::

    
    paginator = client.get_paginator('describe_cluster_versions')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`EKS.Client.describe_cluster_versions`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/eks-2017-11-01/DescribeClusterVersions>`_    


    **Request Syntax**
    ::

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

      The type of cluster to filter versions by.

      

    
    :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: 

      .. warning::

        

        This field is deprecated. Use ``versionStatus`` instead, as that field matches for input and output of this action.

         

       

      Filter versions by their current status.

      

    
    :type versionStatus: string
    :param versionStatus: 

      Filter versions by their current status.

      

    
    :type PaginationConfig: dict
    :param PaginationConfig: 

      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.

        

      
    
    
    :rtype: 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',
                    'versionStatus': '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) --* 

              .. warning::

                

                This field is deprecated. Use ``versionStatus`` instead, as that field matches for input and output of this action.

                 

               

              Current status of this cluster version.

              
            

            - **versionStatus** *(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.

          
    