2020/07/20 - Amazon Relational Database Service - 2 updated api methods
Changes Update rds client to latest version
{'DBEngineVersions': {'SupportsGlobalDatabases': 'boolean',
'SupportsParallelQuery': 'boolean'}}
Returns a list of the available DB engines.
See also: AWS API Documentation
Request Syntax
client.describe_db_engine_versions(
Engine='string',
EngineVersion='string',
DBParameterGroupFamily='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxRecords=123,
Marker='string',
DefaultOnly=True|False,
ListSupportedCharacterSets=True|False,
ListSupportedTimezones=True|False,
IncludeAll=True|False
)
string
The database engine to return.
string
The database engine version to return.
Example: 5.1.49
string
The name of a specific DB parameter group family to return details for.
Constraints:
If supplied, must match an existing DBParameterGroupFamily.
list
This parameter isn't currently supported.
(dict) --
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.
The following actions can be filtered:
DescribeDBClusterBacktracks
DescribeDBClusterEndpoints
DescribeDBClusters
DescribeDBInstances
DescribePendingMaintenanceActions
Name (string) -- [REQUIRED]
The name of the filter. Filter names are case-sensitive.
Values (list) -- [REQUIRED]
One or more filter values. Filter values are case-sensitive.
(string) --
integer
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.
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.
boolean
A value that indicates whether only the default version of the specified engine or engine and major version combination is returned.
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 for CreateDBInstance, the response includes a list of supported character sets for each engine version.
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 for CreateDBInstance, the response includes a list of supported time zones for each engine version.
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.
dict
Response Syntax
{
'Marker': 'string',
'DBEngineVersions': [
{
'Engine': 'string',
'EngineVersion': 'string',
'DBParameterGroupFamily': 'string',
'DBEngineDescription': 'string',
'DBEngineVersionDescription': 'string',
'DefaultCharacterSet': {
'CharacterSetName': 'string',
'CharacterSetDescription': 'string'
},
'SupportedCharacterSets': [
{
'CharacterSetName': 'string',
'CharacterSetDescription': 'string'
},
],
'ValidUpgradeTarget': [
{
'Engine': 'string',
'EngineVersion': 'string',
'Description': 'string',
'AutoUpgrade': True|False,
'IsMajorVersionUpgrade': True|False
},
],
'SupportedTimezones': [
{
'TimezoneName': 'string'
},
],
'ExportableLogTypes': [
'string',
],
'SupportsLogExportsToCloudwatchLogs': True|False,
'SupportsReadReplica': True|False,
'SupportedEngineModes': [
'string',
],
'SupportedFeatureNames': [
'string',
],
'Status': 'string',
'SupportsParallelQuery': True|False,
'SupportsGlobalDatabases': True|False
},
]
}
Response Structure
(dict) --
Contains the result of a successful invocation of the DescribeDBEngineVersions action.
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.
(dict) --
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 (dict) --
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 the CreateDBInstance action.
(dict) --
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.
(dict) --
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 a database engine is upgraded to a major version.
SupportedTimezones (list) --
A list of the time zones supported by this engine for the Timezone parameter of the CreateDBInstance action.
(dict) --
A time zone associated with a DBInstance or a DBSnapshot. This data type is an element in the response to the DescribeDBInstances, the DescribeDBSnapshots, and the DescribeDBEngineVersions 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. Supported feature names include the following.
s3Import
(string) --
Status (string) --
The status of the DB engine version, either available or deprecated.
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.
{'OrderableDBInstanceOptions': {'SupportsGlobalDatabases': 'boolean'}}
Returns a list of orderable DB instance options for the specified engine.
See also: AWS API Documentation
Request Syntax
client.describe_orderable_db_instance_options(
Engine='string',
EngineVersion='string',
DBInstanceClass='string',
LicenseModel='string',
AvailabilityZoneGroup='string',
Vpc=True|False,
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxRecords=123,
Marker='string'
)
string
[REQUIRED]
The name of the engine to retrieve DB instance options for.
string
The engine version filter value. Specify this parameter to show only the available offerings matching the specified engine version.
string
The DB instance class filter value. Specify this parameter to show only the available offerings matching the specified DB instance class.
string
The license model filter value. Specify this parameter to show only the available offerings matching the specified license model.
string
The Availability Zone group associated with a Local Zone. Specify this parameter to retrieve available offerings for the Local Zones in the group.
Omit this parameter to show the available offerings in the specified AWS Region.
boolean
A value that indicates whether to show only VPC or non-VPC offerings.
list
This parameter isn't currently supported.
(dict) --
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.
The following actions can be filtered:
DescribeDBClusterBacktracks
DescribeDBClusterEndpoints
DescribeDBClusters
DescribeDBInstances
DescribePendingMaintenanceActions
Name (string) -- [REQUIRED]
The name of the filter. Filter names are case-sensitive.
Values (list) -- [REQUIRED]
One or more filter values. Filter values are case-sensitive.
(string) --
integer
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
string
An optional pagination token provided by a previous DescribeOrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .
dict
Response Syntax
{
'OrderableDBInstanceOptions': [
{
'Engine': 'string',
'EngineVersion': 'string',
'DBInstanceClass': 'string',
'LicenseModel': 'string',
'AvailabilityZoneGroup': 'string',
'AvailabilityZones': [
{
'Name': 'string'
},
],
'MultiAZCapable': True|False,
'ReadReplicaCapable': True|False,
'Vpc': True|False,
'SupportsStorageEncryption': True|False,
'StorageType': 'string',
'SupportsIops': True|False,
'SupportsEnhancedMonitoring': True|False,
'SupportsIAMDatabaseAuthentication': True|False,
'SupportsPerformanceInsights': True|False,
'MinStorageSize': 123,
'MaxStorageSize': 123,
'MinIopsPerDbInstance': 123,
'MaxIopsPerDbInstance': 123,
'MinIopsPerGib': 123.0,
'MaxIopsPerGib': 123.0,
'AvailableProcessorFeatures': [
{
'Name': 'string',
'DefaultValue': 'string',
'AllowedValues': 'string'
},
],
'SupportedEngineModes': [
'string',
],
'SupportsStorageAutoscaling': True|False,
'SupportsKerberosAuthentication': True|False,
'OutpostCapable': True|False,
'SupportsGlobalDatabases': True|False
},
],
'Marker': 'string'
}
Response Structure
(dict) --
Contains the result of a successful invocation of the DescribeOrderableDBInstanceOptions action.
OrderableDBInstanceOptions (list) --
An OrderableDBInstanceOption structure containing information about orderable options for the DB instance.
(dict) --
Contains a list of available options for a DB instance.
This data type is used as a response element in the DescribeOrderableDBInstanceOptions action.
Engine (string) --
The engine type of a DB instance.
EngineVersion (string) --
The engine version of a DB instance.
DBInstanceClass (string) --
The DB instance class for a DB instance.
LicenseModel (string) --
The license model for a DB instance.
AvailabilityZoneGroup (string) --
The Availability Zone group for a DB instance.
AvailabilityZones (list) --
A list of Availability Zones for a DB instance.
(dict) --
Contains Availability Zone information.
This data type is used as an element in the OrderableDBInstanceOption data type.
Name (string) --
The name of the Availability Zone.
MultiAZCapable (boolean) --
Indicates whether a DB instance is Multi-AZ capable.
ReadReplicaCapable (boolean) --
Indicates whether a DB instance can have a read replica.
Vpc (boolean) --
Indicates whether a DB instance is in a VPC.
SupportsStorageEncryption (boolean) --
Indicates whether a DB instance supports encrypted storage.
StorageType (string) --
Indicates the storage type for a DB instance.
SupportsIops (boolean) --
Indicates whether a DB instance supports provisioned IOPS.
SupportsEnhancedMonitoring (boolean) --
Indicates whether a DB instance supports Enhanced Monitoring at intervals from 1 to 60 seconds.
SupportsIAMDatabaseAuthentication (boolean) --
Indicates whether a DB instance supports IAM database authentication.
SupportsPerformanceInsights (boolean) --
True if a DB instance supports Performance Insights, otherwise false.
MinStorageSize (integer) --
Minimum storage size for a DB instance.
MaxStorageSize (integer) --
Maximum storage size for a DB instance.
MinIopsPerDbInstance (integer) --
Minimum total provisioned IOPS for a DB instance.
MaxIopsPerDbInstance (integer) --
Maximum total provisioned IOPS for a DB instance.
MinIopsPerGib (float) --
Minimum provisioned IOPS per GiB for a DB instance.
MaxIopsPerGib (float) --
Maximum provisioned IOPS per GiB for a DB instance.
AvailableProcessorFeatures (list) --
A list of the available processor features for the DB instance class of a DB instance.
(dict) --
Contains the available processor feature information for the DB instance class of a DB instance.
For more information, see Configuring the Processor of the DB Instance Class in the Amazon RDS User Guide.
Name (string) --
The name of the processor feature. Valid names are coreCount and threadsPerCore.
DefaultValue (string) --
The default value for the processor feature of the DB instance class.
AllowedValues (string) --
The allowed values for the processor feature of the DB instance class.
SupportedEngineModes (list) --
A list of the supported DB engine modes.
(string) --
SupportsStorageAutoscaling (boolean) --
Whether Amazon RDS can automatically scale storage for DB instances that use the specified DB instance class.
SupportsKerberosAuthentication (boolean) --
Whether a DB instance supports Kerberos Authentication.
OutpostCapable (boolean) --
Whether a DB instance supports RDS on Outposts.
For more information about RDS on Outposts, see Amazon RDS on AWS Outposts in the Amazon RDS User Guide.
SupportsGlobalDatabases (boolean) --
A value that indicates whether you can use Aurora global databases with a specific combination of other DB engine attributes.
Marker (string) --
An optional pagination token provided by a previous OrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .