:doc:`ElastiCache <../../elasticache>` / Paginator / DescribeCacheEngineVersions

***************************
DescribeCacheEngineVersions
***************************



.. py:class:: ElastiCache.Paginator.DescribeCacheEngineVersions

  ::

    
    paginator = client.get_paginator('describe_cache_engine_versions')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`ElastiCache.Client.describe_cache_engine_versions`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/elasticache-2015-02-02/DescribeCacheEngineVersions>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          Engine='string',
          EngineVersion='string',
          CacheParameterGroupFamily='string',
          DefaultOnly=True|False,
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type Engine: string
    :param Engine: 

      The cache engine to return. Valid values: ``memcached`` | ``redis``

      

    
    :type EngineVersion: string
    :param EngineVersion: 

      The cache engine version to return.

       

      Example: ``1.4.14``

      

    
    :type CacheParameterGroupFamily: string
    :param CacheParameterGroupFamily: 

      The name of a specific cache parameter group family to return details for.

       

      Valid values are: ``memcached1.4`` | ``memcached1.5`` | ``memcached1.6`` | ``redis2.6`` | ``redis2.8`` | ``redis3.2`` | ``redis4.0`` | ``redis5.0`` | ``redis6.x`` | ``redis6.2`` | ``redis7`` | ``valkey7``

       

      Constraints:

       

      
      * Must be 1 to 255 alphanumeric characters
       
      * First character must be a letter
       
      * Cannot end with a hyphen or contain two consecutive hyphens
      

      

    
    :type DefaultOnly: boolean
    :param DefaultOnly: 

      If ``true``, specifies that only the default version of the specified engine or engine and major version combination is to be returned.

      

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

      
      ::

        {
            'CacheEngineVersions': [
                {
                    'Engine': 'string',
                    'EngineVersion': 'string',
                    'CacheParameterGroupFamily': 'string',
                    'CacheEngineDescription': 'string',
                    'CacheEngineVersionDescription': 'string'
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 

        Represents the output of a  DescribeCacheEngineVersions operation.

        
        

        - **CacheEngineVersions** *(list) --* 

          A list of cache engine version details. Each element in the list contains detailed information about one cache engine version.

          
          

          - *(dict) --* 

            Provides all of the details about a particular cache engine version.

            
            

            - **Engine** *(string) --* 

              The name of the cache engine.

              
            

            - **EngineVersion** *(string) --* 

              The version number of the cache engine.

              
            

            - **CacheParameterGroupFamily** *(string) --* 

              The name of the cache parameter group family associated with this cache engine.

               

              Valid values are: ``memcached1.4`` | ``memcached1.5`` | ``memcached1.6`` | ``redis2.6`` | ``redis2.8`` | ``redis3.2`` | ``redis4.0`` | ``redis5.0`` | ``redis6.x`` | ``redis7``

              
            

            - **CacheEngineDescription** *(string) --* 

              The description of the cache engine.

              
            

            - **CacheEngineVersionDescription** *(string) --* 

              The description of the cache engine version.

              
        
      
        

        - **NextToken** *(string) --* 

          A token to resume pagination.

          
    