Returns a list of the available DB engines.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
describe-db-engine-versions
is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate
argument.
When using --output text
and the --query
argument on a paginated response, the --query
argument must extract data from the results of the following query expressions: DBEngineVersions
describe-db-engine-versions
[--engine <value>]
[--engine-version <value>]
[--db-parameter-group-family <value>]
[--filters <value>]
[--default-only | --no-default-only]
[--list-supported-character-sets | --no-list-supported-character-sets]
[--list-supported-timezones | --no-list-supported-timezones]
[--include-all | --no-include-all]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]
--engine
(string)
The database engine to return.
Valid Values:
aurora
(for MySQL 5.6-compatible Aurora)
aurora-mysql
(for MySQL 5.7-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
--engine-version
(string)
The database engine version to return.
Example:
5.1.49
--db-parameter-group-family
(string)
The name of a specific DB parameter group family to return details for.
Constraints:
If supplied, must match an existing DBParameterGroupFamily.
--filters
(list)
This parameter isn’t currently supported.
(structure)
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as IDs. The filters supported by a describe operation are documented with the describe operation.
Note
Currently, wildcards are not supported in filters.
The following actions can be filtered:
DescribeDBClusterBacktracks
DescribeDBClusterEndpoints
DescribeDBClusters
DescribeDBInstances
DescribePendingMaintenanceActions
Name -> (string)
The name of the filter. Filter names are case-sensitive.
Values -> (list)
One or more filter values. Filter values are case-sensitive.
(string)
Shorthand Syntax:
Name=string,Values=string,string ...
JSON Syntax:
[
{
"Name": "string",
"Values": ["string", ...]
}
...
]
--default-only
| --no-default-only
(boolean)
A value that indicates whether only the default version of the specified engine or engine and major version combination is returned.
--list-supported-character-sets
| --no-list-supported-character-sets
(boolean)
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 forCreateDBInstance
, 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
totrue
, RDS Custom returns no results.
--list-supported-timezones
| --no-list-supported-timezones
(boolean)
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 forCreateDBInstance
, 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
totrue
, RDS Custom returns no results.
--include-all
| --no-include-all
(boolean)
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.
--cli-input-json
| --cli-input-yaml
(string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton
. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml
.
--starting-token
(string)
A token to specify where to start paginating. This is the
NextToken
from a previously truncated response.For usage examples, see Pagination in the AWS Command Line Interface User Guide .
--page-size
(integer)
The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.
For usage examples, see Pagination in the AWS Command Line Interface User Guide .
--max-items
(integer)
The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a
NextToken
is provided in the command’s output. To resume pagination, provide theNextToken
value in thestarting-token
argument of a subsequent command. Do not use theNextToken
response element directly outside of the AWS CLI.For usage examples, see Pagination in the AWS Command Line Interface User Guide .
--generate-cli-skeleton
(string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input
, prints a sample input JSON that can be used as an argument for --cli-input-json
. Similarly, if provided yaml-input
it will print a sample input YAML that can be used with --cli-input-yaml
. If provided with the value output
, it validates the command inputs and returns a sample output JSON for that command.
See ‘aws help’ for descriptions of global parameters.
To describe the DB engine versions for the MySQL DB engine
The following describe-db-engine-versions
example displays details about each of the DB engine versions for the specified DB engine.
aws rds describe-db-engine-versions \
--engine mysql
Output:
{
"DBEngineVersions": [
{
"Engine": "mysql",
"EngineVersion": "5.5.46",
"DBParameterGroupFamily": "mysql5.5",
"DBEngineDescription": "MySQL Community Edition",
"DBEngineVersionDescription": "MySQL 5.5.46",
"ValidUpgradeTarget": [
{
"Engine": "mysql",
"EngineVersion": "5.5.53",
"Description": "MySQL 5.5.53",
"AutoUpgrade": false,
"IsMajorVersionUpgrade": false
},
{
"Engine": "mysql",
"EngineVersion": "5.5.54",
"Description": "MySQL 5.5.54",
"AutoUpgrade": false,
"IsMajorVersionUpgrade": false
},
{
"Engine": "mysql",
"EngineVersion": "5.5.57",
"Description": "MySQL 5.5.57",
"AutoUpgrade": false,
"IsMajorVersionUpgrade": false
},
...some output truncated...
]
}
For more information, see What Is Amazon Relational Database Service (Amazon RDS)? in the Amazon RDS User Guide.
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.(structure)
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 -> (structure)
The default character set for new instances of this engine version, if the
CharacterSetName
parameter of the CreateDBInstance API isn’t specified.CharacterSetName -> (string)
The name of the character set.
CharacterSetDescription -> (string)
The description of the character set.
SupportedCharacterSets -> (list)
A list of the character sets supported by this engine for the
CharacterSetName
parameter of theCreateDBInstance
operation.(structure)
This data type is used as a response element in the action
DescribeDBEngineVersions
.CharacterSetName -> (string)
The name of the character set.
CharacterSetDescription -> (string)
The description of the character set.
SupportedNcharCharacterSets -> (list)
A list of the character sets supported by the Oracle DB engine for the
NcharCharacterSetName
parameter of theCreateDBInstance
operation.(structure)
This data type is used as a response element in the action
DescribeDBEngineVersions
.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.
(structure)
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 upgrading to the target version requires upgrading the major version of the database engine.
SupportedEngineModes -> (list)
A list of the supported DB engine modes for the target engine version.
(string)
SupportsParallelQuery -> (boolean)
A value that indicates whether you can use Aurora parallel query with the target engine version.
SupportsGlobalDatabases -> (boolean)
A value that indicates whether you can use Aurora global databases with the target engine version.
SupportedTimezones -> (list)
A list of the time zones supported by this engine for the
Timezone
parameter of theCreateDBInstance
action.(structure)
A time zone associated with a
DBInstance
or aDBSnapshot
. This data type is an element in the response to theDescribeDBInstances
, theDescribeDBSnapshots
, and theDescribeDBEngineVersions
actions.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.
SupportedEngineModes -> (list)
A list of the supported DB engine modes.
(string)
SupportedFeatureNames -> (list)
A list of features supported by the DB engine.
The supported features vary by DB engine and DB engine version.
To determine the supported features for a specific DB engine and DB engine version using the CLI, use the following command:
aws rds describe-db-engine-versions --engine <engine_name> --engine-version <engine_version>
For example, to determine the supported features for RDS for PostgreSQL version 13.3 using the CLI, use the following command:
aws rds describe-db-engine-versions --engine postgres --engine-version 13.3
The supported features are listed under
SupportedFeatureNames
in the output.(string)
Status -> (string)
The status of the DB engine version, either
available
ordeprecated
.SupportsParallelQuery -> (boolean)
A value that indicates whether you can use Aurora parallel query with a specific DB engine version.
SupportsGlobalDatabases -> (boolean)
A value that indicates whether you can use Aurora global databases with a specific DB engine version.
MajorEngineVersion -> (string)
The major engine version of the CEV.
DatabaseInstallationFilesS3BucketName -> (string)
The name of the Amazon S3 bucket that contains your database installation files.
DatabaseInstallationFilesS3Prefix -> (string)
The Amazon S3 directory that contains the database installation files. If not specified, then no prefix is assumed.
DBEngineVersionArn -> (string)
The ARN of the custom engine version.
KMSKeyId -> (string)
The Amazon Web Services KMS key identifier for an encrypted CEV. This parameter is required for RDS Custom, but optional for Amazon RDS.
CreateTime -> (timestamp)
The creation time of the DB engine version.
TagList -> (list)
A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
(structure)
Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
Key -> (string)
A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can’t be prefixed with
aws:
orrds:
. The string can only contain only the set of Unicode letters, digits, white-space, ‘_’, ‘.’, ‘:’, ‘/’, ‘=’, ‘+’, ‘-‘, ‘@’ (Java regex: “^([\p{L}\p{Z}\p{N}_.:/=+-@]*)$”).Value -> (string)
A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can’t be prefixed with
aws:
orrds:
. The string can only contain only the set of Unicode letters, digits, white-space, ‘_’, ‘.’, ‘:’, ‘/’, ‘=’, ‘+’, ‘-‘, ‘@’ (Java regex: “^([\p{L}\p{Z}\p{N}_.:/=+-@]*)$”).