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

***********************
describe_addon_versions
***********************



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

  

  Describes the versions for an add-on.

   

  Information such as the Kubernetes versions that you can use the add-on with, the ``owner``, ``publisher``, and the ``type`` of the add-on are returned.

  

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


  **Request Syntax**
  ::

    response = client.describe_addon_versions(
        kubernetesVersion='string',
        maxResults=123,
        nextToken='string',
        addonName='string',
        types=[
            'string',
        ],
        publishers=[
            'string',
        ],
        owners=[
            'string',
        ]
    )
    
  :type kubernetesVersion: string
  :param kubernetesVersion: 

    The Kubernetes versions that you can use the add-on with.

    

  
  :type maxResults: integer
  :param maxResults: 

    The maximum number of results, returned in paginated output. You receive ``maxResults`` in a single page, along with a ``nextToken`` response element. You can see the remaining results of the initial request by sending another request with the returned ``nextToken`` value. This value can be between 1 and 100. If you don't use this parameter, 100 results and a ``nextToken`` value, if applicable, are returned.

    

  
  :type nextToken: string
  :param nextToken: 

    The ``nextToken`` value returned from a previous paginated request, where ``maxResults`` was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the ``nextToken`` value. This value is null when there are no more results to return.

     

    .. note::

      

      This token should be treated as an opaque identifier that is used only to retrieve the next items in a list and not for other programmatic purposes.

      

    

  
  :type addonName: string
  :param addonName: 

    The name of the add-on. The name must match one of the names returned by `ListAddons <https://docs.aws.amazon.com/eks/latest/APIReference/API_ListAddons.html>`__.

    

  
  :type types: list
  :param types: 

    The type of the add-on. For valid ``types``, don't specify a value for this property.

    

  
    - *(string) --* 

    

  :type publishers: list
  :param publishers: 

    The publisher of the add-on. For valid ``publishers``, don't specify a value for this property.

    

  
    - *(string) --* 

    

  :type owners: list
  :param owners: 

    The owner of the add-on. For valid ``owners``, don't specify a value for this property.

    

  
    - *(string) --* 

    

  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'addons': [
              {
                  'addonName': 'string',
                  'type': 'string',
                  'addonVersions': [
                      {
                          'addonVersion': 'string',
                          'architecture': [
                              'string',
                          ],
                          'computeTypes': [
                              'string',
                          ],
                          'compatibilities': [
                              {
                                  'clusterVersion': 'string',
                                  'platformVersions': [
                                      'string',
                                  ],
                                  'defaultVersion': True|False
                              },
                          ],
                          'requiresConfiguration': True|False,
                          'requiresIamPermissions': True|False
                      },
                  ],
                  'publisher': 'string',
                  'owner': 'string',
                  'marketplaceInformation': {
                      'productId': 'string',
                      'productUrl': 'string'
                  },
                  'defaultNamespace': 'string'
              },
          ],
          'nextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **addons** *(list) --* 

        The list of available versions with Kubernetes version compatibility and other properties.

        
        

        - *(dict) --* 

          Information about an add-on.

          
          

          - **addonName** *(string) --* 

            The name of the add-on.

            
          

          - **type** *(string) --* 

            The type of the add-on.

            
          

          - **addonVersions** *(list) --* 

            An object representing information about available add-on versions and compatible Kubernetes versions.

            
            

            - *(dict) --* 

              Information about an add-on version.

              
              

              - **addonVersion** *(string) --* 

                The version of the add-on.

                
              

              - **architecture** *(list) --* 

                The architectures that the version supports.

                
                

                - *(string) --* 
            
              

              - **computeTypes** *(list) --* 

                Indicates the compute type of the add-on version.

                
                

                - *(string) --* 
            
              

              - **compatibilities** *(list) --* 

                An object representing the compatibilities of a version.

                
                

                - *(dict) --* 

                  Compatibility information.

                  
                  

                  - **clusterVersion** *(string) --* 

                    The supported Kubernetes version of the cluster.

                    
                  

                  - **platformVersions** *(list) --* 

                    The supported compute platform.

                    
                    

                    - *(string) --* 
                
                  

                  - **defaultVersion** *(boolean) --* 

                    The supported default version.

                    
              
            
              

              - **requiresConfiguration** *(boolean) --* 

                Whether the add-on requires configuration.

                
              

              - **requiresIamPermissions** *(boolean) --* 

                Indicates if the add-on requires IAM Permissions to operate, such as networking permissions.

                
          
        
          

          - **publisher** *(string) --* 

            The publisher of the add-on.

            
          

          - **owner** *(string) --* 

            The owner of the add-on.

            
          

          - **marketplaceInformation** *(dict) --* 

            Information about the add-on from the Amazon Web Services Marketplace.

            
            

            - **productId** *(string) --* 

              The product ID from the Amazon Web Services Marketplace.

              
            

            - **productUrl** *(string) --* 

              The product URL from the Amazon Web Services Marketplace.

              
        
          

          - **defaultNamespace** *(string) --* 

            The default Kubernetes namespace where this addon is typically installed if no custom namespace is specified.

            
      
    
      

      - **nextToken** *(string) --* 

        The ``nextToken`` value to include in a future ``DescribeAddonVersions`` request. When the results of a ``DescribeAddonVersions`` request exceed ``maxResults``, you can use this value to retrieve the next page of results. This value is ``null`` when there are no more results to return.

         

        .. note::

          

          This token should be treated as an opaque identifier that is used only to retrieve the next items in a list and not for other programmatic purposes.

          

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

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

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

  