DescribeDBEngineVersions - Amazon DocumentDB
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

DescribeDBEngineVersions

Returns a list of the available engines.

Request Parameters

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

DBParameterGroupFamily

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

Constraints:

  • If provided, must match an existing DBParameterGroupFamily.

Type: String

Required: No

DefaultOnly

Indicates that 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.

Type: String

Required: No

EngineVersion

The database engine version to return.

Example: 3.6.0

Type: String

Required: No

Filters.Filter.N

This parameter is not currently supported.

Type: Array of Filter objects

Required: No

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

Required: No

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

Type: Integer

Required: No

Response Elements

The following elements are returned by the service.

DBEngineVersions.DBEngineVersion.N

Detailed information about one or more engine versions.

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.

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: