:doc:`MemoryDB <../../memorydb>` / Client / describe_engine_versions

************************
describe_engine_versions
************************



.. py:method:: MemoryDB.Client.describe_engine_versions(**kwargs)

  

  Returns a list of the available Redis OSS engine versions.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/DescribeEngineVersions>`_  


  **Request Syntax**
  ::

    response = client.describe_engine_versions(
        Engine='string',
        EngineVersion='string',
        ParameterGroupFamily='string',
        MaxResults=123,
        NextToken='string',
        DefaultOnly=True|False
    )
    
  :type Engine: string
  :param Engine: 

    The name of the engine for which to list available versions.

    

  
  :type EngineVersion: string
  :param EngineVersion: 

    The Redis OSS engine version

    

  
  :type ParameterGroupFamily: string
  :param ParameterGroupFamily: 

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

    

  
  :type MaxResults: integer
  :param MaxResults: 

    The maximum number of records to include in the response. If more records exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

    

  
  :type NextToken: string
  :param NextToken: 

    An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

    

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

    

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

    
    ::

      {
          'NextToken': 'string',
          'EngineVersions': [
              {
                  'Engine': 'string',
                  'EngineVersion': 'string',
                  'EnginePatchVersion': 'string',
                  'ParameterGroupFamily': 'string'
              },
          ]
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

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

        An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

        
      

      - **EngineVersions** *(list) --* 

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

        
        

        - *(dict) --* 

          Provides details of the Redis OSS engine version

          
          

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

            The name of the engine for which version information is provided.

            
          

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

            The engine version

            
          

          - **EnginePatchVersion** *(string) --* 

            The patched engine version

            
          

          - **ParameterGroupFamily** *(string) --* 

            Specifies the name of the parameter group family to which the engine default parameters apply.

            
      
    
  
  **Exceptions**
  
  *   :py:class:`MemoryDB.Client.exceptions.ServiceLinkedRoleNotFoundFault`

  
  *   :py:class:`MemoryDB.Client.exceptions.InvalidParameterValueException`

  
  *   :py:class:`MemoryDB.Client.exceptions.InvalidParameterCombinationException`

  