DocDB / Client / describe_db_engine_versions

describe_db_engine_versions

DocDB.Client.describe_db_engine_versions(**kwargs)

Returns a list of the available engines.

See also: AWS API Documentation

Request Syntax

response = 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
)

Parameters:

• Engine (string) – The database engine to return.

• EngineVersion (string) –

  The database engine version to return.

  Example: 3.6.0

• DBParameterGroupFamily (string) –

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

  Constraints:

  • If provided, must match an existing DBParameterGroupFamily.

• Filters (list) –

  This parameter is not currently supported.

  • (dict) –

    A named set of filter values, used to return a more specific list of results. You can use a filter to match a set of resources by specific criteria, such as IDs.

    Wildcards are not supported in filters.

    • 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) –

• MaxRecords (integer) –

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

  Default: 100

  Constraints: Minimum 20, maximum 100.

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

• DefaultOnly (boolean) – Indicates that only the default version of the specified engine or engine and major version combination is returned.

• ListSupportedCharacterSets (boolean) – 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.

• ListSupportedTimezones (boolean) – 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.

Return type:

dict

Returns:

Response Syntax

{
    'Marker': 'string',
    'DBEngineVersions': [
        {
            'Engine': 'string',
            'EngineVersion': 'string',
            'DBParameterGroupFamily': 'string',
            'DBEngineDescription': 'string',
            'DBEngineVersionDescription': 'string',
            'ValidUpgradeTarget': [
                {
                    'Engine': 'string',
                    'EngineVersion': 'string',
                    'Description': 'string',
                    'AutoUpgrade': True|False,
                    'IsMajorVersionUpgrade': True|False
                },
            ],
            'ExportableLogTypes': [
                'string',
            ],
            'SupportsLogExportsToCloudwatchLogs': True|False,
            'SupportedCACertificateIdentifiers': [
                'string',
            ],
            'SupportsCertificateRotationWithoutRestart': True|False
        },
    ]
}

Response Structure

• (dict) –

  Represents the output of DescribeDBEngineVersions.

  • 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) –

    Detailed information about one or more engine versions.

    • (dict) –

      Detailed information about an engine version.

      • Engine (string) –

        The name of the database engine.

      • EngineVersion (string) –

        The version number of the database engine.

      • DBParameterGroupFamily (string) –

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

      • DBEngineDescription (string) –

        The description of the database engine.

      • DBEngineVersionDescription (string) –

        The description of the database engine version.

      • ValidUpgradeTarget (list) –

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

        • (dict) –

          The version of the database engine that an 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 an 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.

      • ExportableLogTypes (list) –

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

        • (string) –

      • SupportsLogExportsToCloudwatchLogs (boolean) –

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

      • SupportedCACertificateIdentifiers (list) –

        A list of the supported CA certificate identifiers.

        For more information, see Updating Your Amazon DocumentDB TLS Certificates and Encrypting Data in Transit in the Amazon DocumentDB Developer Guide.

        • (string) –

      • SupportsCertificateRotationWithoutRestart (boolean) –

        Indicates whether the engine version supports rotating the server certificate without rebooting the DB instance.