Describe Db Engine Versions
rds_describe_db_engine_versions | R Documentation |
Describes the properties of specific versions of DB engines¶
Description¶
Describes the properties of specific versions of DB engines.
Usage¶
rds_describe_db_engine_versions(Engine, EngineVersion,
DBParameterGroupFamily, Filters, MaxRecords, Marker, DefaultOnly,
ListSupportedCharacterSets, ListSupportedTimezones, IncludeAll)
Arguments¶
Engine
The database engine to return version details for.
Valid Values:
aurora-mysql
aurora-postgresql
custom-oracle-ee
custom-oracle-ee-cdb
custom-oracle-se2
custom-oracle-se2-cdb
db2-ae
db2-se
mariadb
mysql
oracle-ee
oracle-ee-cdb
oracle-se2
oracle-se2-cdb
postgres
sqlserver-ee
sqlserver-se
sqlserver-ex
sqlserver-web
EngineVersion
A specific database engine version to return details for.
Example:
5.1.49
DBParameterGroupFamily
The name of a specific DB parameter group family to return details for.
Constraints:
If supplied, must match an existing DB parameter group family.
Filters
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
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.
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
Specifies whether to return only the default version of the specified engine or the engine and major version combination.
ListSupportedCharacterSets
Specifies whether to list the supported character sets for each engine version.
If this parameter is enabled and the requested engine supports the
CharacterSetName
parameter forcreate_db_instance
, 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 enable this parameter, RDS Custom returns no results.
ListSupportedTimezones
Specifies whether to list the supported time zones for each engine version.
If this parameter is enabled and the requested engine supports the
TimeZone
parameter forcreate_db_instance
, 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 enable this parameter, RDS Custom returns no results.
IncludeAll
Specifies whether to also list the engine versions that aren't available. The default is to list only available engine versions.
Value¶
A list with the following syntax:
list(
Marker = "string",
DBEngineVersions = list(
list(
Engine = "string",
EngineVersion = "string",
DBParameterGroupFamily = "string",
DBEngineDescription = "string",
DBEngineVersionDescription = "string",
DefaultCharacterSet = list(
CharacterSetName = "string",
CharacterSetDescription = "string"
),
Image = list(
ImageId = "string",
Status = "string"
),
DBEngineMediaType = "string",
SupportedCharacterSets = list(
list(
CharacterSetName = "string",
CharacterSetDescription = "string"
)
),
SupportedNcharCharacterSets = list(
list(
CharacterSetName = "string",
CharacterSetDescription = "string"
)
),
ValidUpgradeTarget = list(
list(
Engine = "string",
EngineVersion = "string",
Description = "string",
AutoUpgrade = TRUE|FALSE,
IsMajorVersionUpgrade = TRUE|FALSE,
SupportedEngineModes = list(
"string"
),
SupportsParallelQuery = TRUE|FALSE,
SupportsGlobalDatabases = TRUE|FALSE,
SupportsBabelfish = TRUE|FALSE,
SupportsLimitlessDatabase = TRUE|FALSE,
SupportsLocalWriteForwarding = TRUE|FALSE,
SupportsIntegrations = TRUE|FALSE
)
),
SupportedTimezones = list(
list(
TimezoneName = "string"
)
),
ExportableLogTypes = list(
"string"
),
SupportsLogExportsToCloudwatchLogs = TRUE|FALSE,
SupportsReadReplica = TRUE|FALSE,
SupportedEngineModes = list(
"string"
),
SupportedFeatureNames = list(
"string"
),
Status = "string",
SupportsParallelQuery = TRUE|FALSE,
SupportsGlobalDatabases = TRUE|FALSE,
MajorEngineVersion = "string",
DatabaseInstallationFilesS3BucketName = "string",
DatabaseInstallationFilesS3Prefix = "string",
DBEngineVersionArn = "string",
KMSKeyId = "string",
CreateTime = as.POSIXct(
"2015-01-01"
),
TagList = list(
list(
Key = "string",
Value = "string"
)
),
SupportsBabelfish = TRUE|FALSE,
CustomDBEngineVersionManifest = "string",
SupportsLimitlessDatabase = TRUE|FALSE,
SupportsCertificateRotationWithoutRestart = TRUE|FALSE,
SupportedCACertificateIdentifiers = list(
"string"
),
SupportsLocalWriteForwarding = TRUE|FALSE,
SupportsIntegrations = TRUE|FALSE
)
)
)
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,
IncludeAll = TRUE|FALSE
)