MemoryDB / Client / describe_engine_versions

describe_engine_versions#

MemoryDB.Client.describe_engine_versions(**kwargs)#

Returns a list of the available engine versions.

See also: AWS API Documentation

Request Syntax

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

  • Engine (string) – The engine version to return. Valid values are either valkey or redis.

  • EngineVersion (string) – The engine version.

  • ParameterGroupFamily (string) – The name of a specific parameter group family to return details for.

  • MaxResults (integer) – 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.

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

  • DefaultOnly (boolean) – If true, specifies that only the default version of the specified engine or engine and major version combination is to be returned.

Return type:

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

        • Engine (string) –

          The version of the Redis OSS or Valkey engine used by the cluster.

        • 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

  • MemoryDB.Client.exceptions.ServiceLinkedRoleNotFoundFault

  • MemoryDB.Client.exceptions.InvalidParameterValueException

  • MemoryDB.Client.exceptions.InvalidParameterCombinationException