:doc:`EKS <../../eks>` / Client / describe_cluster_versions

*************************
describe_cluster_versions
*************************



.. py:method:: EKS.Client.describe_cluster_versions(**kwargs)

  

  Lists available Kubernetes versions for Amazon EKS clusters.

  

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


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

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

    

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

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

            
      
    
  
  **Exceptions**
  
  *   :py:class:`EKS.Client.exceptions.ServerException`

  
  *   :py:class:`EKS.Client.exceptions.InvalidParameterException`

  
  *   :py:class:`EKS.Client.exceptions.InvalidRequestException`

  