Skip to content

Returns a list of the available engines

Description

Returns a list of the available engines.

Usage

docdb_describe_db_engine_versions(Engine, EngineVersion,
  DBParameterGroupFamily, Filters, MaxRecords, Marker, DefaultOnly,
  ListSupportedCharacterSets, ListSupportedTimezones)

Arguments

  • Engine

    The database engine to return.

  • EngineVersion

    The database engine version to return.

    Example: 3.6.0

  • DBParameterGroupFamily

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

    Constraints:

    • If provided, must match an existing DBParameterGroupFamily.

  • Filters

    This parameter is not currently supported.

  • MaxRecords

    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

    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

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

  • ListSupportedCharacterSets

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

  • ListSupportedTimezones

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

Value

A list with the following syntax:

list(
  Marker = "string",
  DBEngineVersions = list(
    list(
      Engine = "string",
      EngineVersion = "string",
      DBParameterGroupFamily = "string",
      DBEngineDescription = "string",
      DBEngineVersionDescription = "string",
      ValidUpgradeTarget = list(
        list(
          Engine = "string",
          EngineVersion = "string",
          Description = "string",
          AutoUpgrade = TRUE|FALSE,
          IsMajorVersionUpgrade = TRUE|FALSE
        )
      ),
      ExportableLogTypes = list(
        "string"
      ),
      SupportsLogExportsToCloudwatchLogs = TRUE|FALSE,
      SupportedCACertificateIdentifiers = list(
        "string"
      ),
      SupportsCertificateRotationWithoutRestart = TRUE|FALSE,
      ServerlessV2FeaturesSupport = list(
        MinCapacity = 123.0,
        MaxCapacity = 123.0
      )
    )
  )
)

Request syntax

svc$describe_db_engine_versions(
  Engine = "string",
  EngineVersion = "string",
  DBParameterGroupFamily = "string",
  Filters = list(
    list(
      Name = "string",
      Values = list(
        "string"
      )
    )
  ),
  MaxRecords = 123,
  Marker = "string",
  DefaultOnly = TRUE|FALSE,
  ListSupportedCharacterSets = TRUE|FALSE,
  ListSupportedTimezones = TRUE|FALSE
)