Request Parameters Response Elements Errors Examples See Also

DescribeDBEngineVersions

Returns a list of the available DB engines.

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

DBParameterGroupFamily

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

Constraints:

If supplied, must match an existing DBParameterGroupFamily.

Type: String

Required: No

DefaultOnly

A value that indicates whether only the default version of the specified engine or engine and major version combination is returned.

Type: Boolean

Required: No

Engine

The database engine to return.

Valid Values:

aurora (for MySQL 5.6-compatible Aurora)
aurora-mysql (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora)
aurora-postgresql
mariadb
mysql
oracle-ee
oracle-ee-cdb
oracle-se2
oracle-se2-cdb
postgres
sqlserver-ee
sqlserver-se
sqlserver-ex
sqlserver-web

Type: String

Required: No

EngineVersion

The database engine version to return.

Example: 5.1.49

Type: String

Required: No

Filters.Filter.N

A filter that specifies one or more DB engine versions to describe.

Supported filters:

db-parameter-group-family - Accepts parameter groups family names. The results list only includes information about the DB engine versions for these parameter group families.
engine - Accepts engine names. The results list only includes information about the DB engine versions for these engines.
engine-mode - Accepts DB engine modes. The results list only includes information about the DB engine versions for these engine modes. Valid DB engine modes are the following:
- global
- multimaster
- parallelquery
- provisioned
- serverless
engine-version - Accepts engine versions. The results list only includes information about the DB engine versions for these engine versions.
status - Accepts engine version statuses. The results list only includes information about the DB engine versions for these statuses. Valid statuses are the following:
- available
- deprecated

Type: Array of Filter objects

Required: No

IncludeAll

A value that indicates whether to include engine versions that aren't available in the list. The default is to list only available engine versions.

Type: Boolean

Required: No

ListSupportedCharacterSets

A value that indicates whether to list the supported character sets for each engine version.

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

For RDS Custom, the default is not to list supported character sets. If you set ListSupportedCharacterSets to true, RDS Custom returns no results.

Type: Boolean

Required: No

ListSupportedTimezones

A value that indicates whether to list the supported time zones for each engine version.

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

For RDS Custom, the default is not to list supported time zones. If you set ListSupportedTimezones to true, RDS Custom returns no results.

Type: Boolean

Required: No

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: String

Required: No

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 you can retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.

Type: Integer

Required: No

Response Elements

The following elements are returned by the service.

DBEngineVersions.DBEngineVersion.N

A list of DBEngineVersion elements.

Type: Array of DBEngineVersion objects

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: String

Errors

For information about the errors that are common to all actions, see Common Errors.

Examples

Example

This example illustrates one usage of DescribeDBEngineVersions.

Sample Request



https://rds.us-west-2.amazonaws.com/
   ?Action=DescribeDBEngineVersions
   &MaxRecords=100 
   &SignatureMethod=HmacSHA256 
   &SignatureVersion=4
   &Version=2014-10-31
   &X-Amz-Algorithm=AWS4-HMAC-SHA256
   &X-Amz-Credential=AKIADQKE4SARGYLE/20140421/us-west-2/rds/aws4_request
   &X-Amz-Date=20140421T194732Z
   &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date
   &X-Amz-Signature=4772d17a4c43bcd209ff42a0778dd23e73f8434253effd7ac53b89ade3dad45f

Sample Response



<DescribeDBEngineVersionsResponse xmlns="http://rds.amazonaws.com/doc/2014-10-31/">
  <DescribeDBEngineVersionsResult>
    <DBEngineVersions>
      <DBEngineVersion>
        <Engine>mysql</Engine>
        <DBParameterGroupFamily>mysql5.1</DBParameterGroupFamily>
        <DBEngineDescription>MySQL Community Edition</DBEngineDescription>
        <EngineVersion>5.1.57</EngineVersion>
        <DBEngineVersionDescription>MySQL 5.1.57</DBEngineVersionDescription>
      </DBEngineVersion>
      <DBEngineVersion>
        <Engine>mysql</Engine>
        <DBParameterGroupFamily>mysql5.1</DBParameterGroupFamily>
        <DBEngineDescription>MySQL Community Edition</DBEngineDescription>
        <EngineVersion>5.1.61</EngineVersion>
        <DBEngineVersionDescription>MySQL 5.1.61</DBEngineVersionDescription>
      </DBEngineVersion>
      <DBEngineVersion>
        <Engine>mysql</Engine>
        <DBParameterGroupFamily>mysql5.1</DBParameterGroupFamily>
        <DBEngineDescription>MySQL Community Edition</DBEngineDescription>
        <EngineVersion>5.1.62</EngineVersion>
        <DBEngineVersionDescription>MySQL 5.1.62</DBEngineVersionDescription>
      </DBEngineVersion>
  </DescribeDBEngineVersionsResult>
  <ResponseMetadata>
    <RequestId>b74d2635-b98c-11d3-fbc7-5c0aad74da7c</RequestId>
  </ResponseMetadata>
</DescribeDBEngineVersionsResponse>