Amazon Relational Database Service

{'IncludeAll': 'boolean'}

{'DBEngineVersions': {'Status': 'string'}}

Returns a list of the available DB engines.

See also: AWS API Documentation

Request Syntax

client.describe_db_engine_versions(
    Engine='string',
    EngineVersion='string',
    DBParameterGroupFamily='string',
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    MaxRecords=123,
    Marker='string',
    DefaultOnly=True|False,
    ListSupportedCharacterSets=True|False,
    ListSupportedTimezones=True|False,
    IncludeAll=True|False
)

type Engine:

string

param Engine:

The database engine to return.

type EngineVersion:

string

param EngineVersion:

The database engine version to return.

Example: 5.1.49

type DBParameterGroupFamily:

string

param DBParameterGroupFamily:

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

Constraints:

• If supplied, must match an existing DBParameterGroupFamily.

type Filters:

list

param Filters:

This parameter is not currently supported.

• (dict) --

  A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as IDs. The filters supported by a describe operation are documented with the describe operation.

  The following actions can be filtered:

  • DescribeDBClusterBacktracks

  • DescribeDBClusterEndpoints

  • DescribeDBClusters

  • DescribeDBInstances

  • DescribePendingMaintenanceActions

  • Name (string) -- [REQUIRED]

    The name of the filter. Filter names are case-sensitive.

  • Values (list) -- [REQUIRED]

    One or more filter values. Filter values are case-sensitive.

    • (string) --

type MaxRecords:

integer

param MaxRecords:

The maximum number of records to include in the response. If more than the MaxRecords value is available, a pagination token called a marker is included in the response so that the following results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

type Marker:

string

param Marker:

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

type DefaultOnly:

boolean

param DefaultOnly:

Indicates that only the default version of the specified engine or engine and major version combination is returned.

type ListSupportedCharacterSets:

boolean

param ListSupportedCharacterSets:

If this parameter is specified and the requested engine supports the CharacterSetName parameter for CreateDBInstance, the response includes a list of supported character sets for each engine version.

type ListSupportedTimezones:

boolean

param ListSupportedTimezones:

If this parameter is specified and the requested engine supports the TimeZone parameter for CreateDBInstance, the response includes a list of supported time zones for each engine version.

type IncludeAll:

boolean

param IncludeAll:

Whether to include non-available engine versions in the list. The default is to list only available engine versions.

rtype:

dict

returns:

Response Syntax

{
    'Marker': 'string',
    'DBEngineVersions': [
        {
            'Engine': 'string',
            'EngineVersion': 'string',
            'DBParameterGroupFamily': 'string',
            'DBEngineDescription': 'string',
            'DBEngineVersionDescription': 'string',
            'DefaultCharacterSet': {
                'CharacterSetName': 'string',
                'CharacterSetDescription': 'string'
            },
            'SupportedCharacterSets': [
                {
                    'CharacterSetName': 'string',
                    'CharacterSetDescription': 'string'
                },
            ],
            'ValidUpgradeTarget': [
                {
                    'Engine': 'string',
                    'EngineVersion': 'string',
                    'Description': 'string',
                    'AutoUpgrade': True|False,
                    'IsMajorVersionUpgrade': True|False
                },
            ],
            'SupportedTimezones': [
                {
                    'TimezoneName': 'string'
                },
            ],
            'ExportableLogTypes': [
                'string',
            ],
            'SupportsLogExportsToCloudwatchLogs': True|False,
            'SupportsReadReplica': True|False,
            'SupportedEngineModes': [
                'string',
            ],
            'SupportedFeatureNames': [
                'string',
            ],
            'Status': 'string'
        },
    ]
}

Response Structure

• (dict) --

  Contains the result of a successful invocation of the DescribeDBEngineVersions action.

  • Marker (string) --

    An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

  • DBEngineVersions (list) --

    A list of DBEngineVersion elements.

    • (dict) --

      This data type is used as a response element in the action DescribeDBEngineVersions.

      • Engine (string) --

        The name of the database engine.

      • EngineVersion (string) --

        The version number of the database engine.

      • DBParameterGroupFamily (string) --

        The name of the DB parameter group family for the database engine.

      • DBEngineDescription (string) --

        The description of the database engine.

      • DBEngineVersionDescription (string) --

        The description of the database engine version.

      • DefaultCharacterSet (dict) --

        The default character set for new instances of this engine version, if the CharacterSetName parameter of the CreateDBInstance API is not specified.

        • CharacterSetName (string) --

          The name of the character set.

        • CharacterSetDescription (string) --

          The description of the character set.

      • SupportedCharacterSets (list) --

        A list of the character sets supported by this engine for the CharacterSetName parameter of the CreateDBInstance action.

        • (dict) --

          This data type is used as a response element in the action DescribeDBEngineVersions.

          • CharacterSetName (string) --

            The name of the character set.

          • CharacterSetDescription (string) --

            The description of the character set.

      • ValidUpgradeTarget (list) --

        A list of engine versions that this database engine version can be upgraded to.

        • (dict) --

          The version of the database engine that a DB instance can be upgraded to.

          • Engine (string) --

            The name of the upgrade target database engine.

          • EngineVersion (string) --

            The version number of the upgrade target database engine.

          • Description (string) --

            The version of the database engine that a DB instance can be upgraded to.

          • AutoUpgrade (boolean) --

            A value that indicates whether the target version is applied to any source DB instances that have AutoMinorVersionUpgrade set to true.

          • IsMajorVersionUpgrade (boolean) --

            A value that indicates whether a database engine is upgraded to a major version.

      • SupportedTimezones (list) --

        A list of the time zones supported by this engine for the Timezone parameter of the CreateDBInstance action.

        • (dict) --

          A time zone associated with a DBInstance or a DBSnapshot. This data type is an element in the response to the DescribeDBInstances, the DescribeDBSnapshots, and the DescribeDBEngineVersions actions.

          • TimezoneName (string) --

            The name of the time zone.

      • ExportableLogTypes (list) --

        The types of logs that the database engine has available for export to CloudWatch Logs.

        • (string) --

      • SupportsLogExportsToCloudwatchLogs (boolean) --

        A value that indicates whether the engine version supports exporting the log types specified by ExportableLogTypes to CloudWatch Logs.

      • SupportsReadReplica (boolean) --

        Indicates whether the database engine version supports Read Replicas.

      • SupportedEngineModes (list) --

        A list of the supported DB engine modes.

        • (string) --

      • SupportedFeatureNames (list) --

        A list of features supported by the DB engine. Supported feature names include the following.

        • s3Import

        • (string) --

      • Status (string) --

        The status of the DB engine version, either available or deprecated.