Neptune / Client / describe_db_engine_versions

describe_db_engine_versions#

Neptune.Client.describe_db_engine_versions(**kwargs)#

Returns a list of the available DB 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: 5.1.49

  • DBParameterGroupFamily (string) –

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

    Constraints:

    • If supplied, must match an existing DBParameterGroupFamily.

  • Filters (list) –

    Not currently supported.

    • (dict) –

      This type is not currently supported.

      • Name (string) – [REQUIRED]

        This parameter is not currently supported.

      • Values (list) – [REQUIRED]

        This parameter is not currently supported.

        • (string) –

  • MaxRecords (integer) –

    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.

  • 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',
            'DefaultCharacterSet': {
                'CharacterSetName': 'string',
                'CharacterSetDescription': 'string'
            },
            'SupportedCharacterSets': [
                {
                    'CharacterSetName': 'string',
                    'CharacterSetDescription': 'string'
                },
            ],
            'ValidUpgradeTarget': [
                {
                    'Engine': 'string',
                    'EngineVersion': 'string',
                    'Description': 'string',
                    'AutoUpgrade': True|False,
                    'IsMajorVersionUpgrade': True|False,
                    'SupportsGlobalDatabases': True|False
                },
            ],
            'SupportedTimezones': [
                {
                    'TimezoneName': 'string'
                },
            ],
            'ExportableLogTypes': [
                'string',
            ],
            'SupportsLogExportsToCloudwatchLogs': True|False,
            'SupportsReadReplica': True|False,
            'SupportsGlobalDatabases': True|False
        },
    ]
}

Response Structure

  • (dict) –

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

          (Not supported by Neptune)

          • CharacterSetName (string) –

            The name of the character set.

          • CharacterSetDescription (string) –

            The description of the character set.

        • SupportedCharacterSets (list) –

          (Not supported by Neptune)

          • (dict) –

            Specifies a character set.

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

            • SupportsGlobalDatabases (boolean) –

              A value that indicates whether you can use Neptune global databases with the target engine 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.

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

        • SupportsGlobalDatabases (boolean) –

          A value that indicates whether you can use Aurora global databases with a specific DB engine version.